HarmonyOS SDK快速入门

前提条件

已完成日志服务HarmonyOS SDK安装。更多信息，请参见安装HarmonyOS SDK。

初始化SDK

您可以参考以下代码进行SDK初始化。

import { AliyunLog, LogCallback } from "@aliyunsls/producer"

let aliyunLog: AliyunLog = new AliyunLog(
  "<your endpoint>",
  "<your project>",
  "<your logstore>",
  "<your accesskey id>",
  "<your accesskey secret>",
  "<your accesskey token>" // 仅当AccessKey是通过STS方式获取时才需要
);

• Endpoint是日志服务Project所在地域的访问域名，支持公网和阿里云内网（经典网络、VPC）。更多信息，请参见服务入口。

• 阿里云访问密钥（AccessKey）是调用API访问云资源的安全口令，您可以使用AccessKey签名API请求内容以通过服务端的安全验证，具体请参见访问密钥。

上报日志

可以通过addLog方法上报自定义业务日志。

let code = aliyunLog.addLog(new Map(
  [
    ["key1", "value1"],
    ["key2", "value2"],
    ["key3", "value3"],
  ]
));

仅当code == 0时才表示上报日志成功。其他情况下返回状态码的更多操作，请参见状态码说明。

配置AccessKey

日志服务HarmonyOS SDK支持对AccessKey的动态更新，您可以参考如下代码进行AccessKey的更新配置：

aliyunLog.setAccessKey(
    "<your accesskey id>", // 填入正确的AccessKey Id
    "<your accesskey secret>", // 填入正确的AccessKey Secret
    null // 填入正确的AccessKey Token. 只有当AccessKey是通过STS方式获取时才需要
);

设置日志发送回调

日志服务HarmonyOS SDK支持设置日志发送回调。日志发送成功或失败时，都会产生对应的回调信息。您可以通过回调信息来确定SDK的运行情况，或者更新SDK的参数配置。

class MyLogCallback implements LogCallback {

    init() {
        aliyunLog.setLogCallback(this);
    }

    onLogCallback(logStore:string, code:number, logBytes:number, compressedBytes:number, errorMessage:string) {
        // 错误码为6表示AccessKey无效
        // 错误码为11表示参数配置错误
        if (code == 6 || code == 11) {
            aliyunLog.setAccessKey(
                    "<your accesskey id>", // 填入正确的AccessKey Id
                    "<your accesskey secret>", // 填入正确的AccessKey Secret
                    null // 填入正确的AccessKey Token. 只有当AccessKey是通过STS方式获取时才需要
            );
        }
    }
}

状态码说明