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

パラメーターの動的構成

Android SDK は、Endpoint、ProjectName、logstore、AccessKey などのパラメーターの動的構成をサポートしています。

• Endpoint、ProjectName、logstore を動的に構成します。

  // Endpoint、ProjectName、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);
      }
  }

• source、topic、tag を動的に構成します。

  重要

  特定の種類のログに対して source、topic、または tag を設定することはできません。これらのパラメーターを設定すると、SLS への送信を待機しているすべてのログに適用されます。つまり、source、topic、tag を使用して特定のログの種類を追跡すると、結果が不正確になる可能性があります。ログを生成するときにフィールドを追加して、対応するログの種類を識別することをお勧めします。

  // ログソースを設定します。
  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 の初期化が繰り返される一般的な原因は、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);
        }
    }

  • SDK の初期化が繰り返されるもう 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 の元の実装を呼び出し、ログのレポートが失敗したときに 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 の初期化を実装します。
       // ...
     }
   }