Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact UnboundID support for assistance if you believe that you have a need to create or modify this type of object.
The Profiler plug-in captures profiling information about operations performed inside the JVM while the Metrics Engine is running.
↓Parent Component
↓Properties
↓dsconfig Usage
The Profiler Plugin component inherits from the Plugin
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ enabled | |
| ↓ profile-sample-interval | |
| ↓ profile-directory | |
| ↓ enable-profiling-on-startup | |
| ↓ profile-action |
| 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 | Specifies the sample interval in milliseconds to be used when capturing profiling information in the server. When capturing data, the profiler thread sleeps for this length of time between calls to obtain traces for all threads running in the JVM. |
| Default Value | None |
| Allowed Values | A duration. Lower limit is 1 milliseconds. Upper limit is 2147483647 milliseconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Changes to this configuration attribute take effect the next time the profiler is started. |
| Description | Specifies the path to the directory where profile information is to be written. This path may be either an absolute path or a path that is relative to the root of the Metrics Engine instance. The directory must exist and the Metrics Engine must have permission to create new files in it. |
| Default Value | None |
| Allowed Values | Unknown |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the profiler plug-in is to start collecting data automatically when the Metrics Engine is started. This property is read only when the server is started, and any changes take effect on the next restart. This property is typically set to "false" unless startup profiling is required, because otherwise the volume of data that can be collected can cause the server to run out of memory if it is not turned off in a timely manner. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the action that should be taken by the profiler. A value of "start" causes the profiler thread to start collecting data if it is not already active. A value of "stop" causes the profiler thread to stop collecting data and write it to disk, and a value of "cancel" causes the profiler thread to stop collecting data and discard anything that has been captured. These operations occur immediately. |
| Default Value | none |
| Allowed Values | none - Do not take any action. start - Start collecting profile data. stop - Stop collecting profile data and write what has been captured to a file in the profile directory. cancel - Stop collecting profile data and discard what has been captured. |
| Multi-Valued | No |
| Required | No |
| 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 Profiler Plugin:
dsconfig create-plugin
--plugin-name {name}
--type profiler
--set enabled:{propertyValue}
--set profile-sample-interval:{propertyValue}
--set profile-directory:{propertyValue}
--set enable-profiling-on-startup:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Plugin:
dsconfig delete-plugin
--plugin-name {name}