- 인쇄
- PDF
Android SDK v1
- 인쇄
- PDF
Classic/VPC 환경에서 이용 가능합니다.
Android SDK v1 사용에서는 Effective Log Search & Analytics 2.0 서비스가 제공하는 Android SDK v1의 사용 방법을 설명합니다.
SDK를 사용하는 순서는 다음와 같습니다.
1. 사전 준비
2. SDK 설치
3. SDK 초기화
4. SDK 권한 추가
5. SDK 사용
1. 사전 준비
Android SDK를 설치하기 위한 사전 준비 사항은 다음과 같습니다.
- 네이버 클라우드 플랫폼의 콘솔에서 프로젝트를 생성해 주십시오.
- 생성한 프로젝트의 상세 정보 화면에서 txtToken 값을 확인해 주십시오.
- Android SDK v1을 다운로드해 주십시오.
2. Android SDK v1 설치
Android SDK v1을 설치하는 방법은 다음과 같습니다.
- 다운로드한 SDK 파일의 압축을 풀어 주십시오.
- SDK를 설치할 Android 프로젝트의
libs
폴더에 SDK 파일을 저장해 주십시오.- Thrift 프로토콜 사용 시:
nelo2-android-sdk-common-SDK버전명.jar
,nelo2-android-sdk-thrift-SDK버전명.jar
파일 저장 - HTTPS 프로토콜 사용 시:
nelo2-android-sdk-common-SDK버전명.jar
,nelo2-android-sdk-https-SDK버전명.jar
파일 저장 - NELO SDK 0.9.0 버전부터 프로토콜에 따라 libs 폴더에 추가하는 라이브러리 파일이 다릅니다.
- <예시>
..... android { compileOptions { sourceCompatibility JavaVersion.VERSION_1_8 targetCompatibility JavaVersion.VERSION_1_8 } } ..... repositories{ flatDir{ dirs 'libs' } } ..... dependencies { implementation (name: 'nelo2-android-sdk-common', version: '0.12.0', ext: 'aar') implementation (name: 'nelo2-android-sdk-https', version: '0.12.0', ext: 'aar') implementation (name: 'nelo2-android-sdk-thrift', version: '0.12.0', ext: 'aar') implementation (name: 'tink-android', version: '1.4.0', ext: 'jar') } .....
- Thrift 프로토콜 사용 시:
3. Android SDK v1 초기화
Effective Log Search & Analytics 2.0 Android SDK는 다음 두 가지 방법으로 초기화할 수 있습니다.
- Main Activity에서 init 메서드 호출
- 앱 크래시 발생 시, Crash Dialog를 생성하지 않고 로그 전송
- <예시>
public class MainActivity extends Activity { ..... @Override protected void onCreate(Bundle savedInstanceState) { ..... NeloLog.init(getApplication(), "elsa-col.ncloud.com", 10006, "__프로젝트_아이디__", "__프로젝트버전__"); ..... } }
- Application에서 init 메서드 호출
- @NeloConf 애노테이션과 같이 사용
- 앱 크래시 발생 시, 설정에 따라 크래시 로그를 전송하는 Crash Dialog 출력
- <예시>
@NeloConf( collectorUrl = "elsa-col.ncloud.com", // Effective Log Search & Analytics 2.0 Collector URL (required) serverPort = Nelo2Constants.SERVER_PORT_THRIFT, // Effective Log Search & Analytics 2.0 Port Number (required) projectName = "72356c50401b8e20_testproject", // Effective Log Search & Analytics 2.0 Project ID (required) mode = CrashReportMode.DIALOG, // Effective Log Search & Analytics 2.0 CrashReportMode (optional, Default : SLIENT) sendMode = NeloSendMode.ALL, // Effective Log Search & Analytics 2.0 SendMode (optional, Default : ALL) debug = true, // Effective Log Search & Analytics 2.0 Debug mode (optional, Default : false) logSource = "elsa-android", // Effective Log Search & Analytics 2.0 Log Source (optional, Default : nelo2-android) logType = "development", // Effective Log Search & Analytics 2.0 Log Type (optional, Defalut : nelo2-log) resDialogText = R.string.crash_dialog_text, // Crash Report Doalog Text (required, if you set mode CrashReportMode.Dialog) resDialogTitle = R.string.crash_dialog_title // Crash Report Dolog Title (required, if you set mode CrashReportMode.Dialog) ) public class MainApplication extends Application { ..... @Override protected void onCreate() { ..... NeloLog.init(this); ..... } } .....
- 초기화 함수에 대한 자세한 내용은 초기화 API를 참고해 주십시오.
- Application에서 init 메서드를 호출하여 초기화하는 것을 권장합니다.
4. Android SDK v1 권한 추가
네트워크 상태, 디바이스 정보, 통신사, Logcat 등의 정보를 가져오기 위한 권한을 추가해야 합니다. AndroidManifest.xml 파일에 다음 내용을 추가해 주십시오.
.....
/** AndroidManifest.xml **/
<!-- Nelo 로그 전송을 위한 인터넷 접근 권한(필수) -->
<uses-permission android:name="android.permission.INTERNET"/>
<!-- Platform, Carrier 등 폰의 정보를 접근하기 위한 권한(필수) -->
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<!-- Network 접근 여부에 대하여 접근하기 위한 권한(필수) -->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<!-- Network에 접근되지 않는 경우, 파일로 data를 저장하기 위한 권한 -->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
.....
<!-- Crash Report Dialog를 사용하기 위하여 Application을 생성했다면 이름을 설정해야 함-->
<application ..... android:name="ApplicationName">
.....
<!-- Network 상태를 체크하여 WiFi 모드일 때만 로그를 보내기 위해서 추가되어야 하는 리시버 -->
<!-- SendMode를 All로 사용 시는 추가하지 않아도 됨 -->
<receiver android:name="com.nhncorp.nelo2.android.util.NetworkStatusReceiver">
<intent-filter>
<action android:name="android.net.conn.CONNECTIVITY_CHANGE"/>
</intent-filter>
</receiver>
.....
<!-- Crash Report Dialog를 사용하기 위한 Activity -->
<!-- CrashReportMode.DIALOG를 사용하지 않으면 추가하지 않아도 됨 -->
<activity android:name="com.nhncorp.nelo2.android.CrashReportDialog"
android:theme="@android:style/Theme.Dialog"
android:launchMode="singleInstance"
android:excludeFromRecents="true"
android:finishOnTaskLaunch="true" />
.....
5. SDK 사용
다음의 Effective Log Search & Analytics 2.0 Android SDK를 사용하는 실제 코드 예를 참고하여 프로젝트에 로그를 전송해 주십시오.
.....
import com.nhncorp.nelo2.android.NeloLog;
.....
public class MainActivity extends Activity {
.....
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
NeloLog.init(getApplication(),"ELSA-COLLECTOR-URL",10006,"ELSA-PROJECT-ID","PROJECT-VERSION");
NeloLog.debug("ErrorCode","Message","ErrorLocation"); // Send Debug Message
NeloLog.info("ErrorCode","Message","ErrorLocation"); // Send Info Message
NeloLog.warn("ErrorCode","Message","ErrorLocation"); // Send Warn Message
NeloLog.error("ErrorCode","Message","ErrorLocation"); // Send Error Message
NeloLog.fatal("ErrorCode","Message","ErrorLocation"); // Send Fatal Message
String nullString = null;
try{
nullString.toString();
}catch(Exception e){
NeloLog.crash(e,"ErrorCode","Message","ErrorLcoation"); // Send caught crash Message
}
NeloLog.debug("ErrorCode","Message","ErrorLocation"); // Send message with custom message
int i = 10 / 0; // Nelo send uncaught exception
}
.....
Android SDK v1 API 명세
Android SDK v1은 다음과 같은 API를 제공합니다.
초기화 API
Android SDK v1은 호출 방법에 따른 초기화 함수를 제공합니다.
- NeloLog를 사용하기 전에 NeloLog를 초기화해야 정상 동작합니다. 초기화는 1번만 실행합니다.
- Crash Report Dialog를 사용하기 위해서는 Application에서 초기화해야 합니다.
Main Activity에서 초기화
Main Activity에서 초기화하는 API는 다음과 같습니다.
static boolean init(Application application, String reportServer, int projectName, String appId, String projectVersion)
static boolean init(Application application, String reportServer, int projectName, String appId, String projectVersion, String userId)
각 파라미터에 대한 설명은 다음과 같습니다.
파라미터 | 설명 |
---|---|
Application application | Android의 application 정보
|
String reportServer | 로그 수집 서버의 주소
|
int serverPort | 로그 수집 서버의 포트 정보
|
String appId | 프로젝트 키(프로젝트 상세 정보에서 확인) |
String appVersion | 로그를 전송할 앱의 버전 정보 |
String userId | 전송할 사용자 아이디(옵션) |
<예시>
NeloLog.init(getApplication(), "elsa-col.ncloud.com", 10006, "72356c50401b8e20_testproject", "1.0.0");
Application에서 초기화
Application에서 초기화하는 API는 다음과 같습니다. 반드시 @NeloConf
애노테이션을 함께 입력해야 합니다.
boolean init (Application application)
각 파라미터에 대한 설명은 다음과 같습니다.
파라미터 | 설명 |
---|---|
Application application | Android의 애플리케이션 정보. 일반적으로 getApplication() 입력 |
<예시>
@NeloConf(
collectorUrl = "elsa-col.ncloud.com", // NELO Collector URL (required)
serverPort = Nelo2Constants.SERVER_PORT_THRIFT, // NELO Port Number (required)
projectName = "72356c50401b8e20_testproject", // NELO Project ID (required)
mode = CrashReportMode.DIALOG, // NELO CrashReportMode (optional, Default : SLIENT)
sendMode = NeloSendMode.ALL, // NELO SendMode (optional, Default : ALL)
debug = true, // NELO Debug mode (optional, Default : false)
logSource = "elsa-android", // NELO Log Source (optional, Default : nelo2-android)
logType = "development", // NELO Log Type (optional, Defalut : nelo2-log)
resDialogText = R.string.crash_dialog_text, // Crash Report Doalog Text (required, if you set mode CrashReportMode.Dialog)
resDialogTitle = R.string.crash_dialog_title // Crash Report Doalog Title (required, if you set mode CrashReportMode.Dialog)
)
public class MainApplication extends Application {
.....
@Override
protected void onCreate() {
.....
NeloLog.init(this);
.....
}
}
.....
System Field 설정 API
System Field 값을 설정하는 API는 다음과 같습니다. 설정한 값은 이후 보내는 모든 로그에서 동일하게 전달됩니다.
사용자 아이디 설정
사용자 아이디를 설정하는 API는 다음과 같습니다.
static void void setUserID(String userID)
각 파라미터에 대한 설명은 다음과 같습니다.
파라미터 | 설명 |
---|---|
String userID | 사용자 아이디 |
<예시>
NeloLog.setUserID("test");
로그 소스 정보 설정
로그 소스를 설정하는 API는 다음과 같습니다.
static void setLogSource(String logSource)
static void setLogSource(String instanceName, String logSource)
각 파라미터에 대한 설명은 다음과 같습니다.
파라미터 | 설명 |
---|---|
String logSource | 로그 소스(logSource) 정보 |
String instanceName | 동적 인스턴스 이름 |
<예시>
NeloLog.setLogSource("NELO2 Android SDK LogSource");
로그 유형 설정
로그 유형을 설정하는 API는 다음과 같습니다.
static void setLogType(String logType)
static void setLogType(String instanceName, String logType)
각 파라미터에 대한 설명은 다음과 같습니다.
파라미터 | 설명 |
---|---|
String logType | 로그 유형(logType) 정보 |
String instanceName | 동적 인스턴스 이름 |
<예시>
NeloLog.setLogType("NELO2 Android SDK LogType");
로그 전송 API
로그를 전송하는 API는 다음과 같습니다.
로그 레벨(logLevel)별로 함수를 사용합니다.
- 로그레벨(logLevel): Fatal, Error, Warn, Info, Debug
static void debug(String errorCode,String message,String location)
static void debug(String errorCode,String message)
static void info(String errorCode,String message,String location)
static void info(String errorCode,String message)
static void warn(String errorCode,String message,String location)
static void warn(String errorCode,String message)
static void error(String errorCode,String message,String location)
static void error(String errorCode,String message)
static void fatal(String errorCode,String message,String location)
static void fatal(String errorCode,String message)
각 파라미터에 대한 설명은 다음과 같습니다.
파라미터 | 설명 |
---|---|
String errorCode | NELO의 errorCode 필드에 매핑되는 값 |
String message | NELO의 body 에 매핑되는 값 |
String location | 로그가 발생한 위치 |
<예시>
NeloLog.error("test","테스트값","location");
NeloLog.debug("test 2","테스트값 ")
로그 전송 API(예외 포함)
예외 정보를 포함한 로그를 전송하는 API는 다음과 같습니다.
오류 로그 전송
예외 정보를 포함한 오류 로그를 전송하는 API는 다음과 같습니다.
로그 레벨(logLevel)별로 함수를 사용합니다.
- 로그레벨(logLevel): Fatal, Error, Warn, Info, Debug
static void debug(Throwable t, String errorCode,String message,String location)
static void debug(Throwable t, String errorCode,String message)
static void info(Throwable t, String errorCode,String message,String location)
static void info(Throwable t, String errorCode,String message)
static void warn(Throwable t, String errorCode,String message,String location)
static void warn(Throwable t, String errorCode,String message)
static void error(Throwable t, String errorCode,String message,String location)
static void error(Throwable t, String errorCode,String message)
static void fatal(Throwable t, String errorCode,String message,String location)
static void fatal(Throwable t, String errorCode,String message)
// 동적 인스턴스 로그 전송용
static void debugWithInstanceName(String instanceName, Throwable t, String errorCode, String message)
static void debugWithInstanceName(String instanceName, Throwable t, String errorCode, String message, String errorLocation)
static void infoWithInstanceName(String instanceName, Throwable t, String errorCode, String message)
static void infoWithInstanceName(String instanceName, Throwable t, String errorCode, String message, String errorLocation)
static void warnWithInstanceName(String instanceName, Throwable t, String errorCode, String message)
static void warnWithInstanceName(String instanceName, Throwable t, String errorCode, String message, String errorLocation)
static void errorWithInstanceName(String instanceName, Throwable t, String errorCode, String message)
static void errorWithInstanceName(String instanceName, Throwable t, String errorCode, String message, String errorLocation)
static void fatalWithInstanceName(String instanceName, Throwable t, String errorCode, String message)
static void fatalWithInstanceName(String instanceName, Throwable t, String errorCode, String message, String errorLocation)
각 파라미터에 대한 설명은 다음과 같습니다.
파라미터 | 설명 |
---|---|
Throwable t | 예외(Exception) 정보
|
String errorCode | NELO의 errorCode 필드에 매핑되는 값 |
String message | NELO의 body 에 매핑되는 값 |
String location | 로그가 발생한 위치
|
<예시>
try{
int a = 10 / 0;
} catch (Exception e) {
NeloLog.error(e,"Error_Code",e.getMessage());
}
크래시 로그 전송
예외 상황에서 예외 정보를 포함한 크래시 로그를 전송하는 API는 다음과 같습니다.
- 사용자가 크래시 함수를 호출하는 순간 크래시 로그와
DmpData
필드가 NELO로 전송됩니다. - 앱의 성능을 위해 필요한 경우에만 호출해 주십시오(권장).
static void crash(Throwable t, String errorCode,String message,String location)
static void crash(Throwable t, String errorCode,String message)
<예시>
try{
int a = 10 / 0;
} catch (Exception e) {
NeloLog.crash(e,"Error_Code",e.getMessage());
}
크래시 콜백 API
크래시 콜백 API 사용하여 크래시 발생 시 크래시 로그를 전송하기 전에 사용자가 정의한 함수를 호출할 수 있습니다. 크래시 콜백 API는 다음과 같습니다.
static void setNeloCrashCallback(NeloCrashCallback neloCrashCallback)
각 파라미터에 대한 설명은 다음과 같습니다.
파라미터 | 설명 |
---|---|
NeloCrashCallback neloCrashCallback | 크래시 발생 시 호출되는 함수
|
<예시>
NeloLog.setNeloCrashCallback(new NeloCrashCallback() {
@Override
public boolean beforeSendNeloCrash() {
Log.e("[AndroidApp]", "______________[[ beforeSendNeloCrash ]]__________________");
return true;
}
@Override
public boolean beforeInstanceSendNeloCrash(String instanceName) {
Log.e("[AndroidApp]", "______________[[ beforeInstanceSendNeloCrash ] " + instanceName + "]__________________");
return Nelo2Constants.NELO_DEFAULT_INSTANCE_NAME.equalsIgnoreCase(instanceName);
}
@Override
public void finishInstanceSendNeloCrash(String instanceName) {
Log.e("[AndroidApp]", "______________[[ finishInstanceSendNeloCrash ] " + instanceName + "]__________________");
}
@Override
public void finishSendNeloCrash() {
Log.e("[AndroidApp]", "______________[[ finishSendNeloCrash ]]__________________");
}
});
옵션 설정 API
옵션 설정 API는 다음과 같습니다.
NELO 사용 여부 설정
NELO 사용 여부를 설정하는 API는 다음과 같습니다.
static boolean getNeloEnable()
static void setNeloEnable(boolean enabled)
각 파라미터에 대한 설명은 다음과 같습니다.
파라미터 | 설명 |
---|---|
boolean enabled | NELO 사용 여부 설정
|
Debug 모드 사용 여부 설정
Debug 모드를 사용하면 Logcat에 자세한 로그를 기록합니다. Debug 모드 사용 여부를 설정하는 API는 다음과 같습니다.
static boolean getDebug()
static void setDebug(boolean enabled)
각 파라미터에 대한 설명은 다음과 같습니다.
파라미터 | 설명 |
---|---|
boolean enabled | Debug 모드의 사용 여부
|
크래시 전송 방법 설정
크래시 전송 방법을 설정하는 API는 다음과 같습니다.
static CrashReportMode getCrashMode()
static void setCrashMode(CrashReportMode mode)
각 파라미터에 대한 설명은 다음과 같습니다.
파라미터 | 설명 |
---|---|
CrashReportMode mode | 앱 크래시 발생 시 크래시를 전송하는 방법 설정
|
로그 전송 방법 설정
로그 전송 방법을 설정하는 API는 다음과 같습니다.
static NeloSendMode getNeloSendMOde()
static void setNeloSendMOde(NeloSendMode mode)
각 파라미터에 대한 설명은 다음과 같습니다.
파라미터 | 설명 |
---|---|
NeloSendMode mode | 로그 전송 방법 설정 |
파라미터 설정값에 따른 네트워크별 로그 전송 방법은 다음과 같습니다.
ALL
네트워크 상태 전송 방법 3g 전송 Wi-Fi 전송 Not Connected 미전송, 파일 저장 ONLY_WIFI_WITH_FILE_SAVE
네트워크 상태 전송 방법 3g 미전송, 파일 저장 Wi-Fi 전송 Not Connected 미전송, 파일 저장 ONLY_WIFI_WITHOUT_FILE_SAVE
네트워크 상태 전송 방법 3g 미전송, 파일 저장 안 함 Wi-Fi 전송 Not Connected 미전송, 파일 저장 안 함
ONLY_WIFI_WITH_FILE_SAVE
또는 ONLY_WIFI_WITHOUT_FILE_SAVE
설정 시 네트워크 상태를 확인하기 위한 권한을 추가해야 합니다.(Android SDK v1 권한 추가 참고)
로그 저장 파일의 최대 크기 설정
로그 저장 파일의 최대 크기를 설정하는 API는 다음과 같습니다.
- 로그 저장 파일의 최대 크기의 기본값은 1 MB(1024 x 1024 byte)입니다.
- 저장되는 로그의 크기가 설정한 최댓값보다 크면, 지난 데이터를 삭제한 후 저장됩니다.
- 로그를 파일에 저장하도록 설정하는 방법은 로그 전송 방법 설정을 참고해 주십시오.
static int getMaxFileSize()
static void setMaxFileSize(int max_file_size)
static int getMaxFileSize(String instanceName)
static void setMaxFileSize(String instanceName, int max_file_size)
각 파라미터에 대한 설명은 다음과 같습니다.
파라미터 | 설명 |
---|---|
int max_file_size | 로그 저장 파일의 최대 크기 |
String instanceName | 동적 인스턴스 이름 |
대기열과 파일에 저장된 로그를 서버로 전송
대기열과 파일에 임시 저장된 로그를 서버로 전송하는 API는 다음과 같습니다.
static void flush()
로그 저장 파일의 현재 크기 조회
현재 NELO 로그가 사용 중인 파일의 총 사이즈를 조회(리턴)하는 API는 다음과 같습니다.
static long getAllNeloSaveLogFileSize()
이전 파일의 서버 전송 여부 설정
이전 파일을 읽어서 서버로 전송할지 설정하는 API는 다음과 같습니다.
- 파일명은
InstanceName
과 프로젝트명을 조합해 해시(hash)값으로 생성된 이름으로 사용합니다. - 프로젝트명과 인스턴스명이 변경되어 기존 파일을 삭제해야 하는 경우 이 함수를 호출해 주십시오.
flushFile
값이true
(기본값)인 경우에는 이전 파일을 삭제하기 전에 모든 내용을 읽어서 대기열에 저장해 주십시오.
static boolean clearSavedNeloLogFile(boolean flushFile)
각 파라미터에 대한 설명은 다음과 같습니다.
파라미터 | 설명 |
---|---|
boolean flushFile | 이전 파일을 읽어서 서버로 전송할지 여부를 결정 |
로그 레벨(loglevel) 설정
로그 레벨(loglevel) 이상의 로그만 전송하는 API는 다음과 같습니다.
- 기본값은
Nelo2LogLevel.DEBUG
입니다. crash
또는flush
같이 사용자가 명시적으로 로그를 서버로 전송 요청하는 경우는LogLevel
필터의 값을 무시합니다.
static Nelo2LogLevel getLogLevelFilter()
static void setLogLevelFilter(Nelo2LogLevel loglevel)
각 파라미터에 대한 설명은 다음과 같습니다.
파라미터 | 설명 |
---|---|
Nelo2LogLevel loglevel | loglevel 이상의 로그만 NELO로 전송 |