WEB 에이전트 API 연동을 통한 트래픽 제어

에이전트 연동 작업을 완료한 후, 제어 대상에 API 코드를 넣어 트래픽 제어 기능을 활성화 시키세요.

기본 제어

함수 안내

NFStart

• 적용 위치 : 페이지로 진입하는 부분의 html 코드에 적용합니다.
• 함수 내용 : 트래픽 제어를 적용하고 싶은 페이지에 함수를 적용하여 가상 대기실을 노출 시킬 수 있습니다.
• 종료 시점 : 함수의 콜백함수가 호출되면 종료됩니다. 이 때 진입 대상 페이지가 로드되는 시점에 대기 종료 함수(NFStop)를 사용하여 방문자에게 제공된 키를 반납받습니다.
• Parameter : 넷퍼넬 콘솔에서 기본 제어 메뉴에 생성한 세그먼트마다 할당된 키를 API Parameter에 입력합니다.
  • projectKey : 트래픽 제어를 위해 넷퍼넬에 등록한 프로젝트의 고유키입니다. 넷퍼넬 콘솔 사이드바에서 확인할 수 있습니다.
  • segmentKey : 트래픽 제어를 위해 넷퍼넬에 생성한 세그먼트의 고유키입니다. 넷퍼넬 콘솔 내 기본제어 메뉴에서 확인할 수 있습니다.
• Sample code

/*
* @param {object} projectKey, segmentKey
* @param {Function} success callback
*/
NFStart({
projectKey: '{프로젝트 키}',
segmentKey: '{세그먼트 키}'
}, function(response){
// TODO : 페이지 이동을 위한 로직을 구현합니다.
// Example : window.location.href = '{기본대기 후 진입 URL}';
});

NFStop

• 적용 위치 : 진입 후 서비스 페이지가 로드 되는 시점에 적용합니다.
• 함수 내용 : 트래픽 제어 대상으로 진입한 방문자에게 대기 시점에 NFStart 함수로 제공한 키 반납을 받습니다.
• Parameter : N/A
• Sample code

/*
* @param {object} empty
* @param {Function} success callback
*/
NFStop({}, function(response) {
// No additional logic or implementation is required in this callback function.
});

구간 제어

함수 안내

NFStartSection

• 적용 위치 : 구간 제어의 시작 페이지로 진입하는 부분
• 함수 내용 : 가상 대기실을 노출하여 페이지의 구간(시작 페이지 ~ 종료 페이지)에 머무는 트래픽에 대한 대기를 적용하고 싶은 시작 페이지(html)에 적용할 수 있습니다.
• 종료 시점 : 구간 제어 종료 함수(NFStopSection)를 사용하여 키를 반납하는 페이지에서 종료됩니다.
• Parameter : 넷퍼넬 콘솔의 구간 제어 탭에서 세그먼트를 생성 후 해당 키를 API Parameter에 입력 합니다.
  • projectKey : 트래픽 제어를 위해 넷퍼넬에 등록한 프로젝트의 고유키입니다. 넷퍼넬 콘솔 사이드바에서 확인할 수 있습니다.
  • segmentKey : 트래픽 제어를 위해 넷퍼넬에 생성한 세그먼트의 고유키입니다. 넷퍼넬 콘솔 내 구간 제어 메뉴에서 확인할 수 있습니다.
• Sample code

/* 
* @param {object} projectKey, segmentKey 
* @param {Function} success callback 
*/
NFStartSection({ 
projectKey: '{프로젝트 키}', 
segmentKey: '{세그먼트 키}' 
}, function(response){ 
// TODO : 구간대기의 시작페이지로 이동하는 로직을 구현합니다.
// Example : window.location.href = '{구간대기 후 Start URL}';
});

NFStopSection

• 적용 위치 : 구간 제어 종료 페이지에 진입했을 때 사용합니다.
• 함수 내용 : 구간 제어의 종료 페이지 진입 후 키 반납을 위해 사용합니다.
• Parameter : 넷퍼넬 콘솔의 구간 제어 탭에서 구간 제어 적용을 위해 생성 한 세그먼트의 키를 API Parameter에 입력 합니다.
  • projectKey : 트래픽 제어를 위해 넷퍼넬에 등록한 프로젝트의 고유키입니다. 넷퍼넬 콘솔 사이드바에서 확인할 수 있습니다.
  • segmentKey : 트래픽 제어를 위해 넷퍼넬에 생성한 세그먼트의 고유키입니다. 넷퍼넬 콘솔 내 구간 제어 메뉴에서 확인할 수 있습니다.
• Sample code

/*
* @param {object} projectKey, segmentKey
* @param {Function} success callback
*/
NFStopSection({
projectKey: '{프로젝트 키}',
segmentKey: '{세그먼트 키}'
}, function(response){
// No additional logic or implementation is required in this callback function.
});

테스트 방법

NetFUNNEL Web Agent가 잘 적용되었는지 확인하고 싶다면, 아래의 순서를 따라 진행해 주세요.

1. 기본/구간 제어 세그먼트의 진입 허용량을 '0'으로 설정
2. 웹 페이지 내 진입 요청
3. 대기실이 화면에 뜨는지 확인 (VWR 확인)
4. NetFUNNEL 콘솔 기본 제어 내 해당 세그먼트의 수치 변동이 있는지 확인
   
   • 명확한 확인을 위해 Classic View 상태에서 확인하는 것을 권장합니다.