Event Specification

Event Log File

When event logging is enabled, an event log file named events.log is created in the directory specified in the configuration and performs daily rolling in the format events.log.YYYYMMDD.

Event Log File Example

{"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"}]}}

Event Log JSON

Event logs record event information in JSON format, and the meaning of each field is as follows.

Field	Optional	Description
time	N	Records the time when the event occurred in ISO 8601 format.
level	N	Records the level of the event.
category	N	Records the major classification of the event. Major classifications are Server Events, Virtual Host Events, Application Events, Stream Events, Rest API Call Events, and Access Control Events.
type	N	Records the type of event. Event types according to event categories can be found in the Event Categories and Types section.
sourceId	N	Records the ID of the source that generated the event. Source types are Server, Virtual Host, Application, and Stream.
summary	N	Summarizes the content of the event in one line.
cause	Y	Certain events record the cause of the event occurrence.
snapshot	Y	Certain events record detailed information at the time of occurrence in JSON format.

Event Levels

Events are classified into the following levels according to severity.

Level	Description
Trace	Events for checking the detailed flow of functional operations.
Debug	Events for checking detailed information about functional operations and state changes.
Info	Events that occur during general functional operations and state changes (most events).
Warning	Events that occur in error situations but do not affect functional operation.
Error	Events that occur during serious problems or functional malfunctions.

Event Source IDs

An ID expressed in URI format that allows you to check the origin of the source that generated the event. The format of the ID may vary depending on the type of source as follows:

Source ID	Description
Server	The OvenMediaEngine server ID is stored. e.g.: 6add8be3-181f-4c4b-bc4e-xxxxxxxxxxxx
Virtual Host	The name of the virtual host is stored. e.g.: default
Application	#{virtual_host_name}#{app_name} format is stored. e.g.: #default#app
Stream	#{virtual_host_name}#{app_name}/{stream_name} format is stored. e.g.: #default#app/stream

Event Categories and Types

Event logs are classified by category and type.

Event categories and types for monitoring will be continuously added.

Server Events (ServerEvent)

Event Type	Description	Event Level	Snapshot
ServerStarted	Server start event (server name, server version)	Info	Server configuration information
InternalQueueCongestion	Internal queue congestion (queue information) Supported version: 0.18.1.2+	Info	N/A

Virtual Host Events (HostEvent)

Event Type	Description	Event Level	Snapshot
HostCreated	New virtual host creation (virtual host name, distribution name)	Info	Virtual host details
HostDeleted	Virtual host deletion (name of deleted virtual host, distribution name)	Info	N/A

Application Events (AppEvent)

Event Type	Description	Event Level	Snapshot
AppCreated	New application creation (application name)	Info	Application details
AppDeleted	Application deletion (deleted application name)	Info	N/A

Stream Events (StreamEvent)

Event Type (Cause)	Description	Event Level	Snapshot
StreamCreated	New stream creation (Stream ID, type, media source)	Info	N/A
StreamPrepared	Stream preparation complete (Stream ID, type, media source)	Info	Stream details
StreamDeleted	Stream deletion (Stream ID, type, media source)	Info	N/A
StreamCreationFailed (DuplicatedStreamName)	Stream creation failure due to duplicated stream name (duplicated stream name)	Error	N/A
AbnormalStreamDetected (BFrameDetected)	B-Frame detection (track information)	Warning	Track information
AbnormalStreamDetected (AbnormalIncreasedTimestamp)	Abnormal timestamp in input stream (track information)	Warning	Track information
AbnormalStreamDetected (AbnormalFpsDetected)	Abnormal framerate in input stream (track information) Supported version: 0.18.1.2+	Warning	Track information
AbnormalStreamDetected (LongKeyFrameIntervalDetected)	Keyframe intervals greater than 4 seconds in input stream (input stream framerate, track information) Supported version: 0.18.1.2+	Warning	Track information
ScheduledChannelCreated	Scheduled channel creation (sch file path)	Info	Scheduled channel information
ScheduledChannelUpdated	Scheduled channel update (sch file path)	Info	Scheduled channel information
ScheduledChannelDeleted	Scheduled channel deletion (sch file path)	Info	N/A
ScheduledChannelItemChanged	Scheduled channel item change (program, schedule, item information, Fallback status)	Info	N/A
ScheduledChannelPlaybackError (FailedToPopPacket)	Packet reception failure when playing scheduled channel live item (program, schedule, item information, Fallback status) Supported version: 0.18.1.2+	Warning	N/A
MultiplexChannelCreated	Multiplex channel creation (mux file path)	Info	Multiplex channel information
MultiplexChannelUpdated	Multiplex channel update (mux file path)	Info	Multiplex channel information
MultiplexChannelDeleted	Multiplex channel deletion (mux file path)	Info	N/A
RecordingStarted	Recording start (recording ID, recording file path)	Info	Recording information
RecordingStopped	Recording stop (recording ID, recording file path)	Info	Recording information
PushPublishingStarted	Push publishing start (push ID, protocol, redistribution URL)	Info	Push information
PushPublishingStopped	Push publishing stop (push ID, protocol, redistribution URL)	Info	Push information
HLSDumpStarted	HLS dump start (dump ID, dump save path)	Info	Dump information
HLSDumpStopped	HLS dump stop (dump ID, dump save path)	Info	Dump information

REST API Events (RestApiEvent)

Event Type	Description	Event Level	Snapshot
RestApiRequested	REST API request (HTTP version, method, path, remote address, RequestID)	Info	Request body
RestApiResponded	REST API response (response status code, RequestID)	Info (Error in case of error)	Response body

Access Control Events (AccessControlEvent)

Event Type	Description	Event Level	Snapshot
VerifyingSignedPolicyFailed	Signed Policy verification failure (request URL, remote address, error message)	Error	N/A
VerifyingAdmissionWebhooksFailed	Admission Webhooks verification failure (request URL, remote address, error message)	Error	Response body, N/A