API 레퍼런스

SophonzSDK.init(config: SophonzSDKConfig): void

SophonzSDK.deinit(): void

// 계측 종료 예시
SophonzSDK.deinit();

SophonzSDK.inited: boolean

if (SophonzSDK.inited) {
  console.log('SophonzSDK is initialized');
}

SophonzSDK.stopSessionRecorder(): void

SophonzSDK.resumeSessionRecorder(): void

SophonzSDK.addAction(name: string, attributes?: Attributes): void

SophonzSDK.addAction('Form-Completed', {
  formId: 'signup-form',
  formName: 'Signup Form',
  formType: 'signup',
});

SophonzSDK.recordException(error: any, attributes?: Attributes): void

SophonzSDK.recordLog(message: string, attributes?: Record<string, string>): void

SophonzSDK.recordLog('API 사용량 초과', {
  userId: 'user_123',
  url: 'https://api.sophonz.com/usage',
})

userEvent: {
  start(name?: string, attributes?: Attributes): string;
  end(id: string, attributes?: Attributes): void;
  getActive(): UserEventInstance | undefined;
  cancel(id: string): void;
}

SophonzSDK.userEvent.start(name?: string, attributes?: Attributes): string

SophonzSDK.userEvent.end(id: string, attributes?: Attributes): void

SophonzSDK.userEvent.getActive(): UserEventInstance | undefined

SophonzSDK.userEvent.cancel(id: string): void

// 버튼 클릭 이벤트 추적
function handleButtonClick() {
  // 이벤트 시작
  const eventId = SophonzSDK.userEvent.start('button-click', {
    'button.name': 'submit',
    'page.url': window.location.href,
  });
 
  // 비즈니스 로직 실행
  performBusinessLogic()
    .then(result => {
      // 성공 시 이벤트 완료
      SophonzSDK.userEvent.end(eventId, {
        'action.result': 'success',
        'items.count': result.count,
      });
    })
    .catch(error => {
      // 에러 시 이벤트 완료
      SophonzSDK.userEvent.end(eventId, {
        'action.result': 'error',
        'error.message': error.message,
      });
    });
}
 
// 폼 제출 이벤트 추적
function handleFormSubmit() {
  const eventId = SophonzSDK.userEvent.start('form-submission', {
    'form.type': 'contact',
    'form.fields': 'name,email,message',
  });
 
  try {
    validateForm();
    submitForm();
 
    SophonzSDK.userEvent.end(eventId, {
      'submission.result': 'success',
    });
  } catch (error) {
    SophonzSDK.userEvent.end(eventId, {
      'submission.result': 'error',
      'error.type': error.constructor.name,
    });
    throw error;
  }
}
 
// 이벤트 취소 예시
function handleCancellableOperation() {
  const eventId = SophonzSDK.userEvent.start('file-upload');
 
  // 사용자가 취소한 경우
  if (userCancelled) {
    SophonzSDK.userEvent.cancel(eventId);
    return;
  }
 
  // 정상 처리
  uploadFile().then(() => {
    SophonzSDK.userEvent.end(eventId);
  });
}

SophonzSDK.setScreenAttribute(name: string): void

/**
 * `setScreenAttribute` 함수는 전달된 속성 값을 저장하고, 마지막 URL을 전역 변수에 기록합니다.
 *
 * @param {string} attribute - `attribute` 매개변수는 화면(screen)에 설정하고자 하는 속성을 나타내는 문자열입니다.
 */
function setScreenAttribute(attribute: string) {
  savedScreenAttribute = attribute;
  lastUrl = window?.location?.href;
}

SophonzSDK.enableAdvancedNetworkCapture(): void

SophonzSDK.disableAdvancedNetworkCapture(): void

SophonzSDK.setGlobalAttributes(attributes: Record<string, string>): void

SophonzSDK.setGlobalAttributes({
  teamName: "your-team-name",
  groupName: "your-group-name",
  // 기타 사용자 지정 속성...
});

SophonzSDK.getDeviceId(): string | null

// 디바이스 ID 조회
const deviceId = SophonzSDK.getDeviceId();
 
if (deviceId) {
  console.log('Device ID:', deviceId);
  // 디바이스 ID를 활용한 로직 수행
} else {
  console.log('웹뷰 환경이 아니거나 디바이스 ID를 조회할 수 없습니다.');
}

setUserIdAttribute(userId: string): void

window.SophonzSDK.setUserIdAttribute("_sophonz_user_0001");

getSessionId(): string | undefined

const sessionId = SophonzSDK.getSessionId();

getSessionUrl(): string | undefined

// ErrorBoundary를 가져옵니다 (react-error-boundary를 예제로 사용)
import { ErrorBoundary } from 'react-error-boundary';
 
// ErrorBoundary 컴포넌트에 연결하여 해당 컴포넌트 내에서 발생하는 모든 오류를 감지합니다.
SophonzSDK.attachToReactErrorBoundary(ErrorBoundary);

attachToReactErrorBoundary(errorBoundary: ErrorBoundaryComponent): void

// ErrorBoundary 가져오기 (예시로 react-error-boundary를 사용)
import { ErrorBoundary } from 'react-error-boundary';
 
// ErrorBoundary 컴포넌트에 연결하여 모든 인스턴스에서 발생하는 오류를 캡처합니다.
SophonzSDK.attachToReactErrorBoundary(ErrorBoundary);

SophonzSDK.getServiceStatus(): ServiceStatusResponse | null

interface ServiceStatusResponse {
  isCollecting: boolean;    // 계측 수집 활성화 여부
  dropPolicy: boolean;      // Drop Policy 활성화 여부
  targetDropCount: number;  // 실패 임계값
  token: string;            // 서버에서 발급한 토큰
}
 
// 사용 예시
const status = SophonzSDK.getServiceStatus();
if (status) {
  console.log('Is collecting:', status.isCollecting);
  console.log('Drop policy enabled:', status.dropPolicy);
  console.log('Target drop count:', status.targetDropCount);
}

SophonzSDK.recordExporterFailure(): boolean

// 커스텀 Exporter에서 실패 시 호출
const shouldStop = SophonzSDK.recordExporterFailure();
if (shouldStop) {
  console.log('Threshold reached, instrumentation stopped');
}

SophonzSDK.recordExporterSuccess(): void

var cors = require('cors');
var onHeaders = require('on-headers');
 
// ... 기타 코드
 
app.use(function (req, res, next) {
  onHeaders(res, function () {
    var allowOrigin = res.getHeader('Access-Control-Allow-Origin');
    if (allowOrigin) {
      res.setHeader('Timing-Allow-Origin', allowOrigin);
    }
  });
  next();
});
app.use(cors());