Resource: Stats
This message type encapsulates a stats response.
JSON representation | |
---|---|
{ "environments": [ { object ( |
Fields | |
---|---|
environments[] |
This field contains a list of query results on environment level. |
hosts[] |
This field contains a list of query results grouped by host. |
metaData |
This field contains the metadata information. |
EnvironmentStats
This message type encapsulates the environment wrapper: "environments": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": "prod" } ]
JSON representation | |
---|---|
{ "name": string, "metrics": [ { object ( |
Fields | |
---|---|
name |
|
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 a 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: "environments": [ { "dimensions": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "prod" } ]
This field contains the list of metric values. |
dimensions[] |
This field contains the list of metrics grouped under dimensions. |
Metric
This message type encapsulates the metric data point. 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 |
This field contains the metric name. |
values |
List of metric values. Possible value format: "values":["39.0"] or "values":[ { "value": "39.0", "timestamp": 1232434354} ] |
DimensionMetric
This message type encapsulates a metric grouped by dimension.
JSON representation | |
---|---|
{
"name": string,
"metrics": [
{
object ( |
Fields | |
---|---|
name |
This field contains the name of the dimension. |
metrics[] |
This field contains a list of metrics. |
HostStats
This message type encapsulates the hostname wrapper: "hosts": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": "example.com" } ]
JSON representation | |
---|---|
{ "name": string, "metrics": [ { object ( |
Fields | |
---|---|
name |
This field contains the 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 a top level metrics is 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: "hosts": [ { "dimensions": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "example.com" } ]
This field contains the list of metric values. |
dimensions[] |
This field contains the list of metrics grouped under dimensions. |
Methods |
|
---|---|
|
Retrieve metrics grouped by dimensions. |