Simple Log Service:Get started with Simple Log Service SDK for HarmonyOS

Prerequisites

Simple Log Service SDK for HarmonyOS is installed. For more information, see Install Simple Log Service SDK for HarmonyOS.

Initialize the SDK

You can initialize the SDK based on the following sample code:

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>" // This variable is required only when the AccessKey pair is obtained by calling a Security Token Service (STS) operation.
);

• Simple Log Service provides endpoints for the region where a project resides. You can access Simple Log Service by using an internal or public endpoint. An internal endpoint can be accessed over the classic network or a virtual private cloud (VPC). A public endpoint can be accessed over the Internet. For more information, see Endpoints.

• An Alibaba Cloud AccessKey pair is a secure identity credential that you can use to access your Alibaba Cloud resources by calling API operations. You can use the AccessKey pair to sign API requests to pass the security authentication. For more information, see AccessKey pair.

Report logs

You can use the addLog method to report custom business logs.

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

If code == 0 is returned, logs are reported. For more information about ststus codes, see Status codes.

Configure an AccessKey pair

Simple Log Service SDK for HarmonyOS SDK allows you to dynamically update an AccessKey pair. You can update an AccessKey pair based on the following sample code:

aliyunLog.setAccessKey(
    "<your accesskey id>", // Specify a valid AccessKey ID.
    "<your accesskey secret>", // Specify a valid AccessKey secret.
    null // Specify a valid AccessKey token. This variable is required only when the AccessKey pair is obtained by calling an STS operation.
);

Configure callback for log sending

Simple Log Service SDK for HarmonyOS supports callback for log sending. When a log is sent or fails to be sent, callback information is generated. You can use the callback information to view the status of the SDK or update the parameter settings of the SDK.

class MyLogCallback implements LogCallback {

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

    onLogCallback(logStore:string, code:number, logBytes:number, compressedBytes:number, errorMessage:string) {
        // The error code 6 indicates that the AccessKey pair is invalid.
        // The error code 11 indicates that the parameter settings are invalid.
        if (code == 6 || code == 11) {
            aliyunLog.setAccessKey(
                    "<your accesskey id>", // Specify a valid AccessKey ID.
                    "<your accesskey secret>", // Specify a valid AccessKey secret.
                    null // Specify a valid AccessKey token. This variable is required only when the AccessKey pair is obtained by calling an STS operation.
            );
        }
    }
}

Status codes