Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact UnboundID support in order to understand the potential impact of that change.
This plugin captures server statistics for collection by the Metrics Engine. This is used for profiling server performance over a long period of time, and for correlation of performance anomalies across multiple servers as a function of time. The data captured by this plugin is remotely accessed and stored by the Metrics Engine, allowing monitoring consoles or applications to view short and long term graphs of monitored data, comparing the same data on multiple servers as a function of time when investigating performance anomalies or doing capacity planning. Unless the sample-interval or collection-interval property is set too small, this has a negligible impact on performance.
Extraction of server performance data is done by two different plugins. The Periodic Stats Logger plugin writes performance data to a local comma-delimited file, which the user must capture and process. The Stats Collector plugin collects performance data that is accessible remotely via the Metrics Backend. Both plugins capture data from the same sources, although it is suggested to leave the Stats Collector plugin enabled whenever the Metrics Engine is deployed, while the Periodic Stats Logger plugin should only be enabled if there is a need for locally captured data.
The Stats Collector keeps performance data on disk for a window of time, expecting the Metrics Engine to remotely fetch the data before the Stats Collector deletes the locally cached data.
The Stats Collector has a fixed set of data that it can capture, where the Periodic Stats Logger can be configured to capture any data present in any entry available from the cn=monitor backend by the configuration of custom statistics.
Stats Collector data that is captured by the Metrics Engine is stored by the Metrics Engine such that it can be consumed by a monitoring console or application. The Metrics Engine initially stores the raw performance data as captured by the Stats Collector, however as the performance data 'ages out' the Metrics Engine will aggregate the more time-granular data into coarser samples. For example if the Stats Collector is sampling every second, the Metrics Engine will store the 1-second samples, aggregate the 1-second samples to 1-minute samples after enough 1-second samples have been captured, and then eventually delete the 1-second samples that are more than 2 hours old. This continuous aggregation and pruning means the Metrics Engine has very granular data for the recent past, and coarser data for time further in the past. The aggregation process tends to smooth short-term spikes in the data, so if a particular sample increased by 50% for 10 seconds and then returned to normal, the absolute magnitude of the increase would be lost in the first aggregation. If performance characterization requires the long-term storage of the absolute magnitude of short-duration spikes, then use of the Periodic Stats Logger is necessary.
↓Parent Component
↓Properties
↓dsconfig Usage
The Stats Collector Plugin component inherits from the Stats Plugin
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | ↓ host-info |
| ↓ enabled | ↓ collection-interval |
| ↓ sample-interval | |
| ↓ monitoring-info | |
| ↓ server-info |
| Description | A description for this Plugin |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the plug-in is enabled for use. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The duration between statistics collections. Setting this value too small can have an impact on performance. This value should be a multiple of collection-interval. |
| Default Value | 1 seconds |
| Allowed Values | A duration. Lower limit is 500 milliseconds. Upper limit is 60000 milliseconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the level of detail to include about the Metrics Engine. |
| Default Value | None |
| Allowed Values | none - No details are included about the Metrics Engine. basic - Includes information about import, aggregation and DBMS statistics. extended - Includes information about import, aggregation, DBMS statistics, and sample query performance. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies whether statistics related to resource utilization such as JVM memory and CPU/Network/Disk utilization. |
| Default Value | None |
| Allowed Values | none - No information about the local system CPU, memory, disk or network interfaces is included. basic - CPU, memory and disk information is included. extended - CPU, jvm memory, memory and disk and network information is included. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the level of detail to include about the host system resource utilization including CPU, memory, disk and network activity. The server can capture performance information about the host system including CPU, network and disk utilization values. If the monitor providers that capture this information are enabled, the performance data can be captured by the Metrics Engine. Providing host system performance data gives a more robust understanding of application performance problems, as well as a useful tool for capacity planning. |
| Default Value | None |
| Allowed Values | cpu - Information is included about the CPU and memory utilization. This data is produced by Host System Cpu Memory Monitor Provider. disk - Information is included about the disk utilization of selected disks. Disks to be reported are configured in Host System Disk Monitor Provider. network - Information is included about network utilization of selected interfaces. Networks to be reported are configured in Host System Network Monitor Provider. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
collection-interval (Advanced Property)
| Description | Some of the calculated statistics, such as the average and maximum queue sizes, can use multiple samples within a log interval. This value controls how often samples are gathered, and setting this value too small can have an adverse impact on performance. |
| Default Value | 500 milliseconds |
| Allowed Values | A duration. Lower limit is 100 milliseconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured Plugins:
dsconfig list-plugins
[--property {propertyName}] ...
To view the configuration for an existing Plugin:
dsconfig get-plugin-prop
--plugin-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Plugin:
dsconfig set-plugin-prop
--plugin-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Stats Collector Plugin:
dsconfig create-plugin
--plugin-name {name}
--type {type}
--set enabled:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Plugin:
dsconfig delete-plugin
--plugin-name {name}