Simple Log Service:Android SDK のクイックスタート

パラメーターの動的設定

Android SDK は、エンドポイント、プロジェクト名、Logstore、AccessKey などのパラメーターの動的設定をサポートしています。

• エンドポイント、プロジェクト名、Logstore を動的に設定します。

  // エンドポイント、プロジェクト名、Logstore などのパラメーターをまとめて、または個別に設定します。
  // エンドポイントを更新します。
  config.setEndpoint("your new-endpoint");
  // プロジェクト名を更新します。
  config.setProject("your new-project");
  // Logstore 名を更新します。
  config.setLogstore("your new-logstore");

• AccessKey を動的に設定します。

  AccessKey を動的に設定する場合は、LogProducerCallback と併用することを推奨します。

  // LogProducerClient の初期化時に LogProducerCallback を初期化済みの場合は、以下のコードを無視してください。
  final LogProducerCallback callback = new LogProducerCallback() {
      @Override
      public void onCall(int resultCode, String reqId, String errorMessage, int logBytes, int compressedBytes) {
          // resultCode：ステータスコード。詳細については、「エラーコード」をご参照ください。
          // reqId：リクエスト ID。このパラメーターは非推奨です。
          // errorMessage：失敗情報。
          // logBytes：元のログサイズ (バイト単位)。
          // compressedBytes：圧縮されたログサイズ (バイト単位)。
  
          final LogProducerResult result = LogProducerResult.fromInt(resultCode);
          if (LogProducerResult.LOG_PRODUCER_SEND_UNAUTHORIZED == result || LogProducerResult.LOG_PRODUCER_PARAMETERS_INVALID == result) {
              // AccessKey または SDK の初期化パラメーターを更新する必要があります。
              requestAccessKey();
          }
      }
  };
  
  // ログ送信の成功または失敗のステータスを追跡するには、2 番目のパラメーターとしてコールバックを渡す必要があります。
  client = new LogProducerClient(config, callback);
  
  // AccessKey 情報をリクエストします。
  private void requestAccessKey() {
      // モバイルログ直接アップロードサービスを使用して AccessKey 情報を設定することを推奨します。
      // ...
  
      // AccessKey 情報を取得した後、更新します。
      updateAccessKey(accessKeyId, accessKeySecret, securityToken);
  }
  
  // AccessKey 情報を更新します。
  private void updateAccessKey(String accessKeyId, String accessKeySecret, String securityToken) {
      // STS から取得した AccessKey には securityToken が含まれます。次の方法で AccessKey を更新する必要があります。
      if (null != securityToken && !"".equals(securityToken)) {
          config.resetSecurityToken(accessKeyId, accessKeySecret, securityToken);
      } else {
          // AccessKey が STS から取得されていない場合は、次の方法で AccessKey を更新します。
          config.setAccessKeyId(accessKeyId);
          config.setAccessKeySecret(accessKeySecret);
      }
  }

• ソース、トピック、タグを動的に設定します。

  重要

  特定のログタイプに対してソース、トピック、またはタグを設定することはできません。これらのパラメーターは、Simple Log Service (SLS) に送信待ちのすべてのログに適用されます。ソース、トピック、タグを使用して特定のログタイプを追跡する場合、結果が不正確になる可能性があります。ログタイプを識別するために、ログ生成時にフィールドを追加することを推奨します。

  // ログソースを設定します。
  config.setSource("your new-source");
  // ログトピックを設定します。
  config.setTopic("your new-topic");
  // タグ情報を設定します。このタグは各ログに追加されます。
  config.addTag("test", "your new-tag");

再開可能なアップロード

Android SDK は再開可能なアップロードをサポートしています。この機能を有効にすると、addLog メソッドを使用して追加されたログはローカルの binlog ファイルに保存されます。ローカルデータは、ログが正常に送信された後にのみ削除され、少なくとも 1 回の配信が保証されます。

SDK の初期化中に次のコードを追加して、再開可能なアップロードを有効にします。

private void initProducer() {
    // 1：再開可能なアップロード機能を有効にします。0：機能を無効にします。デフォルト値：0。
    config.setPersistent(1);
    // 永続化ファイルの名前。ファイルが配置されるフォルダーが作成されていることを確認してください。
    final String persistentFilePath = getFilesDir() + File.separator + "log_data";
    config.setPersistentFilePath(persistentFilePath);
    // ローリング永続化ファイルの数。このパラメーターを 10 に設定することを推奨します。
    config.setPersistentMaxFileCount(10);
    // 各永続化ファイルのサイズ。単位：バイト。形式は N*1024*1024 です。N を 1 から 10 の値に設定することを推奨します。
    config.setPersistentMaxFileSize(N*1024*1024);
    // ローカルにキャッシュできるログの最大数。このパラメーターには、1,048,576 を超える値を設定しないことを推奨します。デフォルト値：65,536。
    config.setPersistentMaxLogCount(65536);
}

難読化ルール

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

Android 権限

<uses-permission android:name="android.permission.INTERNET" />

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

Android SDK はログを非同期で送信します。ネットワーク状況により、ログの送信が失敗し、再送信される場合があります。SDK は、ステータスコード 200 が返された場合にのみ送信操作が成功したと見なすため、一部のログが重複する可能性があります。SQL クエリと分析ステートメントを使用してログの重複排除を行うことを推奨します。

ログの重複率が高い場合は、SDK の初期化に問題がないか確認してください。一般的な原因と解決策は次のとおりです。

• レジューム可能なアップロードの不正な設定

  レジューム可能なアップロードが正しく設定されていない場合は、setPersistentFilePath メソッドに渡されるファイルパスがグローバルに一意であることを確認してください。

• 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() {
            // 実際の初期化コードに置き換えてください。
            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);
        }
    }

  • もう 1 つの原因は、複数のプロセスを使用していることです。SDK はメインプロセスでのみ初期化してください。異なるプロセスで SDK を初期化する場合は、各プロセスで setPersistentFilePath に一意の値を設定してください。

• 弱いネットワーク環境向けの設定の最適化

  アプリケーションが弱いネットワーク環境で実行される場合は、次の例に示すように SDK の設定パラメーターを最適化してください。

  // SDK を初期化します。
  private void initProducer() {
      // HTTP 接続および送信のタイムアウト期間を調整して、ログの重複率を低減します。
      // 必要に応じて、具体的なタイムアウト期間を調整してください。
      config.setConnectTimeoutSec(20);
      config.setSendTimeoutSec(20);
    
      // その他の初期化パラメーター。
      // ...
  }

ログが欠損している場合はどうすればよいですか?

ログ送信は非同期です。ログが送信される前にアプリが閉じられると、未送信のログが失われる可能性があります。レジューム可能なアップロード機能を有効にすることを推奨します。詳細については、「レジューム可能なアップロード」をご参照ください。

ログレポートが遅延している場合はどうすればよいですか?

SDK はログを非同期で送信します。ネットワーク状況や特定のアプリケーションシナリオにより、ログがすぐに送信されない場合があります。少数のデバイスでの遅延は正常です。遅延が広範囲に及ぶ場合は、次のエラーコードを確認してください。

Android SDK は DNS 事前解析とキャッシュポリシーをサポートしていますか?

Android SDK、HTTPDNS SDK、OkHttp を使用して、DNS 事前解析とキャッシュポリシーを実装します。

1. カスタム DNS インターフェイスの実装

   /**
     * OkHttp の Dns インターフェイスに基づき、カスタム DNS 事前解析サービスを実装します。これは参考実装です。
     */
   public class OkHttpDns implements Dns {
     private Context mContext;
   
     public OkHttpDns(Context context) {
       mContext = context;
     }
   
     @Override
     public List<InetAddress> lookup(String host) throws UnknownHostException {
       // !!注意!! 
       // accountId を HTTPDNS サービスから取得した値に置き換えてください。詳細については、HTTPDNS のドキュメントをご参照ください。
       HTTPDNSResult httpdnsResult = HttpDns.getService(mContext, accountId)
         .getHttpDnsResultForHostSync(host, RequestIpType.both);
       List<InetAddress> inetAddresses = new ArrayList<>();
       InetAddress address;
       try {
         if (httpdnsResult.getIps() != null) {
           // IPv4 アドレスを処理します。
           for (String ipv4 : httpdnsResult.getIps()) {
             address = InetAddress.getByName(ipv4);
             inetAddresses.add(address);
           }
         }
   
         if (httpdnsResult.getIpv6s() != null) {
           // IPv6 アドレスを処理します。
           for (String ipv6 : httpdnsResult.getIpv6s()) {
             address = InetAddress.getByName(ipv6);
             inetAddresses.add(address);
           }
         }
       } catch (UnknownHostException e) {
   
       }
   
       if (!inetAddresses.isEmpty()) {
         return inetAddresses;
       }
   
       return okhttp3.Dns.SYSTEM.lookup(host);
     }
   }

2. カスタム NetworkInterface の実装

   /**
      * OkHttp に基づき、SLS SDK の NetworkInterface を実装します。これは参考実装です。
      */
   private static class OkHttpNetworkInterface implements LogProducerHttpTool.NetworkInterface {
   
     private OkHttpClient client;
   
     public OkHttpNetworkInterface(Context context) {
       client = new OkHttpClient.Builder()
         .connectTimeout(30, TimeUnit.SECONDS)
         .readTimeout(30, TimeUnit.SECONDS)
         .writeTimeout(30, TimeUnit.SECONDS)
         .dns(new OkHttpDns(context))
         .build();
     }
   
     @Override
     public NetworkResponse send(String urlString, String method, String[] header, byte[] body) {
       // まず SDK のネイティブ実装を呼び出します。接続レベルのエラー (ステータスコード -1) が発生した場合にのみ、フォールバックとして OkHttp を使用してログを報告することを推奨します。
       LogHttpResponse logHttpResponse = LogProducerHttpTool.android_http_post(urlString, method, header, body);
       if (logHttpResponse.getStatusCode() != -1) {
         NetworkResponse response = new NetworkResponse();
         response.statusCode = logHttpResponse.getStatusCode();
         response.errorMessage = logHttpResponse.getErrorMessage();
         return response;
       }
   
       // OkHttp を使用してログを報告します。
       Request.Builder builder = new Request.Builder();
       builder.url(urlString);
       builder.post(RequestBody.create(body));
   
       for (int i = 0; i < header.length; i += 2) {
         builder.addHeader(header[i], header[i + 1]);
       }
   
       // リクエストが成功したかどうかにかかわらず、NetworkResponse を返す必要があります。そうしないと、SDK が期待どおりに動作しない可能性があります。
       try (okhttp3.Response response = client.newCall(builder.build()).execute()) {
         NetworkResponse httpResponse = new NetworkResponse();
         httpResponse.statusCode = response.code();
         httpResponse.headers = response.headers().toMultimap();
         httpResponse.errorMessage = response.message();
   
         return httpResponse;
       } catch (IOException e) {
         NetworkResponse httpResponse = new NetworkResponse();
         httpResponse.statusCode = -1;
         httpResponse.headers = null;
         httpResponse.errorMessage = e.getLocalizedMessage();
   
         return httpResponse;
       }
     }
   
   }
   

3. SLS SDK の初期化

   public class AliyunSLS {
     private void initSLS(Context context) {
       // SLS SDK のカスタム NetworkInterface を設定します。
       // !!!注意!!!
       // この設定はすべての SLS SDK インスタンスに適用されます。
       LogProducerHttpTool.setNetworkInterface(new OkHttpNetworkInterface(context));
   
       // SLS SDK を初期化します。
       initProducer();
     }
   
     private void initProducer() {
       // LogProducerConfig と LogProducerClient の初期化をここで実装します。
       // ...
     }
   }