JavaScript(Cordova, 웹) 애플리케이션에서 로깅

개요

이 학습서는 JavaScript(Cordova, 웹) 애플리케이션에 로깅 기능을 추가하는 데 필요한 필수 코드 스니펫을 제공합니다.

전제조건: 클라이언트 측 로그 콜렉션 개요를 읽으십시오.

로그 캡처 사용

로그 캡처는 기본적으로 사용됩니다. 로그 캡처는 클라이언트에 로그를 저장하며 프로그래밍 방식으로 사용 또는 사용 안함으로 설정될 수 있습니다. 로그는 명시적 전송 호출 또는 자동 로그를 사용하여 서버로 전송됩니다.

참고: 상세 레벨에서 로그 캡처를 사용하도록 설정하면 클라이언트가 네트워크를 통해 로그를 전송하는 경우 디바이스 CPU 이용량, 파일 시스템 공간 및 페이로드 크기에 영향을 줄 수 있습니다.

로그 캡처를 사용 안함으로 설정하려면 다음을 수행하십시오.

Cordova

WL.Logger.config({capture: false});

웹

ibmmfpfanalytics.logger.enable(false);

캡처된 로그 전송

애플리케이션 로직에 따라 MobileFirst에 로그를 전송하십시오. 자동 로그 전송을 사용하여 로그를 자동으로 전송할 수도 있습니다. 최대 크기에 도달하기 전에 로그가 전송되지 않으면 새 로그를 전송하도록 로그 파일이 제거됩니다.

참고: 로그 데이터를 수집할 때 다음 패턴을 채택하십시오. 일정한 간격으로 데이터를 전송하면 MobileFirst Analytics Console에 거의 실시간으로 로그 데이터가 표시됩니다.

Cordova 앱

캡처된 모든 로그가 전송되도록 하려면 다음 전략 중 하나를 고려하십시오.

• 일정한 시간 간격으로 send 메소드를 호출합니다.
• 앱 라이프사이클 이벤트 콜백 내에서 send 메소드를 호출합니다.
• 지속적 로그 버퍼의 최대 파일 크기(바이트)를 늘립니다.

  setInterval(function() {
    WL.Logger.send();
  }, 60000);
  

WL.Logger.config({ maxFileSize: 150000 });

웹 앱

setInterval(function() {
   ibmmfpfanalytics.logger.send();
}, 60000);

웹 API의 최대 파일 크기는 5MB이며 변경할 수 없습니다.

자동 로그 전송

자동 로그 전송은 기본적으로 사용됩니다. 올바른 자원 요청이 서버에 전송될 때마다 전송 간에 최소 60초의 간격을 두고 캡처된 로그도 전송됩니다. 클라이언트에서 자동 로그 전송을 사용 또는 사용 안함으로 설정할 수 있습니다. 자동 로그 전송은 기본적으로 사용됩니다.

Cordova 앱의 경우

사용으로 설정하려면 다음을 수행하십시오.

WL.Logger.config({autoSendLogs: true});

사용 안함으로 설정하려면 다음을 수행하십시오.

WL.Logger.config({autoSendLogs: false});

웹 앱의 경우

사용으로 설정하려면 다음을 수행하십시오.

ibmmfpfanalytics.enableAutoSend(true);

사용 안함으로 설정하려면 다음을 수행하십시오.

ibmmfpfanalytics.enableAutoSend(false);

autoSendLog 간격 변경

기본적으로, autoSendLog 간격은 60초로 설정됩니다. AutoSendLog 간격은 다음 방법을 사용하여 변경할 수 있습니다.

Cordova 앱의 경우

autoSendLog 간격을 120초로 설정하려면 다음 스니펫을 참조하십시오.

WL.Logger.config({autoSendLogs: true,autoSendLogsInterval: 120});

웹 앱의 경우

autoSendLog 간격을 120초로 설정하려면 다음 스니펫을 참조하십시오.

ibmmfpfanalytics.enableAutoSend(true, 120);

로거 API를 사용한 미세 튜닝

MobileFirst 클라이언트 SDK는 로거 API를 내부적으로 사용합니다. SDK에서 작성하는 로그 항목은 기본적으로 캡처됩니다. 로그 콜렉션을 미세 튜닝하려면 로거 인스턴스를 패키지 이름과 함께 사용하십시오. 서버 측 필터를 사용하여 분석을 통해 캡처할 로깅 레벨을 제어할 수도 있습니다.

예를 들어 패키지 이름 myApp에 대해 레벨이 ERROR인 로그만 캡처하려면 다음 단계를 수행하십시오.

Cordova 앱 미세 튜닝

1. WL.Logger 인스턴스를 패키지 이름 myApp과 함께 사용하십시오.

   var logger = WL.Logger.create({ pkg: 'MyApp' });
   

2. 선택사항: 로그 캡처 및 로그 출력을 프로그래밍 방식으로 지정된 레벨 및 패키지로만 제한하는 필터를 지정하십시오.

   WL.Logger.config({
        filters: {
            'MyApp': 'ERROR'
        }
   });
   

3. 선택사항: 서버 구성 프로파일을 페치하여 원격으로 필터를 제어하십시오.

웹 앱

웹 SDK의 경우 클라이언트가 레벨을 설정할 수 없습니다. 서버 구성 프로파일을 검색하여 구성이 변경될 때까지 모든 로깅이 서버에 전송됩니다.

서버 구성 프로파일 페치

로깅 레벨은 클라이언트가 설정하거나 서버에서 구성 프로파일을 검색하여 설정할 수 있습니다. MobileFirst Analytics Console에서 로그 레벨을 글로벌로 설정하거나(모든 로거 인스턴스) 특정 패키지에 대해 설정할 수 있습니다. MobileFirst Analytics Console에서 필터를 구성하는 데 대한 정보는 로그 필터 구성을 참조하십시오. 클라이언트가 서버에 설정된 구성 대체를 페치하려면 앱 라이프사이클 콜백과 같이 정기적으로 실행되는 코드의 한 위치에서 updateConfigFromServer 메소드를 호출해야 합니다.

Cordova 앱에 대한 서버 구성 프로파일 페치

WL.Logger.updateConfigFromServer();

웹 앱에 대한 서버 구성 프로파일 페치

ibmmfpfanalytics.logger.updateConfigFromServer();

로깅 예제

브라우저 JavaScript 콘솔, LogCat 또는 Xcode 콘솔에 대한 출력

예제 Cordova 로깅

var MathUtils = function(){
   var logger = WL.Logger.create({pkg: 'MathUtils'});
   var sum = function(a, b){
      var sum = a + b;
      logger.debug('sum called with args ' + a + ' and ' + b + '. Returning ' + sum);
      return sum;
   };
}();

예제 웹 로깅

웹 애플리케이션을 사용하는 로깅의 경우 앞의 예제를 사용하십시오.

var logger = WL.Logger.create({pkg: 'MathUtils'});

앞의 예제를 다음과 같이 바꾸십시오.

var logger = ibmmfpfanalytics.logger.create({pkg: 'MathUtils'});