Skip to content

metric

Contents

MetricService

MetricService serves Metric of deployment resource.

GetMetrics

rpc GetMetrics(GetMetricsRequest) MetricsResponse

(-- api-linter: core::0131::response-message-name=disabled aip.dev/not-precedent: We need to do this because reasons. --) GetMetrics API returns the Metrics of DataService Deployment.

Messages

GetMetricsRequest

Definition of the QueryRequest message

Field Type Description
query string PromQL query string
data_service_deployment_id string Id of the dataservice.
start_time google.protobuf.Timestamp Start time in milliseconds since epoch
end_time google.protobuf.Timestamp End time in milliseconds since epoch

MetricsResponse

Definition of the QueryResult message

Field Type Description
time_series repeated TimeSeries List of time series data matching the query

Sample

Definition of the Sample message

Field Type Description
time_stamp google.protobuf.Timestamp (-- api-linter: core::0142::time-field-names=disabled aip.dev/not-precedent: We need to do this because reasons. --) Timestamp of the sample in milliseconds since epoch
value double Numeric value of the metric at the specified timestamp

TimeSeries

Definition of the TimeSeries message

Field Type Description
metric_name string Name of the metric
samples repeated Sample List of samples for this time series

Enums

Scalar Value Types

.proto Type Notes C++ Type Java Type Python Type

double		 double double float

float		 float float float

int32		 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int

int64		 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long

uint32		 Uses variable-length encoding. uint32 int int/long

uint64		 Uses variable-length encoding. uint64 long int/long

sint32		 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int

sint64		 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long

fixed32		 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int

fixed64		 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long

sfixed32		 Always four bytes. int32 int int

sfixed64		 Always eight bytes. int64 long int/long

bool		 bool boolean boolean

string		 A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode

bytes		 May contain any arbitrary sequence of bytes. string ByteString str