Simple Log Service:Flutter用のSimple Log Service SDKの使用を開始する

前提条件

Flutter用のSimple Log Service SDKがインストールされています。 詳細については、「Flutter用Simple Log Service SDKのインストール」をご参照ください。

SDKの初期化

一般的なシナリオでは、次のコードに基づいてSDKを初期化できます。 Simple log Serviceに送信する必要がある各ログパケットのサイズを指定し、再開可能なアップロード機能を有効にする場合は、LogProducerConfigurationクラスを設定できます。 詳細については、「LogProducerConfigurationクラスのパラメーターの設定」をご参照ください。

import 'package:aliyun_log_dart_sdk/aliyun_log_dart_sdk.dart';

AliyunLogDartSdk? _aliyunLogSdk;

void _initProducer() async {
  // Specify the Simple Log Service endpoint, project name, and Logstore name. You can dynamically configure the parameters. 
    LogProducerConfiguration configuration = LogProducerConfiguration(
      endpoint: 'your endpoint', project: 'your project', logstore: 'your logstore'
    ); 
  // The AccessKey pair that is used to access Simple Log Service. For more information, see AccessKey pair. The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. 
    configuration.accessKeyId = 'your access key id';
    configuration.accessKeySecret = 'your access key secret';
    configuration.securityToken = 'your access key token'; // Specify the Security Token Service (STS) token. This parameter is required only if you use STS to obtain a temporary AccessKey pair. 
    _aliyunLogSdk = AliyunLogDartSdk();
    LogProducerResult result = await _aliyunLogSdk!.initProducer(configuration);
}

SDKの初期化に必要な情報を取得する方法の詳細については、以下のトピックを参照してください。

• エンドポイント

• AccessKeyペア

レポートログ

addLogメソッドを使用して、カスタムビジネスログをレポートできます。

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

code == LogProducerResult.okが返された場合、ログが報告されます。 エラーコードが返された場合は、このトピックの [エラーコード] セクションに記載されている手順に従ってエラーをトラブルシューティングできます。

難読化ルール

Flutterプロジェクトで難読化が有効になっている場合は、次のルールをflutterプロジェクトの難読化構成ファイルに追加する必要があります。 そうしないと、Androidプロジェクトが期待どおりに実行されない場合があります。 デフォルトでは、Flutter V1.16.2以降で難読化が有効になっています。 iOSプロジェクトはルールの影響を受けません。

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

動的パラメーターの設定

Simple Log Service SDK for Flutterは、Endpoint、Project、Logstore、AccessKeyなどのパラメーターの動的設定をサポートしています。

• Endpoint、Project、およびLogstoreパラメーターを動的に設定するために使用されるサンプルコード:

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

• AccessKeyパラメーターを動的に設定するために使用されるサンプルコード:

  // The SecurityToken parameter is optional. This parameter is required only if you use STS to obtain a temporary AccessKey pair. 
  await _aliyunLogSdk!.setAccessKey('your accesskey id', 'your accesskey secret', securityToken: 'your accesskey token');

• Source、Topic、およびTagパラメーターを動的に設定するために使用されるサンプルコード:

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

• 他のパラメータを動的に設定するために使用されるサンプルコード:

  重要

  AliyunLogDartSdk.updateConfiguration() メソッドは、再開可能なアップロード関連パラメーターの動的設定をサポートしていません。

  LogProducerConfiguration configuration = LogProducerConfiguration();
  configuration.dropDelayLog = true;
  configuration.dropUnauthorizedLog = true;
  // You can dynamically configure the parameters in the LogProducerConfiguration class in the same manner. 
  await _aliyunLogSdk!.updateConfiguration(configuration);

ログ送信用のコールバックの設定

Simple Log Service SDK for Flutterは、ログ送信のコールバックをサポートしています。 ログが送信されるか、送信に失敗すると、コールバック情報が生成されます。 コールバック情報を使用して、SDKのステータスを表示したり、SDKのパラメーター設定を更新したりできます。

_aliyunLogSdk!.setLogCallback((resultCode, errorMessage, logBytes, compressedBytes) {
	// A parameter error occurs. You need to update parameter settings. 
	if (LogProducerResult.parametersInvalid == resultCode) {
	// For example, you can modify the Endpoint parameter. 
	_aliyunLogSdk!.setEndpoint('your endpoint');
	// A parametersInvalid error occurs. This is because no AccessKey pair is specified or the specified AccessKey pair is invalid. 
	_aliyunLogSdk!.setAccessKey('your access key id', 'your access key secret', securityToken: 'your token');
}

 	// An authorization timeout error occurs. You need to update your AccessKey pair. 
	if (LogProducerResult.sendUnauthorized == resultCode) {
		_aliyunLogSdk!.setAccessKey('your access key id', 'your access key secret', securityToken: 'your token');
	}
});

再開可能アップロードの有効化

AliyunLogDartSdkが初期化されたときに再開可能なアップロードを有効にするために使用されるサンプルコード:

configuration.persistent = true; // Enable resumable upload. 
configuration.persistentFilePath = 'flutter/demo'; // The path to the cache of binary logs. 
configuration.persistentForceFlush = false; // Disable forceful refresh. We recommend that you disable forceful refresh because it deteriorates system performance. 
configuration.persistentMaxFileCount = 10; // The maximum number of files that can be cached. Default value: 10. 
configuration.persistentMaxFileSize = 1024 * 1024; // The maximum size of each cached file. Default value: 1024 * 1024. 
configuration.persistentMaxLogCount = 64 * 1024; // The maximum number of logs that can be cached. Default value: 64 * 1024. 
_aliyunLogSdk = AliyunLogDartSdk();
LogProducerResult result = await _aliyunLogSdk!.initProducer(configuration);

LogProducerConfigurationクラスでパラメーターを設定します。

次の表に、LogProducerConfigurationクラスで設定できるパラメーターを示します。

エラーコード