metrics.proto

path mgmt/v1alpha1/metrics.proto

package mgmt.v1alpha1

---

Messages

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`.

Name	Type	Description
year	uint32	Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
month	uint32	Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
day	uint32	Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

DayResult

Name	Type	Description
date	Date
count	uint64

GetDailyMetricCountRequest

Name	Type	Description
start	Date	The start day
end	Date	The end day
metric	RangedMetricName	The metric to return
account_id	string	The account identifier that will be used to filter by
job_id	string	The job identifier that will be used to filter by
run_id	string	The run identifier that will be used to filter by

GetDailyMetricCountResponse

Name	Type	Description
results	repeated DayResult

GetMetricCountRequest

Name	Type	Description
start	google.protobuf.Timestamp	The start time
end	google.protobuf.Timestamp	The end time
metric	RangedMetricName	The metric to return
account_id	string	The account identifier that will be used to filter by
job_id	string	The job identifier that will be used to filter by
run_id	string	The run identifier that will be used to filter by

GetMetricCountResponse

Name	Type	Description
count	uint64	The summed up count of the metric based on the input query and timerange specified

---

Enums

RangedMetricName

Name	Number	Description
RANGED_METRIC_NAME_UNSPECIFIED	0	If unspecified, an error will be thrown
RANGED_METRIC_NAME_INPUT_RECEIVED	1	The input_received metric

---

Services

MetricsService

GetDailyMetricCount

Method	GetDailyMetricCount
Request	GetDailyMetricCountRequest
Response	GetDailyMetricCountResponse
Description	Retrieve a timed range of records

GetMetricCount

Method	GetMetricCount
Request	GetMetricCountRequest
Response	GetMetricCountResponse
Description	For the given metric and time range, returns the total count found

---