Business Events

APIGWD and CTRLD send different GELF messages about status changes or progress of processes to a GELF endpoint.

GELF message format
Name	Type	Mandatory	Description
Default Message Fields
version	String	Yes	The GELF message format version. Default value: 1.1
host	String	Yes	The hostname assigned via DHCP to the management interface. Defaults to the management IP address if no hostname is assigned.
level	int	Yes	Message Severity. See Table-1.
timestamp	float	Yes	Unix epoch time in second with optional fraction of milliseconds.
short_message	String	Yes	Problem message.
full_message	String	No	Detailed problem description.
_daemon	String	Yes	Name of the daemon.
_log_module	String	Yes	The module name identifies the component that created the log record. It allows segregating log records into different streams. Each stream can apply different processing rules and also be processed by different organizational units of the network operator.
_log_event	String	Yes	The log event identifies the log message template in the log configuration. The log event simplifies to find where in the system the log record was created. The log event should be succinct and typically conveys a unique reason code. In addition, the log event should be a reference that can be looked up in the product troubleshooting guide.
_serial_number	String	Yes	The serial number of the switch. This allows tracking hardware replacements, even if the element name remains the same. Empty if not available.
_rtb_image_version	String	No	ONL Image Version that is installed on the switch that reports this message.
ZTP Message Fields
_config_name	String	No	Exposes the loaded configuration name. Only set when a configuration file was processed or an attempt to process the file failed (e.g. 404 Not Found response from the HTTP server while attempting to load the configuration)
_config_sha1	String	No	Exposes the SHA1 checksum of the loaded configuration. Only set when the HTTP server returned a configuration.
_operational_state	String	No	Exposes the operational state of the element.
Request Message Fields
_rid	String	No	Request ID, either `X-Request-ID` or new generated
_user_name	String	No	User name out of the access token
_user_subject	String	No	User subject out of the access token
_received_time	String	No	Time when the requested arrived
_method	String	No	HTTP method
_url	String	No	HTTP url
*proto*	String	No	HTTP protocol
_remote_ip	String	No	HTTP remote ip address
Service State Message Fields
_service_name	String	No	Service name
_service_operational_state	String	No	Operational Service
_service_startup_time	Number	No	Service startup time in unix epoch time, the number of seconds elapsed since January 1, 1970 UTC.
_service_down_flap_time	Number	No	Last down flap time in unix epoch time, the number of seconds elapsed since January 1, 1970 UTC.
_service_down_flap_counter	Number	No	Last down flap time in unix epoch time, the number of seconds elapsed since January 1, 1970 UTC.
_service_restarted	String	No	Restart is set to true if `service_startup_time` was changed.

Level Descriptions as in RFC 5424
Level	Name	Comment
0	Emergency	System is unusable
1	Alert	Action must be taken immediately
2	Critical	Critical conditions
3	Error	Error conditions
4	Warning	Warning conditions
5	Notice	Normal but significant condition
6	Informational	Informational messages
7	Debug	Debug-level messages

GELF sample message

{
  "_config_name": "ctrld",
  "_config_sha1": "f1e06ef1e53becde6f8baf2b2fafe7dc9c36f6f0",
  "_daemon": "ctrld",
  "_element_name": "leaf01",
  "_log_event": "ZTP0011I",
  "_log_module": "ztp",
  "_serial_number": "591654XK1902037",
  "host": "leaf01",
  "level": 6,
  "short_message": "ztp ctrld config set",
  "timestamp": 1588382356.000511,
  "version": "1.1"
}

Event Types
Instance	severity	log_module	log_event	description
ztp	Notice	ztp	ZTP0011I	ztp ctrld config set
ztp	Warn	ztp	ZTP0012W	ztp ctrld config not provided
ztp	Alert	ztp	ZTP0013E	ztp ctrld config not set
ztp	Notice	ztp	ZTP0021I	ztp startup config set
ztp	Warn	ztp	ZTP0022W	ztp startup config not provided
ztp	Alert	ztp	ZTP0023E	ztp startup config not set
ztp	Notice	ztp	ZTP0031I	ztp element config set
ztp	Warn	ztp	ZTP0032W	ztp element config not provided
ztp	Alert	ztp	ZTP0033E	ztp element config not set
ztp	Notice	ztp	ZTP0041I	ztp ctrld rbac config set
ztp	Warn	ztp	ZTP0042W	ztp ctrld rbac config not provided
ztp	Alert	ztp	ZTP0043E	ztp ctrld rbac config not set
ztp	Notice	ztp	ZTP0051I	ztp tls config set
ztp	Warn	ztp	ZTP0052W	ztp tls config not provided
ztp	Alert	ztp	ZTP0053E	ztp tls config not set
ztp	Notice	ztp	ZTP0061I	ztp accessjwks config set
ztp	Warn	ztp	ZTP0062W	ztp accessjwks config not provided
ztp	Alert	ztp	ZTP0063E	ztp accessjwks config not set
ztp	Notice	ztp	ZTP0071I	ztp apigwd config set
ztp	Warn	ztp	ZTP0072W	ztp apigwd config not provided
ztp	Alert	ztp	ZTP0073E	ztp apigwd config not set
ztp	Notice	ztp	ZTP1000I	ztp process finished
security	Warn	security	SEC0001W	access forbidden
security	Warn	security	SEC0002W	access invalid rtb token
security	Warn	security	SEC0003W	access invalid access token
security	Warn	security	SEC0004W	not able to download remote keys
security	Warn	security	SEC0005W	not able to download remote pem
security	Warn	security	SEC0006W	request rate limited (this message is also rate limited, and can be controlled in the apiwd config)
element	Notice	element	HTB0001	heartbeat with the `operational_state`
element	Notice	element	STA0001	element state change
element	Notice	element	STA0021	service up
element	Error	element	STA0022	service unexpected down
element	Notice	element	STA0023	service expected down
element	Notice	element	STA0003	ready for service
element	Notice	element	STA0031	module new (one of the modules is newly discovered e.g. fan, SFP …, this event will be fired after every reboot of ctrld)
element	Notice	element	STA0032	module changed (one of the modules got changed e.g. fan, SFP …)