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

クイックスタート

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

@interface ProducerExampleController ()
// We recommend that you globally save the LogProducerConfig and LogProducerClient instances. 
@property(nonatomic, strong) LogProducerConfig *config;
@property(nonatomic, strong) LogProducerClient *client;
@end

@implementation ProducerExampleController


// The callback 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 callback method and configure settings to update the AccessKey pair when you call the callback method. 
static void _on_log_send_done(const char * config_name, log_producer_result result, size_t log_bytes, size_t compressed_bytes, const char * req_id, const char * message, const unsigned char * raw_buffer, void * userparams) {
    if (result == LOG_PRODUCER_OK) {
        NSString *success = [NSString stringWithFormat:@"send success, config : %s, result : %d, log bytes : %d, compressed bytes : %d, request id : %s", config_name, (result), (int)log_bytes, (int)compressed_bytes, req_id];
        SLSLogV("%@", success);
    } else {
        NSString *fail = [NSString stringWithFormat:@"send fail   , config : %s, result : %d, log bytes : %d, compressed bytes : %d, request id : %s, error message : %s", config_name, (result), (int)log_bytes, (int)compressed_bytes, req_id, message];
        SLSLogV("%@", fail);
    }
}

- (void) initLogProducer {
    // The Simple Log Service endpoint. The endpoint must start with https:// or http://. 
    NSString *endpoint = @"your endpoint";
    NSString *project = @"your project";
    NSString *logstore = @"your logstore";

    _config = [[LogProducerConfig alloc] initWithEndpoint:endpoint
                                                  project:project
                                                 logstore:logstore
    ];

    // The topic of logs. 
    [_config SetTopic:@"example_topic"];
    // The tag, which is added to all logs. 
    [_config AddTag:@"example" value:@"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:1];
    // 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];    

    // Pass callback as the second parameter if you are concerned about whether a log is successfully uploaded. 
    _client = [[LogProducerClient alloc] initWithLogProducerConfig:_config callback:_on_log_send_done];
}

// Query the AccessKey pair. 
- (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. 
    [self updateAccessKey:accessKeyId accessKeySecret:accessKeySecret securityToken:securityToken];
}

// Update the AccessKey pair. 
- (void) updateAccessKey:(NSString *)accessKeyId accessKeySecret:(NSString *)accessKeySecret securityToken:(NSString *)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 (securityToken.length > 0) {
        if (accessKeyId.length > 0 && accessKeySecret.length > 0) {
            [_config ResetSecurityToken:accessKeyId
                        accessKeySecret:accessKeySecret
                          securityToken:securityToken
            ];
        }
    } else {
        // If you obtain an AccessKey pair by using a method other than STS, update the AccessKey pair by using the following method: 
        if (accessKeyId.length > 0 && accessKeySecret.length > 0) {
            [_config setAccessKeyId: accessKeyId];
            [_config setAccessKeySecret: accessKeySecret];
        }
    }
}
// Upload logs. 
- (void) addLog {
    Log *log = [Log log];
    // Adjust the fields that you want to upload based on your business requirements. 
    [log putContent:@"content_key_1" intValue:123456];
    [log putContent:@"content_key_2" floatValue:23.34f];
    [log putContent:@"content_key_3" value:@"Chinese"];
    
    [_client AddLog:log];
}
@end

高度な操作

動的にパラメーターを設定

Simple Log Service SDK for iOSを使用して、Endpoint、Project、Logstore、およびAccessKeyパラメーターを動的に設定できます。 詳細については、「エンドポイント」および「AccessKeyペア」をご参照ください。

• Endpoint、Project、およびLogstoreパラメーターを動的に設定します。

  // You can configure one or more of the Endpoint, Project, and Logstore parameters at a time. 
  // Update the endpoint. 
  [_config setEndpoint:@"your new-endpoint"];
  // Update the project. 
  [_config setProject:@"your new-project"];
  // Update the Logstore. 
  [_config setLogstore:@"your new-logstore"];

• AccessKeyパラメーターを動的に設定します。

  AccessKeyペアを動的に設定する場合は、コールバック方法も設定することを推奨します。

  // If the callback method is initialized when you initialize the LogProducerClient instance, ignore the following code: 
  static void _on_log_send_done(const char * config_name, log_producer_result result, size_t log_bytes, size_t compressed_bytes, const char * req_id, const char * message, const unsigned char * raw_buffer, void * userparams) {
      if (LOG_PRODUCER_SEND_UNAUTHORIZED == result || LOG_PRODUCER_PARAMETERS_INVALID) {
          [selfClzz requestAccessKey]; // selfClzz specifies the ownership of the current class. 
      }
  }
  
  // Pass callback as the second parameter if you are concerned about whether a log is successfully uploaded. 
  _client = [[LogProducerClient alloc] initWithLogProducerConfig:_config callback:_on_log_send_done];
  
  // Query the AccessKey pair. 
  - (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. 
      [self updateAccessKey:accessKeyId accessKeySecret:accessKeySecret securityToken:securityToken];
  }
  
  // Update the AccessKey pair. 
  - (void) updateAccessKey:(NSString *)accessKeyId accessKeySecret:(NSString *)accessKeySecret securityToken:(NSString *)securityToken {
      
      // If you obtain an AccessKey pair by using STS, the AccessKey pair contains securityToken. In this case, you must update the AccessKey pair by using the following method: 
      if (securityToken.length > 0) {
          if (accessKeyId.length > 0 && accessKeySecret.length > 0) {
              [_config ResetSecurityToken:accessKeyId
                          accessKeySecret:accessKeySecret
                            securityToken:securityToken
              ];
          }
      } else {
          // If you obtain an AccessKey pair by using a method other than STS, update the AccessKey pair by using the following method: 
          if (accessKeyId.length > 0 && accessKeySecret.length > 0) {
              [_config setAccessKeyId: accessKeyId];
              [_config setAccessKeySecret: accessKeySecret];
          }
      }
  }

• Source、Topic、およびTagパラメーターを動的に設定します。

  重要

  Source、Topic、またはTagパラメーターは、特定の種類のログに対してのみ設定できます。 Source、Topic、およびTagパラメーターの設定は、Simple Log Serviceへのアップロードに失敗したログに対して有効になります。 Source、Topic、およびTagパラメーターに基づいて特定の種類のログをトレースする場合、結果が期待どおりでない場合があります。 生成されるログの種類を識別するために、新しいフィールドを追加することを推奨します。

  // The topic of logs. 
  [_config SetTopic:@"your new-topic"];
  // The source of logs. 
  [_config SetSource:@"your new-source"];
  // The tag, which is added to all logs. 
  [_config AddTag:@"test" value:@"your new-tag"];

再開可能アップロードの実行

Simple Log Service SDK for iOSは、再開可能なアップロードをサポートしています。 再開可能アップロードを有効にすると、addLogメソッドを使用してSimple Log Serviceに書き込まれたログは、ローカルのbinlogファイルに一時的に保存されます。 ログがSimple Log Serviceに正常にアップロードされると、ログはローカルファイルから削除されます。 これにより、ログのアップロード中に少なくとも1回のセマンティクスが正常に実装されます。

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

- (void) initLogProducer {
    // The value 1 specifies that resumable upload is enabled. The value 0 specifies that resumable upload is disabled. Default value: 0. 
    [_config SetPersistent:1];
    
    // The name of the persistent file. Make sure that the folder in which the file is stored is created. 
    NSArray  *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
    NSString *Path = [[paths lastObject] stringByAppendingString:@"/log.dat"];
    [_config SetPersistentFilePath:Path];
    // The number of persistent files that can be rolled. We recommend that you set the parameter to 10. 
    [_config SetPersistentMaxFileCount:10];
    // The size of a persistent file. Unit: bytes. The value is calculated based on the following formula: N × 1024 × 1024. We recommend that you set N to a value ranging from 1 to 10. 
    [_config SetPersistentMaxFileSize:N*1024*1024];
    // The number of logs that can be cached on your computer. We recommend that you do not set the parameter to a value greater than 1048576. Default value: 65536. 
    [_config SetPersistentMaxLogCount:65536];
}

Parameters

次の表に、LogProducerConfigクラスによって提供されるパラメーターを示します。

エラーコード

すべてのエラーコードはlog_producer_resultで定義されています。 次の表に、エラーコードを示します。

よくある質問

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

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

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

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

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

• SDKの初期化の複製

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

    // AliyunLogHelper.h
    @interface AliyunLogHelper : NSObject
    + (instancetype)sharedInstance;
    - (void) addLog:(Log *)log;
    @end
    
    
    // AliyunLogHelper.m
    @interface AliyunLogHelper ()
    @property(nonatomic, strong) LogProducerConfig *config;
    @property(nonatomic, strong) LogProducerClient *client;
    @end
    
    @implementation AliyunLogHelper
    
    + (instancetype)sharedInstance {
        static AliyunLogHelper *sharedInstance = nil;
        static dispatch_once_t onceToken;
        dispatch_once(&onceToken, ^{
            sharedInstance = [[self alloc] init];
        });
        return sharedInstance;
    }
    
    - (instancetype)init {
        self = [super init];
        if (self) {
            [self initLogProducer];
        }
        return self;
    }
    
    - (void) initLogProducer {
        // Replace the following code with your code for SDK initialization. 
        _config = [[LogProducerConfig alloc] initWithEndpoint:@""
                                                      project:@""
                                                     logstore:@""
                                                  accessKeyID:@""
                                              accessKeySecret:@""
                                                securityToken:@""
        ];
    
        _client = [[LogProducerClient alloc] initWithLogProducerConfig:_config callback:_on_log_send_done];
    }
    
    - (void) addLog:(Log *)log {
        if (nil == log) {
            return;
        }
    
        [_client AddLog:log];
    }
    
    @end

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

• 悪いネットワーク条件

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

  // Initialize the SDK. 
  - (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. 
      // ...
  }

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

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

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

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