LTS HarmonyOS SDK

Transport Protocol

HTTPS

Prerequisites

• You have registered a Huawei account and enabled Huawei Cloud services.

• You have obtained the name of the region where LTS is deployed.
• You have obtained a project ID of your Huawei Cloud account. For details, see API Credentials.
• You have obtained the IDs of the target log group and log stream in LTS.

Version Updates

Installing the HarmonyOS SDK

1. Integrate the SDK. The SDK package is in ArkTS and can be imported only to ArkTS files.
   1. Integration through the HarmonyOS repository:
      • Run this command in your terminal:

        ohpm install lts-harmony-sdk

      • Add dependencies to the app/oh-package.json5 file.

        dependencies { 
             ... 
             "lts-harmony-sdk": "0.0.3" 
             ... 
         } 

      • Enable the SDK.

         ohpm install

   2. Manual integration:
      • Download the LTS SDK package.
      • Decompress the downloaded package to a specified directory. Note: Decompress the package only.
      • Add the decompressed HAR static library file to your project.
      • Add dependencies to the app/oh-package.json5 file.

        dependencies { 
             ... 
             "lts-harmony-sdk": "file:../plugin/LTS_SDK/default/lts-harmony-sdk.har" // Path of the HAR package
             ... 
         }

      • Enable the SDK.

        ohpm install

2. Perform initialization. For details about the parameters, see Table 4.

   The LTS SDK supports multi-instance log reporting. Instances are created based on different configurations for reporting.

   • Add dependencies.

     import { LTSSDK, ConfigParam } from 'lts-harmony-sdk';

   • ArkTS: example initialization code

     // LTS parameter configuration
      const config:ConfigParam = { 
           // Mandatory parameters
           region: string,  // Region where the logs are reported
           projectId: string,  // Huawei Cloud project ID
           groupId: string,  // LTS log group ID
           streamId: string,  // LTS log stream ID
           accessKey: string, // Huawei Cloud AK
           secretKey: string, // Huawei Cloud SK
           // Optional parameters
           url: string,  // Address of log reporting
           cacheThreshold: number,  // Threshold for the number of reported log records
           timeInterval: number,  // Threshold for the interval between log reports
           isReportBackground: boolean // Whether to report logs when running in the background
      }; 
      // Obtain ApplicationContext.
      let applicationContext = this.context.getApplicationContext(); 
       // LTS initialization method
      const ltssdk = new LTSSDK(applicationContext, config)

3. Report logs. LTS provides two log reporting methods.

   Table 2 Log reporting methods

   Method	Description
   report(content, labels)	LTS stores logs in the local database and reports them in real time based on the configured policy.
   reportImmediately(content, labels)	Logs are reported immediately.

   Table 3 Parameters

   Name	Description
   content	Log content. The value can be a dictionary or a dictionary array. A maximum of 300 key-value pairs are supported. The maximum length of the JSON string converted from content is 30 × 1024. If the length exceeds the limit, the excess part will be truncated.
   labels	Log labels. The value can be a dictionary or null. A maximum of 50 outermost key-value pairs are allowed. The maximum length of an outermost key is 64 characters. The key can contain letters, digits, and underscores (_), and must start with a letter. The maximum length of a dictionary converted to a JSON string is 30,720 characters. If the length exceeds the maximum, the excess part will be truncated before being reported.

   ArkTS code example:

   const ltssdk = new LTSSDK(applicationContext, config) 
   let fruit = { 
       "fruit_1": "apple", 
       "fruit_2": "pear", 
       "fruit_3": "banana" 
   }; 
   let food = { "food_1": "rice" }; 
   let labels = { "date":"2023-10-01"}; 
   let contents = [food, fruit]; 
   ltssdk.report(food);  // Cache and report a single record, without labels
   ltssdk.report(food, labels);  // Cache and report a single record, with labels
   ltssdk.reportImmediately(food);  // Immediately report a single record, without labels
   ltssdk.reportImmediately(food, labels);  // Immediately report a single record, with labels
   ltssdk.report(contents); // Cache and report multiple records, without labels
   ltssdk.report(contents, labels); // Cache and report multiple records, with labels
   ltssdk.reportImmediately(contents);  // Immediately report multiple records, without labels
   ltssdk.reportImmediately(contents, labels);  // Immediately report multiple records, with labels

Parameters

Log Reporting Policies

The LTS SDK supports the following log reporting policies: threshold-based reporting, scheduled reporting, and reporting when the app is switched to the background. Set parameters such as cacheThreshold, timeInterval, and isReportBackground based on the scenario.

Configuring Permissions

The LTS SDK requires the network permission of HarmonyOS. If this permission is not configured, add the following content to the module.json5 file of the app:

{ 
  "module": { 
    ... 
    "requestPermissions":[ 
       ... 
      { 
        "name": "ohos.permission.INTERNET" 
      }, 
      { 
        "name": "ohos.permission.GET_NETWORK_INFO" 
      } 
    ], 
    ... 
 
}

Debugging

Enable debugging if needed. Then you can monitor log reporting in real time on the console, and make adjustments accordingly.

Call the static method of the LTS SDK to make adjustments. The SDK supports five log levels: Debug, Info, Warning, Error, and Off. The default log level is Off. The five levels correspond to the following parameters: LogLevel.DEBUG, LogLevel.INFO, LogLevel.WARNING, LogLevel.ERROR, and LogLevel.OFF. The following is a code example:

ltssdk.setLogLevel(LogLevel.DEBUG)

Obtaining Parameters

• Read the region table.

  Table 5 Regions

  Name	Region
  CN North-Beijing4	cn-north-4
  CN East-Shanghai1	cn-east-3
  CN South-Guangzhou	cn-south-1

• To obtain a log group's ID, choose Log Management in the navigation pane of the LTS console and hover over the target log group's name.
• To obtain a log stream's ID, click the down arrow on the left of the corresponding log group name to expand the log stream list, then hover over the target log stream's name.