iOS SDK

Classic/VPC環境で利用できます。

iOS SDKでは Effective Log Search & Analytics 2.0サービスで提供する iOS SDKの使用方法を説明します。

SDKを使用する手順は、次の通りです。

1. 事前準備
2. SDKのインストール
3. SDKを使用する

1. 事前準備

iOS SDKをインストールするための事前準備事項は、次の通りです。

1. NAVERクラウドプラットフォームコンソールで、プロジェクトを作成します。
2. 作成したプロジェクト詳細情報画面で txtToken値を確認します。
3. iOS用 SDKをダウンロードします。

2. iOS SDKのインストール

iOS SDKをインストールする方法は、次の通りです。

1. ダウンロードした SDKファイルの圧縮を解凍します。
2. SDKをインストールする iOSプロジェクトの Frameworks フォルダに SDKファイルを保存します。
   • Nelo2SDK.framework
   • CrashReporter.framework
3. Xcodeを実行してプロジェクトを開きます。
4. TARGETS でビルドするターゲットをクリックします。
5. Build Phases を選択した後、Link Binary With Libraries 領域に以下のシステムフレームワークを追加します。

• UIKit.framework
• SystemConfiguration.framework
• CoreTelephony.framework
• Foundation.framework

3. SDKを使用する

以下の Effective Log Search & Analytics 2.0 iOS SDKを使用する実際のサンプルコードを参照し、プロジェクトにログを転送します。

NSString* appID = @"02b96c3d8bbe_elsa-test";
NSString* appVer= @"1.0.0";
NSString* serverAddr = @"elsa-v2-col.ncloud.com"; //Effective Log Search & Analytics収集サーバアドレス
NSString* userID = @"tester"; //ユーザー ID

// Nelo Init
[NeloLog init:serverAddr ofProjectName:appID withProjectVersion:appVer forUserId:userID];

// Neloログ転送
[NeloLog info:@"ErrorCode" withMessage:@"Message"];
[NeloLog error:@"ErrorCode" withMessage:@"Message" atLocation:@"test loc"];

iOS SDK APIの明細

iOS SDKは以下のような APIを提供します。

• 初期化 API
• ログ転送 API
• オプション設定 API

初期化 API

初期化する APIは、次の通りです。

// Default NeloLog init method
+ (bool) init:(NSString *)serverAddr ofProjectName:(NSString* )appName withProjectVersion:(NSString*)appVersion;
+ (bool) init:(NSString *)serverAddr ofProjectName:(NSString* )appName withProjectVersion:(NSString*)appVersion forUserId:(NSString* )userId;

各パラメータの説明は、次の通りです。

例)

NSString* appID = @"02b96c3d8bbe_elsa-test";
NSString* appVer= @"1.0.0";
NSString* serverAddr = @"elsa-v2-col.ncloud.com"; //Effective Log Search & Analytics 2.0収集サーバアドレス
NSString* userID = @"tester"; //ユーザー ID

// Nelo Init
[NeloLog init:serverAddr ofProjectName:appID withProjectVersion:appVer forUserId:userID];

ログ転送 API

ログを転送する APIは、次の通りです。

// send log method
+ (void) debug:(NSString *)errorCode withMessage:(NSString* )message;
+ (void) error:(NSString *)errorCode withMessage:(NSString* )message;
+ (void) fatal:(NSString *)errorCode withMessage:(NSString* )message;
+ (void) info:(NSString *)errorCode withMessage:(NSString* )message;
+ (void) warn:(NSString *)errorCode withMessage:(NSString* )message;

+ (void) debug:(NSString *)errorCode withMessage:(NSString* )message atLocation:(NSString*)location;
+ (void) error:(NSString *)errorCode withMessage:(NSString* )message atLocation:(NSString*)location;
+ (void) fatal:(NSString *)errorCode withMessage:(NSString* )message atLocation:(NSString*)location;
+ (void) info:(NSString *)errorCode withMessage:(NSString* )message atLocation:(NSString*)location;
+ (void) warn:(NSString *)errorCode withMessage:(NSString* )message atLocation:(NSString*)location;

各パラメータの説明は、次の通りです。

例)

[NeloLog info:@"ErrorCode" withMessage:@"Message"];

オプション設定 API

オプション設定 APIは、次の通りです。

ユーザー ID設定

ユーザー IDを設定する APIは、次の通りです。

+ (void) setUserId:(NSString*)userId;

各パラメータの説明は、次の通りです。

ログタイプ設定

ログのタイプを設定する APIは、次の通りです。

+ (void) setLogType:(NSString*)logType;

各パラメータの説明は、次の通りです。

クラッシュコールバック

クラッシュコールバック APIを使用してクラッシュ発生時に、クラッシュログを転送する前にユーザーが定義した関数を呼び出せます。クラッシュコールバック APIは、次の通りです。

+ (void) setCrashBlock:(void (^)(void))block;

各パラメータの説明は、次の通りです。

例)

[NeloLog setCrashBlock:^{
    NSLog(@"crashed");
    [NeloLog setCustomField:@"MyValue" forKey:@"MyKey"];
}];

ログレベル(loglevel)設定

ログレベル(loglevel)以上のログのみ転送する APIは、次の通りです。

+ (void) setLogLevelFilter:(NSString*)logLevelFilter;

各パラメータの説明は、次の通りです。

例)

[NeloLog setLogLevelFilter:NELO2 _LOGLEVEL_ WARN];

ログ転送方法設定

ログ転送方法を設定する APIは、次の通りです。

+ (void) setNeloSendMode:(NSString*)sendMode;

各パラメータの説明は、次の通りです。

パラメータの設定値によるネットワーク別のログ転送方法は、次の通りです。

• ALL 設定時

  ネットワーク状態	転送方法
  3g	転送
  Wi-Fi	転送
  Not Connected	転送しない

• WIFI 設定時

  ネットワーク状態	転送方法
  3g	転送しない
  Wi-Fi	転送
  Not Connected	転送しない

シンボリケーション実行設定

クライアントでのシンボリケーション(Symbolication)の実行有無を設定する APIは、次の通りです。

+ (void) enableClientSideSymbolication:(bool)enable;

各パラメータの説明は、次の通りです。