iOS SDK

Available in Classic and VPC

In iOS SDK, it describes how to use iOS SDK, which is provided by Effective Log Search & Analytics 2.0 service.

The following describes how to use SDK.

1. Preparation
2. Install SDK
3. Use SDK

1. Preparation

The following describes the preparations for installing iOS SDK.

1. In NAVER Cloud Platform's console, Create project.
2. Check the txtToken value in Project detail page.
3. Download SDK for iOS.

2. Install iOS SDK

The following describes how to install iOS SDK.

1. Unzip the downloaded SDK file.
2. Save the SDK file in the Frameworks folder of the iOS project where SDK is to be installed.
   • Nelo2SDK.framework
   • CrashReporter.framework
3. Run Xcode to open the project.
4. Click the target to build in TARGETS.
5. Select Build Phases, and add the following system framework in the Link Binary With Libraries field.
   • UIKit.framework
   • SystemConfiguration.framework
   • CoreTelephony.framework
   • Foundation.framework

3. Use SDK

Refer to the following actual code examples that use Effective Log Search & Analytics 2.0 iOS SDK and transfer logs to the projects.

NSString* appID = @"02b96c3d8bbe_elsa-test";
NSString* appVer= @"1.0.0";
NSString* serverAddr = @"elsa-v2-col.ncloud.com"; //Effective Log Search & Analytics collecting server's address
NSString* userID = @"tester"; //userID

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

// Nelo log transfer
[NeloLog info:@"ErrorCode" withMessage:@"Message"];
[NeloLog error:@"ErrorCode" withMessage:@"Message" atLocation:@"test loc"];

iOS SDK API details

iOS SDK provides the following APIs:

• Initialization API
• Log transferring API
• Option setting API

Initialization API

Here are the APIs that initialize.

// 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;

The following describes each parameter.

<example>

NSString* appID = @"02b96c3d8bbe_elsa-test";
NSString* appVer= @"1.0.0";
NSString* serverAddr = @"elsa-v2-col.ncloud.com"; //Effective Log Search & Analytics 2.0 collecting server's address
NSString* userID = @"tester"; //userID

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

Log transferring API

Here are the APIs that transfer logs.

// 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;

The following describes each parameter.

<example>

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

Option setting API

Here are the Option setting APIs.

Set user ID

Here are the APIs that set user ID.

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

The following describes each parameter.

Set log type

Here are the APIs that set logType.

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

The following describes each parameter.

Crash callback

You can call the user-defined functions before sending the crash log when a crash occurs. Here are the crash callback APIs.

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

The following describes each parameter.

<example>

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

Set loglevel

Here are the APIs that transfer logs over the loglevel.

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

The following describes each parameter.

<example>

[NeloLog setLogLevelFilter:NELO2_LOGLEVEL_WARN];

Set log transfer method

Here are the APIs that set log transfer method.

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

The following describes each parameter.

The following shows the log transfer method by network, depending on the parameter setting value.

• When setting to ALL

  Network status	Transfer method
  3g	Transfer
  Wi-Fi	Transfer
  Not Connected	Not sent

• When setting to WIFI

  Network status	Transfer method
  3g	Not sent
  Wi-Fi	Transfer
  Not Connected	Not sent

Set symbolication execution

Here are the APIs that set whether to execute symbolication at the client.

+ (void) enableClientSideSymbolication:(bool)enable;

The following describes each parameter.