ApsaraVideo VOD:Sistem Logging

Apa itu LogHub?

LogHub adalah titik masuk terpadu untuk seluruh output log dalam framework PlayerKit. Ini merupakan kelas utilitas statis yang menyediakan fungsionalitas logging yang konsisten.

LogHub membungkus API Log native Android, mempertahankan semua kemampuan aslinya sekaligus menambahkan fitur inti berikut:

Apa itu log listener?

LogHubListener adalah antarmuka callback yang menerima log dari LogHub. Implementasikan antarmuka ini untuk menyesuaikan cara penanganan log, misalnya:

• Menulis log ke file untuk dibagikan kepada dukungan teknis saat troubleshooting.

• Mengunggah log ke server jarak jauh untuk pengumpulan terpusat.

• Menampilkan log di UI untuk panel debugging.

Masalah yang diselesaikan

• Log tersebar di seluruh basis kode, sehingga sulit dikelola dan difilter.

• Build rilis perlu menonaktifkan log debug, tetapi tidak tersedia toggle terpadu.

• Tidak ada dukungan log file bawaan untuk troubleshooting.

• Log SDK player dan log bisnis terpisah, sehingga analisis asosiasi menjadi sulit.

Nilai inti

Keunggulan arsitektural:

• Unified entry: Semua log mengalir melalui LogHub, menyederhanakan manajemen dan kontrol.

• Flexible control: Mendukung tiga lapisan kontrol: toggle global, toggle konsol, dan filter level.

• Extensible: Mekanisme pendengar mendukung penanganan log kustom, seperti penulisan ke file dan pelaporan jarak jauh.

• Thread safe: Daftar pendengar menggunakan CopyOnWriteArrayList untuk akses konkuren yang aman.

Kemampuan inti

Level log

Kelas inti

Strategi 1: Direct log output

Anda dapat memanggil metode statis LogHub secara langsung:

// Output log INFO
LogHub.i(this, "playVideo", "Mulai memutar video");

// Output log WARN
LogHub.w(this, "onBuffering", "Buffering. Progres saat ini: ", progress);

// Output log ERROR
LogHub.e(this, "onError", "Pemutaran gagal. Kode error: ", errorCode);

// Output log ERROR dengan exception
LogHub.e(this, "onException", throwable, "Terjadi exception");

// Output log timing performa
LogHub.t("loadVideoSource", costTime);

Format log:

[Nama kelas] Nama metode: Pesan

Saran filter Logcat:

package:mine tag:AliPlayerKit

Strategi 2: Configure log level

Anda dapat mengatur level log berbeda berdasarkan lingkungan runtime:

// Lingkungan pengembangan: Output semua log
if (BuildConfig.DEBUG) {
    LogHub.setEnableLog(true);
    LogHub.setEnableConsoleLog(true);
    LogHub.setLogLevel(LogLevel.VERBOSE);
}

// Lingkungan produksi: Hanya output INFO dan di atasnya
else {
    LogHub.setEnableLog(true);
    LogHub.setEnableConsoleLog(false);  // Nonaktifkan output konsol
    LogHub.setLogLevel(LogLevel.INFO);
}

// Nonaktifkan semua log (untuk skenario sensitif)
LogHub.setEnableLog(false);

Strategi 3: Register a listener

Anda dapat menyesuaikan penanganan log menggunakan pendengar:

// Buat pendengar
LogHubListener listener = logInfo -> {
    // Proses log
    String formattedLog = logInfo.getFormattedMessage();
    // Tulis ke file, unggah ke server, dll.
    saveToFile(formattedLog);
};

// Daftarkan pendengar
LogHub.addListener(listener);

// Hapus pendengar jika tidak lagi diperlukan
LogHub.removeListener(listener);   

Bagaimana cara mengimplementasikan persistensi log?

Implementasikan logging berbasis file menggunakan antarmuka LogHubListener untuk membantu troubleshooting.

1. Buat pendengar log.

   public class FileLogListener implements LogHubListener {
   
       private final ExecutorService mExecutor = Executors.newSingleThreadExecutor();
       private final File mLogFile;
   
       public FileLogListener(Context context) {
           // Jalur file log
           File logDir = new File(context.getExternalFilesDir(null), "logs");
           if (!logDir.exists()) {
               logDir.mkdirs();
           }
           mLogFile = new File(logDir, "player_" + getDateStr() + ".log");
       }
   
       @Overridepublic void onLog(@NonNull LogInfo logInfo) {
           // Tulis ke file secara asinkron untuk menghindari pemblokiran thread pemanggil
           mExecutor.execute(() -> {
               try {
                   String log = logInfo.getFormattedMessage() + "\n";
                   FileOutputStream fos = new FileOutputStream(mLogFile, true);
                   fos.write(log.getBytes(StandardCharsets.UTF_8));
                   fos.close();
               } catch (IOException e) {
                   // Abaikan exception penulisan
               }
           });
       }
   }

2. Daftarkan di kelas Application Anda.

   public class MyApplication extends Application {
   
       private FileLogListener mFileLogListener;
   
       @Overridepublic void onCreate() {
           super.onCreate();
   
           // Buat dan daftarkan pendengar log file
           mFileLogListener = new FileLogListener(this);
           LogHub.addListener(mFileLogListener);
       }
   }

3. Ambil file log.

   // Jalur file log
   File logDir = new File(getExternalFilesDir(null), "logs");
   File[] logFiles = logDir.listFiles();
   
   // Bagikan kepada dukungan teknis untuk analisis

Referensi contoh: playerkit-examples/example-log-system/FileLogListener.java.

Bagaimana cara mengintegrasikan log SDK player?

Gunakan antarmuka IPlayerLogger untuk mengelola log SDK player secara terpadu.

1. Buat instans logger player.

   // Inisialisasi di Application
   IPlayerLogger playerLogger = new DefaultPlayerLogger(context);
   
   // Aktifkan log konsol SDK (aktifkan hanya untuk debugging)
   playerLogger.enableConsoleLog(BuildConfig.DEBUG);
   
   // Atur level log SDK
   playerLogger.setLogLevel(LogLevel.INFO);

2. Atur callback log SDK.

   playerLogger.setLogCallback((level, message) -> {
       // Tangani log SDK, seperti menulis ke file atau melaporkan jarak jauh
       LogHub.log(level, "PlayerSDK", message);
   });

Bagaimana cara menampilkan log di UI?

Anda dapat menggunakan pendengar untuk menampilkan log secara real-time di layar.

public class LogPanelActivity extends AppCompatActivity {

    private TextView mTvLogOutput;
    private LogHubListener mLogListener;

    @Overrideprotected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_log_panel);

        mTvLogOutput = findViewById(R.id.tv_log_output);

        // Buat pendengar log UI
        mLogListener = logInfo -> runOnUiThread(() -> {
            mTvLogOutput.append(logInfo.getFormattedMessage() + "\n");
        });

        // Daftarkan pendengar
        LogHub.addListener(mLogListener);
    }

    @Overrideprotected void onDestroy() {
        super.onDestroy();
        // Hapus pendengar untuk mencegah memory leak
        LogHub.removeListener(mLogListener);
    }
}

Pemilihan level log

Konfigurasi lingkungan produksi

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();

        if (BuildConfig.DEBUG) {
            // Pengembangan: Log detail + output konsol
            LogHub.setEnableLog(true);
            LogHub.setEnableConsoleLog(true);
            LogHub.setLogLevel(LogLevel.VERBOSE);
        } else {
            // Produksi: Log minimal + tanpa konsol + persistensi file
            LogHub.setEnableLog(true);
            LogHub.setEnableConsoleLog(false);  // Nonaktifkan output Logcat
            LogHub.setLogLevel(LogLevel.INFO);   // Pertahankan hanya INFO dan di atasnya
            LogHub.addListener(new FileLogListener(this));
        }
    }
}  

Catatan

Fitur contoh

Menjalankan Contoh

Di Aplikasi Demo, pilih contoh Log System untuk melihat hasilnya.

Antarmuka inti

Metode utama LogHub

Metode utama LogInfo

Long-log segmentation

Logcat membatasi setiap baris log hingga sekitar 4000 karakter. LogHub menangani log panjang dengan membaginya:

private static final int BUFFER_SIZE = 3000;

// Bagi dan output ke Logcatwhile (startIndex < length) {
    int endIndex = Math.min(length, startIndex + BUFFER_SIZE);
    String sub = s.substring(startIndex, endIndex);
    // Output log tersegmentasi...
    startIndex = endIndex;
}

Optimasi: Kirim log lengkap ke pendengar. Hanya segmentasi untuk output Logcat.

Thread safety

Daftar pendengar menggunakan CopyOnWriteArrayList untuk memastikan keamanan thread:

private static final List<LogHubListener> sListeners = new CopyOnWriteArrayList<>();

Karakteristik:

• Operasi baca tidak memerlukan lock. Performa tinggi.

• Operasi tulis menyalin array baru. Pembacaan yang sedang berlangsung tidak terpengaruh.

• Ideal untuk pendaftaran dan penghapusan pendengar, di mana operasi baca jauh lebih sering daripada tulis.

Bagaimana cara memfilter log PlayerKit di Logcat?

Gunakan filter ini:

package:mine tag:AliPlayerKit

Atau filter berdasarkan level:

package:mine tag:AliPlayerKit level:info       

Di mana file log lingkungan produksi disimpan?

Jalur default (jika menggunakan contoh FileLogListener):

/sdcard/Android/data/[nama paket]/files/logs/

Thread mana yang menjalankan callback pendengar?

Callback pendengar dijalankan pada thread yang sama dengan tempat log di-output. Untuk memproses log di thread UI, gunakan runOnUiThread() untuk mengganti thread.

Kesalahan umum

Berikut adalah masalah paling sering dilaporkan pelanggan. Hindari hal-hal ini:

@Overridepublic void onLog(@NonNull LogInfo logInfo) {
    // Penulisan file sinkron di main thread memblokir UItry {
        FileOutputStream fos = new FileOutputStream(mLogFile, true);
        fos.write(logInfo.getFormattedMessage().getBytes());
        fos.close();
    } catch (IOException e) {
        e.printStackTrace();
    }
}

private final ExecutorService mExecutor = Executors.newSingleThreadExecutor();

@Overridepublic void onLog(@NonNull LogInfo logInfo) {
    // Tulis ke file secara asinkron
    mExecutor.execute(() -> {
        try {
            // Logika penulisan file...
        } catch (IOException e) {
            // Abaikan
        }
    });
}

@Overrideprotected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    // Mendaftarkan pendengar tetapi tidak pernah menghapusnya
    LogHub.addListener(logInfo -> {
        mTvLogOutput.append(logInfo.getMessage());
    });
}

private LogHubListener mLogListener;

@Overrideprotected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    mLogListener = logInfo -> runOnUiThread(() -> {
        mTvLogOutput.append(logInfo.getMessage());
    });
    LogHub.addListener(mLogListener);
}

@Overrideprotected void onDestroy() {
    super.onDestroy();
    // Hapus pendengar segeraif (mLogListener != null) {
        LogHub.removeListener(mLogListener);
    }
}

@Overridepublic void onLog(@NonNull LogInfo logInfo) {
    // Exception tidak ditangani. Jika dilempar di sini, akan memengaruhi pendengar lain
    String data = logInfo.getMessage();
    int result = 1 / 0;  // Melempar exception
}

@Overridepublic void onLog(@NonNull LogInfo logInfo) {
    try {
        // Tangani exception di dalam pendengar
        processLog(logInfo);
    } catch (Exception e) {
        // Tangani exception spesifik pendengar tanpa memengaruhi sistem logging
        android.util.Log.e("FileLogListener", "Error processing log", e);
    }
}

Bagaimana cara melakukan debugging?

1. Periksa status toggle log:

   boolean enabled = LogHub.isLogEnabled();
   boolean consoleEnabled = LogHub.isConsoleLogEnabled();
   int level = LogHub.getLogLevel();

2. Lihat output Logcat:

   Filter log menggunakan tag:AliPlayerKit.

3. Periksa jumlah pendengar:

   Anda dapat memeriksa jumlah pendengar yang terdaftar menggunakan refleksi (hanya untuk debugging). Verifikasi bahwa pendengar didaftarkan dan dihapus dengan benar.