Sonic Management API

Agent Metrics


Component: Agent (classname=com.sonicsw.mf.framework.agent.Agent, version=103)

This documentation describes the metrics and alert capabilities that are exposed by a Agent component running within the Sonic Management environment.

A general description of metrics and metric alerts is provided in the overview.

See Also:
Agent Notifications, Agent Operations/Attributes

Metrics Summary
system.memory.CurrentUsage
         Heap space used by the container and its hosted components.
system.memory.MaxUsage
         Maximum heap space used by the container and its hosted components since last metrics reset.
system.notifications.AwaitingDispatch
         The number of management notifications awaiting dispatch.
system.notifications.Dropped
         Number of times a management notification was dropped before dispatch to listeners. Evaluated over the last 30 minutes.
system.notifications.MaxAwaitingDispatch
         The maximum number of management notifications awaiting dispatch since last metrics reset.
system.threads.CurrentPoolSize
         Size of thread pool used to service transient management tasks.
system.threads.CurrentTotal
         Total number of threads used by the container and its hosted components.
system.threads.MaxPoolSize
         Maximum size of thread pool used to service transient management tasks since last metrics reset.
system.threads.PoolWaits
         Number of times transient management tasks had to wait because a pooled thread was not immediately available to service such tasks. Evaluated over the last 30 minutes.

Metrics Detail

system.memory.CurrentUsage

Heap space used by the container and its hosted components.

This metric's value is captured in terms of bytes.

When alert thresholds are specified for this metric and are subsequently broken at runtime, a
system.alert.system.memory.CurrentUsage notification will be published.
Metric Type:
Normal
Dynamic:
Can be enabled/disabled at runtime.
Threshold Alert Support:
High
See Also:
system.memory.MaxUsage

system.memory.MaxUsage

Maximum heap space used by the container and its hosted components since last metrics reset.

This metric's value is captured in terms of bytes.
Metric Type:
Normal
Dynamic:
Can be enabled/disabled at runtime.
Threshold Alert Support:
None
See Also:
system.memory.CurrentUsage

system.notifications.AwaitingDispatch

The number of management notifications awaiting dispatch.

This metric's value is captured in terms of number of notifications.
Metric Type:
Normal
Dynamic:
Can be enabled/disabled at runtime.
Threshold Alert Support:
None
See Also:
system.notifications.Dropped, system.notifications.MaxAwaitingDispatch

system.notifications.Dropped

Number of times a management notification was dropped before dispatch to listeners. Evaluated over the last 30 minutes.

This metric's value is captured in terms of number of notifications.
Metric Type:
Normal
Dynamic:
Can be enabled/disabled at runtime.
Threshold Alert Support:
None
See Also:
system.notifications.AwaitingDispatch, system.notifications.MaxAwaitingDispatch

system.notifications.MaxAwaitingDispatch

The maximum number of management notifications awaiting dispatch since last metrics reset.

This metric's value is captured in terms of number of notifications.
Metric Type:
Normal
Dynamic:
Can be enabled/disabled at runtime.
Threshold Alert Support:
None
See Also:
system.notifications.AwaitingDispatch, system.notifications.Dropped

system.threads.CurrentPoolSize

Size of thread pool used to service transient management tasks.

This metric's value is captured in terms of number of pool threads.
Metric Type:
Normal
Dynamic:
Can be enabled/disabled at runtime.
Threshold Alert Support:
None
See Also:
system.threads.CurrentTotal, system.threads.MaxPoolSize, system.threads.PoolWaits

system.threads.CurrentTotal

Total number of threads used by the container and its hosted components.

This metric's value is captured in terms of number of threads.
Metric Type:
Normal
Dynamic:
Can be enabled/disabled at runtime.
Threshold Alert Support:
None
See Also:
system.threads.CurrentPoolSize, system.threads.MaxPoolSize, system.threads.PoolWaits

system.threads.MaxPoolSize

Maximum size of thread pool used to service transient management tasks since last metrics reset.

This metric's value is captured in terms of number of pool threads.
Metric Type:
Normal
Dynamic:
Can be enabled/disabled at runtime.
Threshold Alert Support:
None
See Also:
system.threads.CurrentPoolSize, system.threads.CurrentTotal, system.threads.PoolWaits

system.threads.PoolWaits

Number of times transient management tasks had to wait because a pooled thread was not immediately available to service such tasks. Evaluated over the last 30 minutes.
Metric Type:
Normal
Dynamic:
Can be enabled/disabled at runtime.
Threshold Alert Support:
None
See Also:
system.threads.CurrentPoolSize, system.threads.CurrentTotal, system.threads.MaxPoolSize

Sonic Management API

Copyright © 2002-2008 Progress Software Corporation. All Rights Reserved.