Simple Log Service:Flutter SDK クイックスタート

リリースノート

SLS Flutter SDK は、公式の Dart パッケージリポジトリで公開されています。詳細については、「Aliyun Log Flutter Release」をご参照ください。

サンプルコード

完全な動作例については、「Aliyun Log Flutter SDK Example」をご参照ください。

前提条件

• Flutter 開発環境をインストールします。

• SLS Flutter SDK は、Android 4.0 以降および iOS 10.0 以降をサポートしています。

  • iOS ビルドの場合、Podfile に以下を追加する必要があります：

    source 'https://github.com/CocoaPods/Specs.git'
    source 'https://github.com/aliyun-sls/Specs.git'
    # 中国本土のリポジトリを使用している場合は、この行も追加する必要があります。
    source 'https://gitee.com/aliyun-sls/Specs.git'

操作手順

ステップ 1: SDK のインストール

1. Flutter プロジェクトを作成します。

2. SLS Flutter SDK モジュールを追加します。プロジェクトのルートから、次のコマンドを実行します：

   flutter pub add aliyun_log_dart_sdk

   プロセスが完了すると、プロジェクトの pubspec.yaml ファイルに次の情報が自動的に追加され、flutter pub get が暗黙的に実行されます。

   dependencies:
    aliyun_log_dart_sdk: ^1.0.0 // その他のバージョン情報については、Flutter SDK の概要をご参照ください。

3. Dart ファイルにパッケージをインポートします。

   import 'package:aliyun_log_dart_sdk/aliyun_log_dart_sdk.dart';

ステップ 2: SDK の初期化

次のコードは、基本的な初期化を示しています。ログパッケージのサイズや再開可能なアップロードなどの詳細設定オプションについては、「構成パラメーター」をご参照ください。

import 'package:aliyun_log_dart_sdk/aliyun_log_dart_sdk.dart';

AliyunLogDartSdk? _aliyunLogSdk;

void _initProducer() async {
  // エンドポイント、プロジェクト名、Logstore 名を設定します。
    LogProducerConfiguration configuration = LogProducerConfiguration(
      endpoint: 'your endpoint', project: 'your project', logstore: 'your logstore'
    ); 
  // Alibaba Cloud AccessKey。AccessKey ペアを使用すると、リソースへのフルアクセスが許可されるため、リスクが伴います。API 呼び出しには RAM ユーザーを使用することを強く推奨します。
    configuration.accessKeyId = 'your access key id';
    configuration.accessKeySecret = 'your access key secret';
    configuration.securityToken = 'your access key token'; // セキュリティトークンサービス (STS) からの一時的な AccessKey を使用する場合にのみ必要です。
    _aliyunLogSdk = AliyunLogDartSdk();
    LogProducerResult result = await _aliyunLogSdk!.initProducer(configuration);
}

ステップ 3: ログの送信

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': '中国語のコンテンツ'
});

code == LogProducerResult.ok の場合のみ、ログは正常に送信されます。それ以外の場合は、エラーコードが返されます。詳細については、「エラーコード」をご参照ください。

ステップ 4: 難読化ルールの設定 (Android)

Flutter プロジェクトで難読化ルールが有効になっている場合 (これらのルールは Flutter v1.16.2 以降ではデフォルトで有効になっています)、プロジェクトの難読化構成ファイルに次のルールも追加する必要があります。そうしないと、Android プロジェクトが正しく実行されない可能性があります。iOS プロジェクトはこのルールの影響を受けません。

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

動的構成

次のパラメーターは、ランタイムで更新できます：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 を更新します。

  // securityToken はオプションです。AccessKey がセキュリティトークンサービス (STS) を通じて取得された場合にのみ必要です。
  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;
  // LogProducerConfiguration クラスの他のパラメーターもこの方法で設定できます。
  await _aliyunLogSdk!.updateConfiguration(configuration);

ログコールバックの設定

ログ送信操作にコールバックを設定します。コールバックは成功時と失敗時の両方でトリガーされ、SDK ステータスのモニタリングと構成の更新を可能にします。

_aliyunLogSdk!.setLogCallback((resultCode, errorMessage, logBytes, compressedBytes) {
	// パラメーターが無効です。構成を更新する必要があります。
	if (LogProducerResult.parametersInvalid == resultCode) {
	// たとえば、Endpoint を更新します。
	_aliyunLogSdk!.setEndpoint('your endpoint');
	// AccessKey がないか、正しくない場合も parametersInvalid がトリガーされます。
	_aliyunLogSdk!.setAccessKey('your access key id', 'your access key secret', securityToken: 'your token');
}

 	// 権限付与が期限切れです。AccessKey を更新する必要があります。
	if (LogProducerResult.sendUnauthorized == resultCode) {
		_aliyunLogSdk!.setAccessKey('your access key id', 'your access key secret', securityToken: 'your token');
	}
});

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

初期化中に再開可能なアップロードを構成します：

configuration.persistent = true; // 再開可能なアップロードを有効にします。
configuration.persistentFilePath = 'flutter/demo'; // binlog をキャッシュするディレクトリ。
configuration.persistentForceFlush = false; // 強制フラッシュを無効にします。有効にするとパフォーマンスに影響する可能性があるため、無効のままにしてください。
configuration.persistentMaxFileCount = 10; // キャッシュされるファイルの最大数。デフォルト：10。
configuration.persistentMaxFileSize = 1024 * 1024; // 単一のキャッシュファイルの最大サイズ (バイト単位)。デフォルト：1024 * 1024。
configuration.persistentMaxLogCount = 64 * 1024; // キャッシュされるログの最大数。デフォルト：64 * 1024。
_aliyunLogSdk = AliyunLogDartSdk();
LogProducerResult result = await _aliyunLogSdk!.initProducer(configuration);

パラメーター

LogProducerConfiguration クラスでサポートされているパラメーターを次の表に示します。

エラーコード