Index
-
PrometheusUpstream(interface) -
LabelValuesRequest(message) -
ListMetricMetadataRequest(message) -
QueryExemplarsRequest(message) -
QueryInstantRequest(message) -
QueryLabelsRequest(message) -
QueryRangeRequest(message) -
QuerySeriesRequest(message)
PrometheusUpstream
A service that exposes selected endpoints of the HTTP v1 API of the open source Prometheus monitoring system ( https://prometheus.io) .
The service and its associated types are suffixed with Upstream to later allow for a native protobuf API under the name Prometheus. Since this API only makes sense to expose over JSON over HTTP, end users are never exposed to the service name.
rpc LabelValues(
LabelValuesRequest
) returns ( HttpBody
)
Lists possible values for a given label name.
- Authorization scopes
-
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/monitoring -
https://www.googleapis.com/auth/monitoring.read
For more information, see the Authentication Overview .
-
rpc ListMetricMetadata(
ListMetricMetadataRequest
) returns ( HttpBody
)
Lists metadata for metrics.
- Authorization scopes
-
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/monitoring -
https://www.googleapis.com/auth/monitoring.read
For more information, see the Authentication Overview .
-
rpc QueryExemplars(
QueryExemplarsRequest
) returns ( HttpBody
)
Lists exemplars relevant to a given PromQL query,
- Authorization scopes
-
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/monitoring -
https://www.googleapis.com/auth/monitoring.read
For more information, see the Authentication Overview .
-
rpc QueryInstant(
QueryInstantRequest
) returns ( HttpBody
)
Evaluate a PromQL query at a single point in time.
- Authorization scopes
-
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/monitoring -
https://www.googleapis.com/auth/monitoring.read
For more information, see the Authentication Overview .
-
rpc QueryLabels(
QueryLabelsRequest
) returns ( HttpBody
)
Lists labels for metrics.
- Authorization scopes
-
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/monitoring -
https://www.googleapis.com/auth/monitoring.read
For more information, see the Authentication Overview .
-
rpc QueryRange(
QueryRangeRequest
) returns ( HttpBody
)
Evaluate a PromQL query with [start, end] time range.
- Authorization scopes
-
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/monitoring -
https://www.googleapis.com/auth/monitoring.read
For more information, see the Authentication Overview .
-
rpc QuerySeries(
QuerySeriesRequest
) returns ( HttpBody
)
Lists metadata for metrics.
- Authorization scopes
-
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/monitoring -
https://www.googleapis.com/auth/monitoring.read
For more information, see the Authentication Overview .
-
LabelValuesRequest
LabelValuesRequests holds all parameters of the Prometheus upstream API for querying label values plus GCM-specific parameters.
| Fields | |
|---|---|
name
|
Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/[PROJECT_ID_OR_NUMBER]. |
location
|
Location of the resource information. Has to be "global" now. |
label
|
The label name for which values are queried. |
start
|
The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. |
end
|
The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. |
match
|
A list of matchers encoded in the Prometheus label matcher format to constrain the values to series that satisfy them. |
ListMetricMetadataRequest
ListMetadataRequest holds all parameters of the Prometheus upstream API for querying metric metadata plus GCM-specific parameters.
| Fields | |
|---|---|
name
|
Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/[PROJECT_ID_OR_NUMBER]. |
location
|
Location of the resource information. Has to be "global" for now. |
metric
|
The metric name for which to query metadata. If unset, all metric metadata is returned. |
limit
|
Maximum number of metrics to return. |
QueryExemplarsRequest
QueryExemplarsRequest holds all parameters of the Prometheus upstream API for querying exemplars.
| Fields | |
|---|---|
name
|
Required. The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/[PROJECT_ID_OR_NUMBER]. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. |
query
|
A PromQL query string. Query language documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/ . |
start
|
The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. |
end
|
The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. |
location
|
Location of the resource information. Has to be "global" now. |
QueryInstantRequest
QueryInstantRequest holds all parameters of the Prometheus upstream instant query API plus GCM specific parameters.
| Fields | |
|---|---|
name
|
Required. The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/[PROJECT_ID_OR_NUMBER]. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. |
query
|
A PromQL query string. Query language documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/ . |
time
|
The single point in time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. |
timeout
|
An upper bound timeout for the query. Either a Prometheus duration string ( https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations ) or floating point seconds. This non-standard encoding must be used for compatibility with the open source API. Clients may still implement timeouts at the connection level while ignoring this field. |
location
|
Location of the resource information. Has to be "global" now. |
QueryLabelsRequest
QueryLabelsRequest holds all parameters of the Prometheus upstream API for returning a list of label names.
| Fields | |
|---|---|
name
|
Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/[PROJECT_ID_OR_NUMBER]. |
location
|
Location of the resource information. Has to be "global" now. |
start
|
The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. |
end
|
The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. |
match
|
A list of matchers encoded in the Prometheus label matcher format to constrain the values to series that satisfy them. |
QueryRangeRequest
QueryRangeRequest holds all parameters of the Prometheus upstream range query API plus GCM specific parameters.
| Fields | |
|---|---|
name
|
Required. The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/[PROJECT_ID_OR_NUMBER]. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. |
query
|
A PromQL query string. Query language documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/ . |
start
|
The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. |
end
|
The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. |
step
|
The resolution of query result. Either a Prometheus duration string ( https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations ) or floating point seconds. This non-standard encoding must be used for compatibility with the open source API. Clients may still implement timeouts at the connection level while ignoring this field. |
timeout
|
An upper bound timeout for the query. Either a Prometheus duration string ( https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations ) or floating point seconds. This non-standard encoding must be used for compatibility with the open source API. Clients may still implement timeouts at the connection level while ignoring this field. |
location
|
Location of the resource information. Has to be "global" now. |
QuerySeriesRequest
QuerySeries holds all parameters of the Prometheus upstream API for querying series.
| Fields | |
|---|---|
name
|
Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/[PROJECT_ID_OR_NUMBER]. |
location
|
Location of the resource information. Has to be "global" for now. |
start
|
The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. |
end
|
The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. |
