Flutter SDK快速入门

前提条件

已安装日志服务Flutter SDK。具体操作，请参见安装Flutter SDK。

初始化SDK

一般场景下，您可以参考以下代码进行初始化。若您需要配置LogProducerConfiguration类，例如配置详细的上传日志包大小、开启断点续传功能等。详细配置说明，请参见配置参数说明。

import 'package:aliyun_log_dart_sdk/aliyun_log_dart_sdk.dart';

AliyunLogDartSdk? _aliyunLogSdk;

void _initProducer() async {
  // 配置服务入口Endpoint、Project名称、Logstore名称。您可以通过动态参数配置动态更新Endpoint、Project名称等。
    LogProducerConfiguration configuration = LogProducerConfiguration(
      endpoint: 'your endpoint', project: 'your project', logstore: 'your logstore'
    ); 
  //阿里云访问密钥AccessKey。更多信息，请参见访问密钥。阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。
    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);
}

您可以参考以下文档获取SDK初始化所需的Endpoint、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': '中文'
});

仅当code == LogProducerResult.ok时才表示上报日志成功。其他情况下返回错误码，请参见错误码说明。

混淆规则

如果您的Flutter项目开启了混淆规则（Flutter 1.16.2及以版本默认开启混淆规则），您还需要在您项目的混淆配置文件中加入以下规则，否则Android项目可能无法正常运行。iOS项目不受此规则影响。

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

动态化配置参数

日志服务Flutter SDK支持动态化配置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);

设置日志发送回调

日志服务Flutter SDK支持设置日志发送回调。日志发送成功或失败时，都会产生对应的回调信息。您可以通过回调信息来确定SDK的运行情况，或者更新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');
	}
});

开启断点续传

您可以参考如下代码，在初始化AliyunLogDartSdk时开启断点续传功能。

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类支持的参数配置如下表所示。

错误码说明