8.4.18
See the associated 4.21 Reports resource section for more information on how to use this resource and supported operations.
Additional References
| Type | Value | Additional Information |
|---|---|---|
| Permissions resource | reports | Permissions |
| Hooks filename | reports.groovy | Pre- and Post-Processing Hooks |
| Distinct query-supported | Yes | Distinct |
API version 3
A set of time-based values that share similar context. For example, a report can contain data on CPU or power utilization for all nodes in a cluster.
A report is composed of metadata and a collection of Datapoints. Samples are also associated with reports but these are consolidated using the Report.consolidationFunction to create Datapoints. If the datapoint documents are being truncated in any way or there are warnings about documents being too large, it may be necessary to increase the Report.reportDocumentSize.| Field Name | Type | POST | Description |
|---|---|---|---|
| id | String | No |
The unique identifier for the report. This is automatically assigned and will be ignored if specified duration creation. |
| consolidationFunction | String | Yes |
The consolidation function is the process used to convert a set of samples into a datapoint. Currently the only supported function is 'average', which is used if none is specified. |
| datapointDuration | Long | Yes |
Required. How long the datapoints are, in seconds. |
| datapoints | List<Datapoint> | Yes |
This is the set of datapoints that have been consolidated for the report or are desired to be included in the report during creation time. In the latter case, these represent historical data created outside of the reporting framework. Only present when getting a single report. |
| description | String | Yes |
A description of the report. |
| keepSamples | Boolean | Yes |
Controls if samples are retained after consolidation. Defaults to false, which means that after consolidation, samples are discarded. |
| minimumSampleSize | Integer | Yes |
If number of samples is below this number, the datapoint data field is 'null'. Defaults to 1. |
| name | String | Yes |
Required. A unique name identifying the report. Valid characters are all alphanumeric characters, dashes (-), periods (.), and underscores (_). |
| reportDocumentSize | Long | Yes |
The maximum size in bytes of each datapoint document stored for this report. This option is provided to maximize the amount of disk space used for a single report. The default value for this option is 100*1024, or 100 KB. The maximum value of this option is 16*1024*1024 (16777216) or 16 MB, which represents the maximum document size in MongoDB. See also mongodb.org. Keep in mind that when creating a new report, MongoDB will initialize all needed space for all possible datapoint documents up front. This can easily fill a disk unless this parameter is modified. |
| reportSize | Long | Yes |
Required. The size of the report in datapoints. After this number of datapoints is reached, the old datapoints will be discarded. 
Warning: On report creation, a Mongo collection will be initialized that is the maximum size of a single entry (currently 16 MB) multiplied by the report size. Be careful in setting a large report size as this will quickly allocate the entire disk if many reports with large report sizes are created. |
A metric that measures system state over a specified period of time. For example, a datapoint can contain data on CPU utilization by specific users. A datapoint is generated by the consolidation of zero or more Samples. It could be said that a datapoint represents a smoothing of samples.
| Field Name | Type | POST | Description |
|---|---|---|---|
| id | Long | No |
|
| data | Map<String, Map> | No |
The actual consolidated sample data. This property may be 'null' if the Report.minimumSampleSize was not met when consolidating the datapoint. |
| endDate | Date | No |
The ending date that the datapoint covers. |
| firstSampleDate | Date | No |
The date of the first sample consolidated in this datapoint (see also Sample.timestamp). |
| lastSampleDate | Date | No |
The date of the last sample consolidated in this datapoint (see also Sample.timestamp). |
| startDate | Date | No |
The beginning date that the datapoint covers. |
API version 2
A set of time-based values that share similar context. For example, a report can contain data on CPU or power utilization for all nodes in a cluster.
A report is composed of metadata and a collection of Datapoints. Samples are also associated with reports but these are consolidated using the Report.consolidationFunction to create Datapoints. If the datapoint documents are being truncated in any way or there are warnings about documents being too large, it may be necessary to increase the Report.reportDocumentSize.| Field Name | Type | POST | Description |
|---|---|---|---|
| id | String | No |
The unique identifier for the report. This is automatically assigned and will be ignored if specified duration creation. |
| consolidationFunction | String | Yes |
The consolidation function is the process used to convert a set of samples into a datapoint. Currently the only supported function is 'average', which is used if none is specified. |
| datapointDuration | Long | Yes |
Required. How long the datapoints are, in seconds. |
| datapoints | List<Datapoint> | Yes |
This is the set of datapoints that have been consolidated for the report or are desired to be included in the report during creation time. In the latter case, these represent historical data created outside of the reporting framework. Only present when getting a single report. |
| description | String | Yes |
A description of the report. |
| keepSamples | Boolean | Yes |
Controls if samples are retained after consolidation. Defaults to false, which means that after consolidation, samples are discarded. |
| minimumSampleSize | Integer | Yes |
If number of samples is below this number, the datapoint data field is 'null'. Defaults to 1. |
| name | String | Yes |
Required. A unique name identifying the report. Valid characters are all alphanumeric characters, dashes (-), periods (.), and underscores (_). |
| reportDocumentSize | Long | Yes |
The maximum size in bytes of each datapoint document stored for this report. This option is provided to maximize the amount of disk space used for a single report. The default value for this option is 100*1024, or 100 KB. The maximum value of this option is 16*1024*1024 (16777216) or 16 MB, which represents the maximum document size in MongoDB. See also mongodb.org. Keep in mind that when creating a new report, MongoDB will initialize all needed space for all possible datapoint documents up front. This can easily fill a disk unless this parameter is modified. |
| reportSize | Long | Yes |
Required. The size of the report in datapoints. After this number of datapoints is reached, the old datapoints will be discarded.
Warning: On report creation, a Mongo collection will be initialized that is the maximum size of a single entry (currently 16 MB) multiplied by the report size. Be careful in setting a large report size as this will quickly allocate the entire disk if many reports with large report sizes are created. |
A metric that measures system state over a specified period of time. For example, a datapoint can contain data on CPU utilization by specific users. A datapoint is generated by the consolidation of zero or more Samples. It could be said that a datapoint represents a smoothing of samples.
| Field Name | Type | POST | Description |
|---|---|---|---|
| id | Long | No | |
| data | Map<String, Map> | No |
The actual consolidated sample data. This property may be 'null' if the Report.minimumSampleSize was not met when consolidating the datapoint. |
| endDate | Date | No |
The ending date that the datapoint covers. |
| firstSampleDate | Date | No |
The date of the first sample consolidated in this datapoint (see also Sample.timestamp). |
| lastSampleDate | Date | No |
The date of the last sample consolidated in this datapoint (see also Sample.timestamp). |
| startDate | Date | No |
The beginning date that the datapoint covers. |
Related Topics