|
Sonic Management API | |||||
| SUMMARY: OPERATIONS/ATTRIBUTES | NOTIFICATIONS | METRICS | DETAIL: OPERATIONS/ATTRIBUTES | NOTIFICATIONS | METRICS | |||||
This documentation describes the notifications that are exposed by a Agent component running within the Sonic Management environment.
A general description of notifications is provided in the overview.
Agent Metrics,
Agent Operations/Attributes
| Notifications Summary |
system.alert.system.memory.CurrentUsage
Alert for metric system.memory.CurrentUsage |
system.log.Failure
Failure to write to the container log file. |
system.log.LogMessage
Message has been logged to the container log. Note: The following will not generate this notification: initial container startup messages, final container shutdown messages, trace messages. |
system.log.Threshold
The size of the current container log has reached or exceeded (by a 10% increment) the configured threshold. |
system.security.ManagePermissionDenied
User has been denied permission to perform a management task. |
system.state.ContainerState
Update of container state |
system.state.Failover
Standby container has failed over to become the active container. |
system.state.Load
Component load completed. |
system.state.Online
Component start complete. |
system.state.Shutdown
Agent/Container shutdown initiated. |
system.state.Unload
Component unload completed. |
| Notifications Detail |
- Severity:
Level.INFO- Attributes:
Threshold- The threshold value that has been exceeded.ThresholdType- Indicates whether the threshold is a "high" or "low" threshold type.Units- The units of the value (if available, otherwise blank).Value- The value of the metric at the time the the threshold alert was generated.
- Severity:
Level.SEVERE- Attributes:
SizeAtFailure- The log file size (in bytes) at the time of failure.- See Also:
system.log.LogMessage,system.log.Threshold
- Severity:
Level- Attributes:
LogLevel- A textural description of the log message severity level.ID- When given, the ID of the component in the container that logged the message.Message- The message text.- See Also:
system.log.Failure,system.log.Threshold
- Severity:
Level.WARNING- Attributes:
ActualSize- The log file size (in bytes) at the time of notification.ThresholdSize- The current log file threshold size (in bytes).- See Also:
system.log.Failuresystem.log.LogMessage,
- Severity:
Level.WARNING- Attributes:
User- The name of the user that was denied permission.Target- The target component on which the operation was to be performed.Operation- The management operation name that was denied.RequiredPermission- Integer which specifies which permission was denied. Permission values map to constants in the java Class IManagePermissionBits.
- Severity:
Level.INFO- Attributes:
ContainerStateThe current state of the container and its hosted components.LastErrorAll state notifications carry the description of the last (uncleared) error that occurred on this component.LastErrorLevelAll state notifications carry the severity level of the last (uncleared) error that occurred on this component. Severity levels are integers whose values map to constants defined in the java class Level.- See Also:
system.state.Online,system.state.Shutdown,system.state.Load,system.state.Unload,system.state.Failover
- Severity:
Level.WARNING- Attributes:
FaultToleranceRole- The fault tolerance role of the container (PRIMARY or BACKUP).- See Also:
system.state.Online,system.state.Shutdown,system.state.Load,system.state.Unload,system.state.ContainerState
- Severity:
Level.INFO- Attributes:
ConfigID- The configuration identity of the newly loaded component.ID- The runtime identity within the container of the newly loaded component.LastError- All state notifications carry the description of the last (uncleared) error that occurred on this component.LastErrorLevel- All state notifications carry the severity level of the last (uncleared) error that occurred on this component. Severity levels are integers whose values map to constants defined in the java class Level.- See Also:
system.state.Online,system.state.Shutdown,system.state.Unload,system.state.ContainerState,system.state.Failover
- Severity:
Level.INFO- Attributes:
LastError- All state notifications carry the description of the last (uncleared) error that occurred on this component.LastErrorLevel- All state notifications carry the severity level of the last (uncleared) error that occurred on this component. Severity levels are integers whose values map to constants defined in the java class Level.- See Also:
system.state.Shutdown,system.state.Load,system.state.Unload,system.state.ContainerState,system.state.Failover
- Severity:
Level.INFO- Attributes:
ExitCode- The exit code of the container process.ExitCodeString- A short description of the container process exit code.LastError- All state notifications carry the description of the last (uncleared) error that occurred on this component.LastErrorLevel- All state notifications carry the severity level of the last (uncleared) error that occurred on this component. Severity levels are integers whose values map to constants defined in the java class Level.- See Also:
system.state.Online,system.state.Load,system.state.Unload,system.state.ContainerState,system.state.Failover
- Severity:
Level.INFO- Attributes:
ID- The prior runtime identity within the container of the unloaded component.LastError- All state notifications carry the description of the last (uncleared) error that occurred on this component.LastErrorLevel- All state notifications carry the severity level of the last (uncleared) error that occurred on this component. Severity levels are integers whose values map to constants defined in the java class Level.- See Also:
system.state.Online,system.state.Shutdown,system.state.Load,system.state.ContainerState,system.state.Failover
|
Sonic Management API | |||||
| SUMMARY: OPERATIONS/ATTRIBUTES | NOTIFICATIONS | METRICS | DETAIL: OPERATIONS/ATTRIBUTES | NOTIFICATIONS | METRICS | |||||