Simple Log Service:Panduan cepat SDK Flutter

Catatan rilis

SLS Flutter SDK dipublikasikan di repositori paket Dart resmi. Untuk informasi selengkapnya, lihat Aliyun Log Flutter Release.

Kode contoh

Untuk contoh lengkap yang berfungsi, lihat Aliyun Log Flutter SDK Example.

Prasyarat

• Instal lingkungan pengembangan Flutter.

• SLS Flutter SDK mendukung Android 4.0 atau versi lebih baru serta iOS 10.0 atau versi lebih baru.

  • Untuk build iOS, Anda harus menambahkan baris berikut ke Podfile Anda:

    source 'https://github.com/CocoaPods/Specs.git'
    source 'https://github.com/aliyun-sls/Specs.git'
    # Jika Anda menggunakan repositori di wilayah Tiongkok Daratan, Anda juga harus menambahkan baris ini.
    source 'https://gitee.com/aliyun-sls/Specs.git'

Prosedur

Langkah 1: Instal SDK

1. Buat proyek Flutter.

2. Tambahkan modul SLS Flutter SDK. Dari direktori root proyek Anda, jalankan perintah berikut:

   flutter pub add aliyun_log_dart_sdk

   Setelah proses selesai, informasi berikut secara otomatis ditambahkan ke file pubspec.yaml proyek, dan perintah flutter pub get dijalankan secara implisit.

   dependencies:
    aliyun_log_dart_sdk: ^1.0.0 // Untuk informasi versi lainnya, lihat ikhtisar SDK Flutter.

3. Impor paket tersebut di file Dart Anda.

   import 'package:aliyun_log_dart_sdk/aliyun_log_dart_sdk.dart';

Langkah 2: Inisialisasi SDK

Kode berikut menunjukkan inisialisasi dasar. Untuk opsi konfigurasi lanjutan seperti ukuran paket log dan resumable upload, lihat Parameter konfigurasi.

import 'package:aliyun_log_dart_sdk/aliyun_log_dart_sdk.dart';

AliyunLogDartSdk? _aliyunLogSdk;

void _initProducer() async {
  // Tetapkan endpoint, nama project, dan nama Logstore.
    LogProducerConfiguration configuration = LogProducerConfiguration(
      endpoint: 'your endpoint', project: 'your project', logstore: 'your logstore'
    ); 
  // AccessKey Alibaba Cloud. Menggunakan pasangan AccessKey berisiko karena memberikan akses penuh ke resource Anda. Kami sangat menyarankan untuk menggunakan RAM User dalam pemanggilan API.
    configuration.accessKeyId = 'your access key id';
    configuration.accessKeySecret = 'your access key secret';
    configuration.securityToken = 'your access key token'; // Hanya diperlukan saat menggunakan AccessKey temporary dari Security Token Service (STS).
    _aliyunLogSdk = AliyunLogDartSdk();
    LogProducerResult result = await _aliyunLogSdk!.initProducer(configuration);
}

Langkah 3: Kirim log

Panggil 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 content'
});

Log berhasil dikirim hanya jika code == LogProducerResult.ok. Jika tidak, kode kesalahan akan dikembalikan. Untuk informasi selengkapnya, lihat Kode kesalahan.

Langkah 4: Konfigurasi aturan obfuscation (Android)

Jika proyek Flutter Anda memiliki aturan obfuscation yang diaktifkan (aturan ini diaktifkan secara default pada Flutter v1.16.2 dan versi lebih baru), Anda juga perlu menambahkan aturan berikut ke file konfigurasi obfuscation proyek Anda. Jika tidak, proyek Android mungkin tidak berjalan dengan benar. Proyek iOS tidak terpengaruh oleh aturan ini.

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

Konfigurasi dinamis

Parameter berikut dapat diperbarui saat runtime: Endpoint, Project, Logstore, dan AccessKey.

• Perbarui Endpoint, Project, dan Logstore.

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

• Perbarui AccessKey.

  // securityToken bersifat opsional. Hanya diperlukan saat AccessKey diperoleh melalui Security Token Service (STS).
  await _aliyunLogSdk!.setAccessKey('your accesskey id', 'your accesskey secret', securityToken: 'your accesskey token');

• Perbarui parameter source, topic, dan tag.

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

• Perbarui parameter lainnya.

  Penting

  AliyunLogDartSdk.updateConfiguration() tidak mendukung pembaruan parameter resumable upload saat runtime.

  LogProducerConfiguration configuration = LogProducerConfiguration();
  configuration.dropDelayLog = true;
  configuration.dropUnauthorizedLog = true;
  // Parameter lain dari kelas LogProducerConfiguration juga dapat diatur dengan cara ini.
  await _aliyunLogSdk!.updateConfiguration(configuration);

Tetapkan callback log

Tetapkan callback untuk operasi pengiriman log. Callback ini dipicu baik saat sukses maupun gagal, memungkinkan pemantauan status SDK dan pembaruan konfigurasi.

_aliyunLogSdk!.setLogCallback((resultCode, errorMessage, logBytes, compressedBytes) {
	// Parameter tidak valid. Anda perlu memperbarui konfigurasi.
	if (LogProducerResult.parametersInvalid == resultCode) {
	// Misalnya, perbarui Endpoint.
	_aliyunLogSdk!.setEndpoint('your endpoint');
	// AccessKey yang hilang atau salah juga memicu parametersInvalid.
	_aliyunLogSdk!.setAccessKey('your access key id', 'your access key secret', securityToken: 'your token');
}

 	// Otorisasi telah kedaluwarsa. Anda perlu memperbarui AccessKey.
	if (LogProducerResult.sendUnauthorized == resultCode) {
		_aliyunLogSdk!.setAccessKey('your access key id', 'your access key secret', securityToken: 'your token');
	}
});

Mengaktifkan unggah yang dapat dilanjutkan

Konfigurasikan resumable upload selama inisialisasi:

configuration.persistent = true; // Aktifkan resumable upload.
configuration.persistentFilePath = 'flutter/demo'; // Direktori untuk menyimpan cache binlog.
configuration.persistentForceFlush = false; // Nonaktifkan force flush. Biarkan dinonaktifkan karena mengaktifkannya dapat memengaruhi performa.
configuration.persistentMaxFileCount = 10; // Jumlah maksimum file cache. Default: 10.
configuration.persistentMaxFileSize = 1024 * 1024; // Ukuran maksimum satu file cache, dalam byte. Default: 1024 * 1024.
configuration.persistentMaxLogCount = 64 * 1024; // Jumlah maksimum log yang dicache. Default: 64 * 1024.
_aliyunLogSdk = AliyunLogDartSdk();
LogProducerResult result = await _aliyunLogSdk!.initProducer(configuration);

Parameter

Parameter yang didukung oleh kelas LogProducerConfiguration tercantum dalam tabel berikut.

Kode kesalahan