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.
Prefetched Metric Queries provide a metric query that should be executed at a specified frequency to keep the sample cache results full.
Prefetched Metric Queries are used to configure the Metric Queries that should be periodically executed by the Metrics Engine to keep the caches for these metrics full. Typically these queries would result in large result sets or long query times if the caches were empty, such that having the result fully or partially in the cache will result in improved sample query performance for a specific application.
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ metric-name | None |
| ↓ server-type | |
| ↓ query-dimension-filter | |
| ↓ statistic | |
| ↓ time-range | |
| ↓ sample-count |
| Description | The name of the metric to be queried for. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The type of server(s) to be included in the query results. |
| Default Value | None |
| Allowed Values | directory - All Identity Data Store instances. proxy - All Identity Proxy instances. metrics-engine - All Metrics Engine instances. sync - All Identity Data Sync Server instances. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Restrict the query to the specified set of dimension values. |
| Default Value | None |
| Allowed Values | Limit the query to the specified dimension values. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The type of statistic the query should reflect. |
| Default Value | average |
| Allowed Values | average - Average value. count - Count value. histogram - Histogram value. maximum - Maximum value. minimum - Minimum value. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Time range to use from query, ending at the time the query is issued. |
| Default Value | None |
| Allowed Values | A duration. Lower limit is 1 minutes. Upper limit is 381600 minutes. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Number of points to fetch from query. Used to help select a data granularity. |
| Default Value | 100 |
| Allowed Values | An integer value. Lower limit is 1. Upper limit is 5000 . |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Prefetched Metric Queries:
dsconfig list-prefetched-metric-queries
[--property {propertyName}] ...
To view the configuration for an existing Prefetched Metric Query:
dsconfig get-prefetched-metric-query-prop
--query-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Prefetched Metric Query:
dsconfig set-prefetched-metric-query-prop
--query-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Prefetched Metric Query:
dsconfig create-prefetched-metric-query
--query-name {name}
--set metric-name:{propertyValue}
--set server-type:{propertyValue}
--set time-range:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Prefetched Metric Query:
dsconfig delete-prefetched-metric-query
--query-name {name}