Simple Log Service：Memulai SDK Simple Log Service untuk Flutter

Prasyarat

SDK Simple Log Service untuk Flutter telah diinstal. Untuk informasi selengkapnya, lihat Instal SDK Simple Log Service untuk Flutter.

Inisialisasi SDK

Pada skenario umum, Anda dapat menginisialisasi SDK dengan kode berikut. Jika ingin menentukan ukuran setiap paket log yang dikirim ke Simple Log Service dan mengaktifkan fitur unggah yang dapat dilanjutkan (resumable upload), konfigurasikan kelas LogProducerConfiguration. Untuk informasi selengkapnya, lihat Konfigurasikan parameter dalam kelas LogProducerConfiguration.

import 'package:aliyun_log_dart_sdk/aliyun_log_dart_sdk.dart';

AliyunLogDartSdk? _aliyunLogSdk;

void _initProducer() async {
  // Tentukan endpoint Simple Log Service, nama project, dan nama Logstore. Anda dapat mengonfigurasi parameter ini secara dinamis.
    LogProducerConfiguration configuration = LogProducerConfiguration(
      endpoint: 'your endpoint', project: 'your project', logstore: 'your logstore'
    );
  // Pasangan AccessKey yang digunakan untuk mengakses Simple Log Service. Untuk informasi selengkapnya, lihat Pasangan AccessKey. Pasangan AccessKey milik Akun Alibaba Cloud memiliki izin atas semua operasi API. Menggunakan kredensial ini untuk melakukan operasi di Simple Log Service merupakan operasi berisiko tinggi. Kami menyarankan agar Anda menggunakan Pengguna RAM untuk memanggil operasi API atau melakukan O&M rutin. Untuk membuat Pengguna RAM, login ke Konsol RAM.
    configuration.accessKeyId = 'your access key id';
    configuration.accessKeySecret = 'your access key secret';
    configuration.securityToken = 'your access key token'; // Tentukan token Security Token Service (STS). Parameter ini hanya diperlukan jika Anda menggunakan STS untuk mendapatkan pasangan AccessKey temporary.
    _aliyunLogSdk = AliyunLogDartSdk();
    LogProducerResult result = await _aliyunLogSdk!.initProducer(configuration);
}

Untuk informasi lebih lanjut tentang cara memperoleh informasi yang diperlukan untuk inisialisasi SDK, lihat topik berikut:

• Endpoints

• Pasangan AccessKey

Kirim log

Anda dapat menggunakan metode addLog untuk mengirim log bisnis kustom.

LogProducerResult code = await _aliyunLogSdk!.addLog({
 'str': 'str value',
 'int': 12,
 'double': 12.12,
 'boolean': true,
 'map': {'key': 'value', 'inntt': 3333},
 'array': ['a1', 'a2'],
 'null': null,
 'content': 'Chinese'
});

Jika code == LogProducerResult.ok dikembalikan, berarti log berhasil dikirim. Jika kode kesalahan dikembalikan, lakukan pemecahan masalah sesuai petunjuk pada bagian Kode kesalahan dalam topik ini.

Aturan obfuscation

Jika obfuscation diaktifkan untuk proyek Flutter Anda, tambahkan aturan berikut ke file konfigurasi obfuscation proyek tersebut. Jika tidak, proyek Android mungkin tidak berjalan sebagaimana mestinya. Secara default, obfuscation diaktifkan untuk Flutter versi 1.16.2 dan yang lebih baru. Proyek iOS tidak terpengaruh oleh aturan ini.

-keep class com.aliyun.sls.android.producer.* { *; }
-keep interface com.aliyun.sls.android.producer.* { *; }

Konfigurasi parameter dinamis

SDK Simple Log Service untuk Flutter mendukung konfigurasi dinamis untuk parameter seperti Endpoint, Project, Logstore, dan AccessKey.

• Kode contoh untuk mengonfigurasi parameter Endpoint, Project, dan Logstore secara dinamis:

  await _aliyunLogSdk!.setEndpoint('new-endpoint');
  await _aliyunLogSdk!.setProject('new-project-name');
  await _aliyunLogSdk!.setLogstore('new-logstore-name');

• Kode contoh untuk mengonfigurasi parameter AccessKey secara dinamis:

  // Parameter SecurityToken bersifat opsional. Parameter ini hanya diperlukan jika Anda menggunakan STS untuk mendapatkan pasangan AccessKey temporary.
  await _aliyunLogSdk!.setAccessKey('your accesskey id', 'your accesskey secret', securityToken: 'your accesskey token');

• Kode contoh untuk mengonfigurasi parameter Source, Topic, dan Tag secara dinamis:

  await _aliyunLogSdk!.setSource('flutter');
  await _aliyunLogSdk!.setTopic('flutter-test');
  await _aliyunLogSdk!.addTag('tag1', 'value1');
  await _aliyunLogSdk!.addTag('tag2', 'value2');

• Kode contoh untuk mengonfigurasi parameter lainnya secara dinamis:

  Penting

  Metode AliyunLogDartSdk.updateConfiguration() tidak mendukung konfigurasi dinamis untuk parameter yang terkait dengan unggah yang dapat dilanjutkan (resumable upload).

  LogProducerConfiguration configuration = LogProducerConfiguration();
  configuration.dropDelayLog = true;
  configuration.dropUnauthorizedLog = true;
  // Anda dapat mengonfigurasi parameter dalam kelas LogProducerConfiguration secara dinamis dengan cara yang sama.
  await _aliyunLogSdk!.updateConfiguration(configuration);

Konfigurasi callback untuk pengiriman log

SDK Simple Log Service untuk Flutter mendukung callback saat log dikirim atau gagal dikirim. Informasi callback akan dihasilkan sehingga Anda dapat memantau status SDK atau memperbarui pengaturan parameternya.

_aliyunLogSdk!.setLogCallback((resultCode, errorMessage, logBytes, compressedBytes) {
	// Terjadi kesalahan parameter. Anda perlu memperbarui pengaturan parameter.
	if (LogProducerResult.parametersInvalid == resultCode) {
	// Misalnya, Anda dapat mengubah parameter Endpoint.
	_aliyunLogSdk!.setEndpoint('your endpoint');
	// Kesalahan parametersInvalid terjadi karena pasangan AccessKey tidak ditentukan atau tidak valid.
	_aliyunLogSdk!.setAccessKey('your access key id', 'your access key secret', securityToken: 'your token');
}

 	// Terjadi kesalahan timeout otorisasi. Anda perlu memperbarui pasangan AccessKey Anda.
	if (LogProducerResult.sendUnauthorized == resultCode) {
		_aliyunLogSdk!.setAccessKey('your access key id', 'your access key secret', securityToken: 'your token');
	}
});

Aktifkan unggah yang dapat dilanjutkan (resumable upload)

Kode contoh untuk mengaktifkan unggah yang dapat dilanjutkan saat AliyunLogDartSdk diinisialisasi:

configuration.persistent = true; // Aktifkan unggah yang dapat dilanjutkan.
configuration.persistentFilePath = 'flutter/demo'; // Jalur cache untuk log biner.
configuration.persistentForceFlush = false; // Nonaktifkan refresh paksa. Kami menyarankan agar Anda menonaktifkan refresh paksa karena dapat menurunkan performa sistem.
configuration.persistentMaxFileCount = 10; // Jumlah maksimum file yang dapat di-cache. Nilai default: 10.
configuration.persistentMaxFileSize = 1024 * 1024; // Ukuran maksimum setiap file yang di-cache. Nilai default: 1024 * 1024.
configuration.persistentMaxLogCount=64 * 1024; // Jumlah maksimum log yang dapat di-cache. Nilai default: 64 * 1024.
_aliyunLogSdk = AliyunLogDartSdk();
LogProducerResult result = await _aliyunLogSdk!.initProducer(configuration);

Konfigurasi parameter dalam kelas LogProducerConfiguration

Tabel berikut menjelaskan parameter yang dapat dikonfigurasi dalam kelas LogProducerConfiguration.

Kode kesalahan