Resource: Stats
Encapsulates a stats
response.
JSON representation |
---|
{ "environments" : [ { object ( |
Fields | |
---|---|
environments[]
|
List of query results on the environment level. |
hosts[]
|
List of query results grouped by host. |
metaData
|
Metadata information. |
EnvironmentStats
Encapsulates the environment wrapper:
"environments": [
{
"metrics": [
{
"name": "sum(message_count)",
"values": [
"2.52056245E8"
]
}
],
"name": "prod"
}
]
JSON representation |
---|
{ "name" : string , "metrics" : [ { object ( |
Fields | |
---|---|
name
|
Name of the environment. |
metrics[]
|
In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only top-level metrics is provided. If dimensions are included, then there will be a top-level dimensions field under environments which will contain metrics values and the dimension name. Example: or List of metric values. |
dimensions[]
|
List of metrics grouped under dimensions. |
Metric
Encapsulates the metric data point. For example:
{
"name": "sum(message_count)",
"values" : [ {
"timestamp": 1549004400000,
"value": "39.0"
},
{
"timestamp" : 1548997200000,
"value" : "0.0"
} ]
}
or
{
"name": "sum(message_count)",
"values" : ["39.0"]
}
JSON representation |
---|
{ "name" : string , "values" : array } |
Fields | |
---|---|
name
|
Metric name. |
values
|
List of metric values. Possible value formats include: |
DimensionMetric
Encapsulates a metric grouped by dimension.
JSON representation |
---|
{
"name"
:
string
,
"individualNames"
:
[
string
]
,
"metrics"
:
[
{
object (
|
Fields | |
---|---|
name
|
Comma joined dimension names. E.g. "dim1_name,dim2_name". Deprecated. If name already has comma before join, we may get wrong splits. Please use individualNames. |
individualNames[]
|
Individual dimension names. E.g. ["dim1_name", "dim2_name"]. |
metrics[]
|
List of metrics. |
HostStats
Encapsulates the hostname wrapper:
"hosts": [
{
"metrics": [
{
"name": "sum(message_count)",
"values": [
"2.52056245E8"
]
}
],
"name": "example.com"
}
]
JSON representation |
---|
{ "name" : string , "metrics" : [ { object ( |
Fields | |
---|---|
name
|
Hostname used in query. |
metrics[]
|
In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only the top-level metrics are provided. If dimensions are included, then there will be a top-level dimensions field under hostnames which will contain metrics values and the dimension name. Example:
List of metric values. |
dimensions[]
|
List of metrics grouped under dimensions. |
Methods |
|
---|---|
|
Retrieve metrics grouped by dimensions. |