activity-log

온라인에서 편집하기

‘활동 로그’ 정책을 사용하여 ‘ IBM® API Connect ’ 분석에 저장되는 API 활동에 대한 로깅 설정을 구성하세요. 지정한 환경 설정은 API 활동의 세부사항 수집 및 저장을 위한 기본 설정을 오버라이드합니다.

게이트웨이 지원

표 1. 이 정책을 지원하는 게이트웨이와 해당 정책 버전을 보여주는 표
게이트웨이 정책 버전
DataPower® Gateway (v5 compatible) 1.0.0

이 항목에서는 OpenAPI 소스에서 정책을 구성하는 방법을 설명합니다. 어셈블리 사용자 인터페이스에서 정책을 구성하는 방법에 대한 자세한 내용은 ‘활동 로그’를 참조하십시오.

참고: 을 DataPower API Gateway사용하는 경우, activity-log 확장 기능을 통해 로깅 설정을 구성할 수 있습니다.

정보

activity-log 정책의 형식은 다음과 같습니다.
- activity-log:
  version: version
  title: title
  description: description
  content: activity_to_log_if_call_successful
  error-content: activity_to_log_if_call_unsuccessful

execute 필드가 있는 assembly 확장자를 OpenAPI 정의 파일에 추가하여 이 정책을 적용하십시오.

또한 API Designer 어셈블리 편집기를 사용하여 API에 기본 제공 정책을 추가함으로써 activity-log 정책을 적용할 수도 있습니다. 자세한 내용은 기본 제공 정책 섹션의 ‘활동 로그’를 참조하십시오.

참고: 페이로드 로깅이 사용으로 설정된 경우 페이로드 버퍼링을 캡처하기 위한 게이트웨이도 사용으로 설정되어야 합니다.
activity-log:
  success-content: activity_to_log_if_call_successful
  error-content: activity_to_log_if_call_unsuccessful
  enabled: is_activity_logging_enabled
buffering: true

특성

다음 표에서는 정책 특성에 대해 설명합니다.
표 2. 활동 로그 정책 속성
특성 필수 설명 데이터 유형
version 예 정책 버전 번호입니다. 문자열
title 예 정책의 제목입니다. 문자열
description 아니오 정책의 설명입니다. 문자열
content 예 오퍼레이션에 성공할 때 로그되어야 하는 컨텐츠 유형을 정의합니다.
유효 값:
  • none: 로깅하지 않음을 표시합니다.
    제한 사항: 이 옵션을 선택하면 귀하의 소비자 카탈로그를 사용하는 애플리케이션 개발자에 대한 알림이 비활성화됩니다.
  • activity: 호출만 로깅합니다(자원 URI만 기록됨).
  • header: 활동과 헤더를 로깅합니다.
  • payload: 활동, 헤더 및 페이로드(존재하는 경우 원래 요청 및 최종 응답)를 로그합니다.

기본값은 activity입니다.

 문자열
error-content 아니오 오류가 발생하는 경우 로그할 컨텐츠를 표시합니다.
유효 값:
  • none: 로깅하지 않음을 표시합니다.
    제한 사항: 이 옵션을 선택하면 귀하의 소비자 카탈로그를 사용하는 애플리케이션 개발자에 대한 알림이 비활성화됩니다.
  • activity: 호출만 로깅합니다(자원 URI만 기록됨).
  • header: 활동과 헤더를 로깅합니다.
  • payload: 활동, 헤더 및 페이로드(존재하는 경우 원래 요청 및 최종 응답)를 로그합니다.

기본값은 payload입니다.

 문자열

예제 1

# use defaults

- activity-log:
  version: 1.0.0
  title: default activity logging

예제 2

- activity-log:
  version: 1.0.0
  title: no logging for successful calls
  content: none
  error-content: activity