Event Specification

이벤트 로그 파일

이벤트 모니터링을 활성화 하면 설정에서 지정한 디렉로리에 events.log로 이벤트 로그 파일이 생성되며 events.log.YYYYMMDD 형식으로 daily rolling이 됩니다.

이벤트 로그 파일 예제

{"time":"2025-03-26T05:21:46.315+00:00","level":"Info","category":"StreamEvent","type":"StreamCreated","sourceId":"#default#app/push_rtmp","summary":"Stream created. Id: 103, StreamType: Rtmp, SourceUrl: TCP://172.17.0.1:44004"}
{"time":"2025-03-26T05:21:46.316+00:00","level":"Info","category":"StreamEvent","type":"StreamPrepared","sourceId":"#default#app/push_rtmp","summary":"Stream prepared. Id: 103, StreamType: Rtmp, SourceUrl: TCP://172.17.0.1:44004","snapshot":{"createdTime":"2025-03-26T05:21:46.315+00:00","name":"push_rtmp","sourceType":"Rtmp","sourceUrl":"TCP://172.17.0.1:44004","tracks":[{"id":0,"name":"Video","type":"Video","video":{"bitrate":"2500000","bitrateAvg":"0","bitrateConf":"2500000","bitrateLatest":"128503","bypass":false,"codec":"H264","deltaFramesSinceLastKeyFrame":0,"framerate":30.0,"framerateAvg":0.0,"framerateConf":30.0,"framerateLatest":0.0,"hasBframes":false,"height":1080,"keyFrameInterval":1.0,"keyFrameIntervalAvg":1.0,"keyFrameIntervalConf":0.0,"keyFrameIntervalLatest":0.0,"width":1920}},{"audio":{"bitrate":"160000","bitrateAvg":"0","bitrateConf":"160000","bitrateLatest":"-795170153","bypass":false,"channel":2,"codec":"AAC","samplerate":48000},"id":1,"name":"Audio","type":"Audio"},{"id":2,"name":"Data","type":"Data"}]}}
{"time":"2025-03-26T05:21:46.319+00:00","level":"Info","category":"StreamEvent","type":"PushPublishingStarted","sourceId":"#default#app/push_rtmp","summary":"PushPublishing started. Id: JwW9AM, Protocol: rtmp, Url: rtmp://192.168.0.234:52935/app/pushedRtmp, StreamKey: ","snapshot":{"app":"app","createdTime":"2025-03-26T05:21:46.319+00:00","finishTime":"1970-01-01T00:00:00.000+00:00","id":"JwW9AM","isConfig":true,"protocol":"rtmp","sentBytes":0,"sentTime":0,"sequence":0,"startTime":"1970-01-01T00:00:00.000+00:00","state":"ready","stream":{"name":"push_rtmp","trackIds":[],"variantNames":["video_h264_1080p","aac_audio"]},"totalsentBytes":0,"totalsentTime":0,"url":"rtmp://192.168.0.234:52935/app/pushedRtmp","vhost":"default"}}
{"time":"2025-03-26T05:21:47.114+00:00","level":"Info","category":"StreamEvent","type":"StreamCreated","sourceId":"#default#app/pushedRtmp","summary":"Stream created. Id: 104, StreamType: Rtmp, SourceUrl: TCP://172.17.0.1:48218"}
{"time":"2025-03-26T05:21:47.129+00:00","level":"Info","category":"StreamEvent","type":"StreamPrepared","sourceId":"#default#app/pushedRtmp","summary":"Stream prepared. Id: 104, StreamType: Rtmp, SourceUrl: TCP://172.17.0.1:48218","snapshot":{"createdTime":"2025-03-26T05:21:47.114+00:00","name":"pushedRtmp","sourceType":"Rtmp","sourceUrl":"TCP://172.17.0.1:48218","tracks":[{"id":0,"name":"Video","type":"Video","video":{"bitrate":"4906000","bitrateAvg":"0","bitrateConf":"4906000","bitrateLatest":"1059802151","bypass":false,"codec":"H264","deltaFramesSinceLastKeyFrame":0,"framerate":30.0,"framerateAvg":0.0,"framerateConf":30.0,"framerateLatest":0.0,"hasBframes":false,"height":1080,"keyFrameInterval":0.0,"keyFrameIntervalAvg":0.0,"keyFrameIntervalConf":0.0,"keyFrameIntervalLatest":0.0,"width":1920}},{"audio":{"bitrate":"125000","bitrateAvg":"0","bitrateConf":"125000","bitrateLatest":"1059802151","bypass":false,"channel":2,"codec":"AAC","samplerate":48000},"id":1,"name":"Audio","type":"Audio"},{"id":2,"name":"Data","type":"Data"}]}}

이벤트 로그 JSON

이벤트 로그는 이벤트의 정보를 JSON형태로 기록하며 각 필드의 의미는 다음과 같습니다.

field	optional	description
time	N	이벤트가 발생한 시간을 ISO 8601 포맷으로 기록합니다.
level	N	이벤트의 레벨을 기록합니다.
category	N	이벤트의 대분류를 기록합니다. 대분류로는 서버 이벤트, 가상호스트 이벤트, 애플리케이션 이벤트, 스트림 이벤트, Rest API 호출 이벤트, 접근 제어 이벤트가 있습니다.
type	N	이벤트의 종류를 기록합니다. 이벤트 카테고리에 따른 이벤트 타입들은 이벤트 카테고리 및 타입 섹션에서 확인할 수 있습니다.
sourceId	N	이벤트를 발생시킨 소스의 아이디를 기록합니다. 소스의 타입은 서버, 가상호스트, 애플리케이션, 스트림이 있습니다.
summary	N	이벤트의 내용을 한줄로 요약해 기록합니다.
cause	Y	특정 이벤트들은 이벤트 발생 원인을 기록합니다.
snapshot	Y	특정 이벤트들은 발생 시점의 상세한 정보를 JSON형식으로 기록합니다.

이벤트 레벨

이벤트는 심각도에 따라 다음과 같은 레벨로 분류됩니다.

• Trace: 기능 동작의 상세한 흐름을 확인하기 위한 이벤트

• Debug: 기능 동작 및 상태 변경에 대한 상세 정보를 확인하기 위한 이벤트

• Info: 일반적인 기능 동작 및 상태 변경시 발생하는 이벤트 (대부분의 이벤트)

• Warning: 오류 상황이기는 하지만, 기능 동작에 영향을 미치지는 않는 상황에 발생하는 이벤트

• Error: 심각한 문제나 기능 오작동시 발생하는 이벤트

이벤트 소스 아이디

이벤트를 발생시킨 소스의 출처를 확인 할 수 있는 URI 형식으로 표현된 아이디입니다. 소스의 타입별로 다음과 같이 아이디의 형태가 달라 질 수 있습니다.

• 서버: OvenMediaEngine 서버 아이디가 기록됩니다. (예: 6add8be3-181f-4c4b-bc4e-xxxxxxxxxxxx)

• 가상호스트: 가상호스트의 이름이 기록됩니다. (예: default)

• 애플리케이션: #{virtual_host_name}#{app_name} 형식으로 기록됩니다. (예: #default#app)

• 스트림: #{virtual_host_name}#{app_name}/{stream_name} 형식으로 기록됩니다. (예: #default#app/stream)

이벤트 카테고리 및 타입

이벤트 로그는 카테고리 및 타입으로 분류됩니다.

모니터링을 위한 이벤트 카테고리와 타입은 지속적으로 추가될 예정입니다.

서버 이벤트 (ServerEvent)

이벤트 타입	설명	이벤트 레벨	스냅샷 내용
ServerStarted	서버 시작 이벤트 (서버 이름, 서버 버전)	Info	서버 구성 정보

가상호스트 이벤트 (HostEvent)

이벤트 타입	설명	이벤트 레벨	스냅샷 내용
HostCreated	새 가상호스트 생성 (가상호스트 이름, distribution 이름)	Info	가상호스트 세부 정보
HostDeleted	가상호스트 삭제 (삭제된 가상호스트의 이름, distribution 이름)	Info	N/A

애플리케이션 이벤트 (AppEvent)

이벤트 타입	설명	이벤트 레벨	스냅샷 내용
AppCreated	새 애플리케이션 생성 (애플리케이션 이름)	Info	애플리케이션 세부정보
AppDeleted	애플리케이션 삭제 (삭제된 애플리케이션 이름)	Info	N/A

스트림 이벤트 (StreamEvent)

이벤트 타입 (발생 원인)	설명	이벤트 레벨	스냅샷 내용
StreamCreated	새 스트림 생성 (스트림 ID, 타입, 미디어 소스)	Info	N/A
StreamPrepared	스트림 준비 완료 (스트림 ID, 타입, 미디어 소스)	Info	스트림 세부정보
StreamDeleted	스트림 삭제 (스트림 ID, 타입, 미디어 소스)	Info	N/A
StreamCreationFailed (DuplicatedStreamName)	중복된 스트림명으로 인한 스트림 생성 실패 (중복된 스트림 이름)	Error	N/A
AbnormalStreamDetected (BFrameDetected)	B-Frame 감지 (트랙 정보)	Warning	트랙 정보
AbnormalStreamDetected (AbnormalIncreasedTimestamp)	입력 스트림의 타임스탬프 이상 (트랙 정보)	Warning	트랙 정보
ScheduledChannelCreated	스케쥴 채널 생성 (sch 파일 경로)	Info	스케줄 채널 정보
ScheduledChannelUpdated	스케쥴 채널 업데이트 (sch 파일 경로)	Info	스케줄 채널 정보
ScheduledChannelDeleted	스케쥴 채널 삭제 (sch 파일 경로)	Info	N/A
ScheduledChannelItemChanged	스케쥴 채널 아이템 변경 (프로그램, 스케줄, 아이템 정보, Fallback 여부)	Info	N/A
MultiplexChannelCreated	멀티플렉스 채널 생성 (mux 파일 경로)	Info	멀티플렉스 채널 정보
MultiplexChannelUpdated	멀티플렉스 채널 업데이트 (mux 파일 경로)	Info	멀티플렉스 채널 정보
MultiplexChannelDeleted	멀티플렉스 채널 삭제 (mux 파일 경로)	Info	N/A
RecordingStarted	녹화 시작 (녹화 ID, 녹화 파일 경로)	Info	녹화 정보
RecordingStopped	녹화 중지 (녹화 ID, 녹화 파일 경로)	Info	녹화 정보
PushPublishingStarted	푸시 퍼블리싱 시작 (푸시 ID, 프로토콜, 재송출 URL)	Info	푸시 정보
PushPublishingStopped	푸시 퍼블리싱 중지 (푸시 ID, 프로토콜, 재송출 URL)	Info	푸시 정보
HLSDumpStarted	HLS 덤프 시작 (덤프 ID, 덤프 저장 경로)	Info	덤프 정보
HLSDumpStopped	HLS 덤프 중지 (덤프 ID, 덤프 저장 경로)	Info	덤프 정보

REST API 이벤트 (RestApiEvent)

이벤트 타입	설명	이벤트 레벨	스냅샷 내용
RestApiRequested	REST API 요청 (HTTP 버전, 메서드, 경로, 원격 주소, RequestID)	Info	요청 본문
RestApiResponded	REST API 응답 (응답 상태 코드, RequestID)	Info (오류 시 Error)	응답 본문

접근 제어 이벤트 (AccessControlEvent)

이벤트 타입	설명	이벤트 레벨	스냅샷 내용
VerifyingSignedPolicyFailed	Signed Policy 검증 실패 (요청 URL, 원격 주소, 오류 메시지)	Error	N/A
VerifyingAdmissionWebhooksFailed	Admission Webhooks 검증 실패 (요청 URL, 원격 주소, 오류 메시지)	Error	응답 본문, N/A