Simple Log Service:Simple Log Service SDK for Androidの使用を開始する

クイックスタート

次のメソッドを使用してSDKを初期化し、addLogメソッドを呼び出してSimple Log Serviceにログをアップロードできます。

// We recommend that you globally save the LogProducerConfig and LogProducerClient instances. 
private LogProducerConfig config = null;
private LogProducerClient client = null;

/**
 * Initialize the SDK.
 */

private void initProducer() {
    try {
        // The Simple Log Service endpoint. The endpoint must start with https:// or http://. 
        final String endpoint = "your endpoint";
        final String project = "your project";
        final String logstore = "your logstore";

        config = new LogProducerConfig(context, endpoint, project, logstore);
        // The topic of logs. 
        config.setTopic("example_topic");
        // The tag, which is added to all logs. 
        config.addTag("example", "example_tag");

        // Specify whether to discard an expired log. The value 0 specifies that an expired log is not discarded and the time of the log is changed to the current time. The value 1 specifies that an expired log is discarded. Default value: 1. 
        config.setDropDelayLog(0);
        // Specify whether to discard a log for which authentication failed. The value 0 specifies that a log is not discarded. The value 1 specifies that a log is discarded. Default value: 0. 
        config.setDropUnauthorizedLog(0);

        // The LogProducerCallback method is optional. You do not need to register a callback if you are not concerned about whether a log is successfully uploaded. 
        // If you need to dynamically configure an AccessKey pair, we recommend that you configure the LogProducerCallback method and configure settings to update the AccessKey pair when you call the onCall method. 
        final LogProducerCallback callback = new LogProducerCallback() {
            @Override
            public void onCall(int resultCode, String reqId, String errorMessage, int logBytes, int compressedBytes) {
                // resultCode: the status code. For more information, see the "Error codes" section in this topic. 
                // reqId: the request ID. This parameter is deprecated. 
                // errorMessage: the error message. 
                // logBytes: the total number of bytes in the raw log. 
                // compressedBytes: the number of bytes in the log after compression. 

                final LogProducerResult result = LogProducerResult.fromInt(resultCode);
                if (LogProducerResult.LOG_PRODUCER_SEND_UNAUTHORIZED == result || LogProducerResult.LOG_PRODUCER_PARAMETERS_INVALID == result) {
                    // Update the AccessKey pair or the parameters required for SDK initialization. 
                }
            }
        };
      
        // Pass callback as the second parameter if you are concerned about whether a log is successfully uploaded. 
        client = new LogProducerClient(config, callback);
    } catch (LogProducerException e) {
        e.printStackTrace();
    }
}
// Query the AccessKey pair. 
private void requestAccessKey() {
    // We recommend that you configure an AccessKey pair based on the direct data transfer service. 
    // ...

    // After you obtain the AccessKey pair, initiate a call to update the AccessKey pair. 
    updateAccessKey(accessKeyId, accessKeySecret, securityToken);
}

// Update the AccessKey pair. 
private void updateAccessKey(String accessKeyId, String accessKeySecret, String securityToken) {
    // If you obtain an AccessKey pair by using Security Token Service (STS), the AccessKey pair contains securityToken. In this case, you must update the AccessKey pair by using the following method: 
    if (null != securityToken && !"".equals(securityToken)) {
        config.resetSecurityToken(accessKeyId, accessKeySecret, securityToken);
    } else {
        // If you obtain an AccessKey pair by using a method other than STS, update the AccessKey pair by using the following method: 
        config.setAccessKeyId(accessKeyId);
        config.setAccessKeySecret(accessKeySecret);
    }
}

/**
 * Upload logs.
 */
public void addLog() {
    Log log = new Log();
    // Adjust the fields that you want to upload based on your business requirements. 
    log.putContent("content_key_1", 123456);
    log.putContent("content_key_2", 23.34f);
    log.putContent("content_key_3", "Chinese");
    log.putContent(null, "null");
    log.putContent("null", (String) null);
    client.addLog(log);
}

よくある質問

重複ログが存在するのはなぜですか?

Simple Log Service SDK for Androidは、ログを非同期にアップロードします。 ネットワークの状態が悪いため、ログのアップロードに失敗することがあります。 この場合、ログは再びアップロードされます。 ログアップロードは、ステータスコード200が返された場合にのみ成功と見なされます。 したがって、重複ログが存在する可能性があります。 クエリ文を実行してログの重複を排除することを推奨します。

重複率が高い場合は、SDKの初期化中にエラーが発生していないか確認する必要があります。 次のリストは、ログを複製する原因と解決策を示しています。

• 再開可能アップロードの設定が無効です

  setPersistentFilePathパラメーターに一意の値が指定されているかどうかを確認します。

• SDKの初期化の複製

  • ほとんどの場合、重複したSDK初期化は、単一インスタンスの無効な書き込み、またはSDK初期化がシングルトンモードでカプセル化されていないために発生します。 次の方法に基づいてSDKの初期化を完了することを推奨します。

    public class AliyunLogHelper {
        private LogProducerConfig config;
        private LogProducerClient client;
    
        private static class Holder {
            private static final AliyunLogHelper INSTANCE = new AliyunLogHelper();
        }
    
        public static AliyunLogHelper getInstance() {
            return Holder.INSTANCE;
        }
    
        private AliyunLogHelper() {
            initProducer();
        }
    
        private void initProducer() {
            // Replace the following code with your code for SDK initialization. 
            try {
                config = new LogProducerConfig();
                client = new LogProducerClient(config);
            } catch (LogProducerException e) {
                e.printStackTrace();
            }
        }
    
        public void addLog(Log log) {
            if (null == client) {
                return;
            }
    
            client.addLog(log);
        }
    }

  • 複数のプロセスでSDKの初期化が重複することもあります。 メインプロセスでのみSDKを初期化するか、複数のプロセスでSDKを初期化する場合はsetPersistentFilePathパラメーターに異なる値を指定することを推奨します。

• 悪いネットワーク条件

  悪いネットワーク条件でアプリを実行する場合は、次の例に基づいてSDK初期化のパラメーターを再設定することをお勧めします。

  // Initialize the SDK. 
  private void initProducer() {
      // Change the timeout periods for HTTP connections and log upload to decrease the duplication rate of logs. 
      // You can change the timeout periods based on your business requirements. 
      config.setConnectTimeoutSec(20);
      config.setSendTimeoutSec(20);
    
      // Configure other parameters for SDK initialization. 
      // ...
  }

ログが失われた場合はどうすればよいですか?

ログは非同期にアップロードされます。 ログがアップロードされる前にアプリを閉じた場合、ログをアップロードできず、失われる可能性があります。 再開可能アップロードを有効にすることを推奨します。 詳細については、「再開可能なアップロード」をご参照ください。

ログのアップロード中にレイテンシが存在する場合はどうすればよいですか。

ログは非同期にアップロードされます。 ネットワークの状態が悪く、アプリの特定のシナリオが原因で、ログがすぐにアップロードされない場合があります。 レイテンシが複数のデバイスにのみ存在する場合、これは正常です。 それ以外の場合は、次のエラーコードに基づいて問題をトラブルシューティングします。