Audit Log JSON Schema

Enterprise 플랜에서 사용 가능

이 기능은 레거시 Mattermost Enterprise Edition E20에서도 사용할 수 있습니다.

오디트 로그 JSON 스키마는 단일 이벤트가 오디트 로그에 기록될 때 나타나는 방식을 일관되게 정의하는 표준화된 청사진 또는 도표로 작용합니다. 이는 필드 이름, 데이터 유형, 객체 및 구조를 포함합니다.

JSON 오디트 로깅 스키마 개요는 아래에 제공됩니다. 추가 세부 정보는 JSON 데이터 모델 을 참조하세요.

{
    "timestamp": "",       // 이벤트 시간
    "status": "",          // 검토된 이벤트나 활동의 성공 또는 실패
    "event_name": "",      // 로그된 이벤트 이름
    "error": {             // 상태가 실패일 경우 에러
        "status_code": 0,
        "description": ""
    },
    "actor": {             // 작업을 수행하는 사용자
        "user_id": ""           // 이벤트 사용자의 고유 식별자
        "session_id": ""        // 이벤트 사용자의 고유 세션 식별자
        "client": ""            // 이벤트 사용자가 사용하는 클라이언트/플랫폼의 사용자 에이전트
        "ip_address": ""        // 이벤트 사용자의 IPv4/IPv6 IP 주소
    },
    "event": {             // 이벤트별 데이터
        "parameters": {}        // 검토된 이벤트나 활동의 매개변수를 포함하는 맵
        "prior_state": {}       // 객체의 이전 상태
        "resulting_state": {}   // 객체의 후속 상태
        "object_type": ""       // 이벤트나 활동의 대상이 되는 객체
    },
    "meta": {
        "api_path": "",         // 이벤트나 활동에 상호 작용하는 API 엔드포인트
        "cluster_id": ""        // 이벤트 사용자가 사용하는 클러스터의 고유 식별자
    }
}

오디트 로그 레코드 예시

사용자 환경 설정 업데이트

{
    "timestamp": "2022-08-17 20:37:52.846 +01:00",
    "event_name": "updatePreferences",
    "status": "success",
    "actor": {
        "user_id": "aw8ehkwaziytzry1qqxi9tsqwh",
        "session_id": "kth3jyadc3b1p84kbz6y3o75na",
        "client": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.6 Safari/605.1.15",
        "ip_address": "192.168.0.169"
    },
    "event": {
        "parameters": {},
        "prior_state": {},
        "resulting_state": {},
        "object_type": ""
    },
    "meta": {
        "api_path": "/api/v4/users/aw8ehkwaziytzry1qqxi9tsqwh/preferences",
        "cluster_id": "8dxdbfx6fpdwtki1z6n8whtkho"
    },
    "error": {}
}

JSON 데이터 모델

이름	유형	설명
timestamp	int64	이벤트 또는 활동이 발생한 날짜/시간입니다. 현재 Mattermost에서는 세 가지 로그 형식을 지원합니다: plain, JSON 및 GELF 입니다. Plain 로그 형식은 기본적으로 RFC3339 를 사용합니다. 지원되는 옵션에 대한 자세한 내용은 plain log format configuration options 문서를 참조하세요. JSON 로그 형식은 기본적으로 RFC3339 를 사용합니다. 지원되는 옵션에 대한 자세한 내용은 JSON log format configuration options 문서를 참조하세요. GELF 로그 형식은 unixtime 을 사용합니다. 지원되는 옵션에 대한 자세한 내용은 GELF log format configuration options 문서를 참조하세요.
event_name	문자열	발생하는 이벤트 유형의 고유한 이름과 식별자입니다 (예: `getLogs` `requestRenewalLink`, `createTeam`, `createChannel`, `deleteChannel`, 또는 `extendSessionExpiry`).
status	문자열	감사된 이벤트의 성공 또는 실패입니다.
event	EventData	이벤트 매개변수 및 개체 상태입니다.
actor	EventActor	이벤트에 관련된 사용자입니다.
meta	EventMeta	관련된 이벤트 메타데이터입니다.
error	EventError	상태가 실패한 경우 결과 오류입니다.

EventData

필드 이름	데이터 유형	설명
parameters	맵	요청의 일부로 처리되는 페이로드 및 매개변수입니다.
prior_state	맵	수정되는 엔티티의 이전 상태입니다. 이전 상태가 없는 경우 ‘null’ 입니다.
resulting_state	맵	생성하거나 수정한 후 생성된 엔티티입니다.
object_type	문자열	엔티티 유형의 문자열 표현입니다(예: 게시물).

EventActor

필드 이름	데이터 유형	설명
user_id	문자열	이벤트 액터의 고유 식별자입니다.
session_id	문자열	이벤트 액터의 고유 세션 식별자입니다.
client	문자열	이벤트 액터가 사용하는 클라이언트/플랫폼의 사용자 에이전트입니다.
ip_address	문자열	이벤트 액터의 IPv4/IPv6 IP 주소입니다.

EventMeta

필드 이름	데이터 유형	설명
api_path	문자열	이벤트를 발생시킨 REST 엔드포인트입니다.
cluster_id	정수	클러스터 식별자입니다.

EventError

필드 이름	데이터 유형	설명
description	문자열	(선택 사항) 오류 설명입니다.
status_code	정수	(선택 사항) 오류 상태 코드입니다.

Mattermost 원문 보기