package metric

Import Path
	google.golang.org/genproto/googleapis/api/metric (on go.dev)

Dependency Relation
	imports 8 packages, and imported by 4 packages

Involved Source Files

	      metric.pb.go
Package-Level Type Names (total 5, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Metric (struct)
		A specific metric, identified by specifying values for all of the
		labels of a [`MetricDescriptor`][google.api.MetricDescriptor].

		Fields (total 5, in which 2 are exported)
			Labels map[string]string
				The set of label values that uniquely identify this metric. All
				labels listed in the `MetricDescriptor` must be assigned values.

			Type string
				An existing metric type, see [google.api.MetricDescriptor][google.api.MetricDescriptor].
				For example, `custom.googleapis.com/invoice/paid/amount`.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 7, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use Metric.ProtoReflect.Descriptor instead.

			(*T) GetLabels() map[string]string
			(*T) GetType() string
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least one exported)
			func google.golang.org/genproto/googleapis/monitoring/v3.(*TimeSeries).GetMetric() *Metric
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func contrib.go.opencensus.io/exporter/stackdriver.metricSignature(metric *Metric) string

	 type MetricDescriptor (struct)
		Defines a metric type and its schema. Once a metric descriptor is created,
		deleting or altering it stops data collection and makes the metric type's
		existing data unusable.

		The following are specific rules for service defined Monitoring metric
		descriptors:

		* `type`, `metric_kind`, `value_type`, `description`, `display_name`,
		  `launch_stage` fields are all required. The `unit` field must be specified
		  if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION.
		* Maximum of default 500 metric descriptors per service is allowed.
		* Maximum of default 10 labels per metric descriptor is allowed.

		The default maximum limit can be overridden. Please follow
		https://cloud.google.com/monitoring/quotas

		Fields (total 14, in which 11 are exported)
			Description string
				A detailed description of the metric, which can be used in documentation.

			DisplayName string
				A concise name for the metric, which can be displayed in user interfaces.
				Use sentence case without an ending period, for example "Request count".
				This field is optional but it is recommended to be set for any metrics
				associated with user-visible concepts, such as Quota.

			Labels []*label.LabelDescriptor
				The set of labels that can be used to describe a specific
				instance of this metric type.

				The label key name must follow:

				* Only upper and lower-case letters, digits and underscores (_) are
				  allowed.
				* Label name must start with a letter or digit.
				* The maximum length of a label name is 100 characters.

				For example, the
				`appengine.googleapis.com/http/server/response_latencies` metric
				type has a label for the HTTP response code, `response_code`, so
				you can look at latencies for successful responses or just
				for responses that failed.

			LaunchStage api.LaunchStage
				Optional. The launch stage of the metric definition.

			Metadata *MetricDescriptor_MetricDescriptorMetadata
				Optional. Metadata which can be used to guide usage of the metric.

			MetricKind MetricDescriptor_MetricKind
				Whether the metric records instantaneous values, changes to a value, etc.
				Some combinations of `metric_kind` and `value_type` might not be supported.

			MonitoredResourceTypes []string
				Read-only. If present, then a [time
				series][google.monitoring.v3.TimeSeries], which is identified partially by
				a metric type and a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor], that is associated
				with this metric type can only be associated with one of the monitored
				resource types listed here.

			Name string
				The resource name of the metric descriptor.

			Type string
				The metric type, including its DNS name prefix. The type is not
				URL-encoded.

				All service defined metrics must be prefixed with the service name, in the
				format of `{service name}/{relative metric name}`, such as
				`cloudsql.googleapis.com/database/cpu/utilization`. The relative metric
				name must follow:

				* Only upper and lower-case letters, digits, '/' and underscores '_' are
				  allowed.
				* The maximum number of characters allowed for the relative_metric_name is
				  100.

				All user-defined metric types have the DNS name
				`custom.googleapis.com`, `external.googleapis.com`, or
				`logging.googleapis.com/user/`.

				Metric types should use a natural hierarchical grouping. For example:

				    "custom.googleapis.com/invoice/paid/amount"
				    "external.googleapis.com/prometheus/up"
				    "appengine.googleapis.com/http/server/response_latencies"

			Unit string
				The units in which the metric value is reported. It is only applicable
				if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit`
				defines the representation of the stored metric values.

				Different systems may scale the values to be more easily displayed (so a
				value of `0.02KBy` _might_ be displayed as `20By`, and a value of
				`3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is
				`KBy`, then the value of the metric is always in thousands of bytes, no
				matter how it may be displayed..

				If you want a custom metric to record the exact number of CPU-seconds used
				by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is
				`s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005
				CPU-seconds, then the value is written as `12005`.

				Alternatively, if you want a custom metric to record data in a more
				granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is
				`ks{CPU}`, and then write the value `12.005` (which is `12005/1000`),
				or use `Kis{CPU}` and write `11.723` (which is `12005/1024`).

				The supported units are a subset of [The Unified Code for Units of
				Measure](http://unitsofmeasure.org/ucum.html) standard:

				**Basic units (UNIT)**

				* `bit`   bit
				* `By`    byte
				* `s`     second
				* `min`   minute
				* `h`     hour
				* `d`     day
				* `1`     dimensionless

				**Prefixes (PREFIX)**

				* `k`     kilo    (10^3)
				* `M`     mega    (10^6)
				* `G`     giga    (10^9)
				* `T`     tera    (10^12)
				* `P`     peta    (10^15)
				* `E`     exa     (10^18)
				* `Z`     zetta   (10^21)
				* `Y`     yotta   (10^24)

				* `m`     milli   (10^-3)
				* `u`     micro   (10^-6)
				* `n`     nano    (10^-9)
				* `p`     pico    (10^-12)
				* `f`     femto   (10^-15)
				* `a`     atto    (10^-18)
				* `z`     zepto   (10^-21)
				* `y`     yocto   (10^-24)

				* `Ki`    kibi    (2^10)
				* `Mi`    mebi    (2^20)
				* `Gi`    gibi    (2^30)
				* `Ti`    tebi    (2^40)
				* `Pi`    pebi    (2^50)

				**Grammar**

				The grammar also includes these connectors:

				* `/`    division or ratio (as an infix operator). For examples,
				         `kBy/{email}` or `MiBy/10ms` (although you should almost never
				         have `/s` in a metric `unit`; rates should always be computed at
				         query time from the underlying cumulative or delta value).
				* `.`    multiplication or composition (as an infix operator). For
				         examples, `GBy.d` or `k{watt}.h`.

				The grammar for a unit is as follows:

				    Expression = Component { "." Component } { "/" Component } ;

				    Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
				              | Annotation
				              | "1"
				              ;

				    Annotation = "{" NAME "}" ;

				Notes:

				* `Annotation` is just a comment if it follows a `UNIT`. If the annotation
				   is used alone, then the unit is equivalent to `1`. For examples,
				   `{request}/s == 1/s`, `By{transmitted}/s == By/s`.
				* `NAME` is a sequence of non-blank printable ASCII characters not
				   containing `{` or `}`.
				* `1` represents a unitary [dimensionless
				   unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such
				   as in `1/s`. It is typically used when none of the basic units are
				   appropriate. For example, "new users per day" can be represented as
				   `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new
				   users). Alternatively, "thousands of page views per day" would be
				   represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric
				   value of `5.3` would mean "5300 page views per day").
				* `%` represents dimensionless value of 1/100, and annotates values giving
				   a percentage (so the metric values are typically in the range of 0..100,
				   and a metric value `3` means "3 percent").
				* `10^2.%` indicates a metric contains a ratio, typically in the range
				   0..1, that will be multiplied by 100 and displayed as a percentage
				   (so a metric value `0.03` means "3 percent").

			ValueType MetricDescriptor_ValueType
				Whether the measurement is an integer, a floating-point number, etc.
				Some combinations of `metric_kind` and `value_type` might not be supported.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 16, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use MetricDescriptor.ProtoReflect.Descriptor instead.

			(*T) GetDescription() string
			(*T) GetDisplayName() string
			(*T) GetLabels() []*label.LabelDescriptor
			(*T) GetLaunchStage() api.LaunchStage
			(*T) GetMetadata() *MetricDescriptor_MetricDescriptorMetadata
			(*T) GetMetricKind() MetricDescriptor_MetricKind
			(*T) GetMonitoredResourceTypes() []string
			(*T) GetName() string
			(*T) GetType() string
			(*T) GetUnit() string
			(*T) GetValueType() MetricDescriptor_ValueType
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least 12, all are exported)
			func google.golang.org/genproto/googleapis/logging/v2.(*LogMetric).GetMetricDescriptor() *MetricDescriptor
			func google.golang.org/genproto/googleapis/monitoring/v3.(*CreateMetricDescriptorRequest).GetMetricDescriptor() *MetricDescriptor
			func google.golang.org/genproto/googleapis/monitoring/v3.(*ListMetricDescriptorsResponse).GetMetricDescriptors() []*MetricDescriptor
			func google.golang.org/genproto/googleapis/monitoring/v3.MetricServiceClient.CreateMetricDescriptor(ctx context.Context, in *monitoring.CreateMetricDescriptorRequest, opts ...grpc.CallOption) (*MetricDescriptor, error)
			func google.golang.org/genproto/googleapis/monitoring/v3.MetricServiceClient.GetMetricDescriptor(ctx context.Context, in *monitoring.GetMetricDescriptorRequest, opts ...grpc.CallOption) (*MetricDescriptor, error)
			func google.golang.org/genproto/googleapis/monitoring/v3.MetricServiceServer.CreateMetricDescriptor(context.Context, *monitoring.CreateMetricDescriptorRequest) (*MetricDescriptor, error)
			func google.golang.org/genproto/googleapis/monitoring/v3.MetricServiceServer.GetMetricDescriptor(context.Context, *monitoring.GetMetricDescriptorRequest) (*MetricDescriptor, error)
			func google.golang.org/genproto/googleapis/monitoring/v3.(*UnimplementedMetricServiceServer).CreateMetricDescriptor(context.Context, *monitoring.CreateMetricDescriptorRequest) (*MetricDescriptor, error)
			func google.golang.org/genproto/googleapis/monitoring/v3.(*UnimplementedMetricServiceServer).GetMetricDescriptor(context.Context, *monitoring.GetMetricDescriptorRequest) (*MetricDescriptor, error)
			func cloud.google.com/go/monitoring/apiv3.(*MetricClient).CreateMetricDescriptor(ctx context.Context, req *monitoringpb.CreateMetricDescriptorRequest, opts ...gax.CallOption) (*MetricDescriptor, error)
			func cloud.google.com/go/monitoring/apiv3.(*MetricClient).GetMetricDescriptor(ctx context.Context, req *monitoringpb.GetMetricDescriptorRequest, opts ...gax.CallOption) (*MetricDescriptor, error)
			func cloud.google.com/go/monitoring/apiv3.(*MetricDescriptorIterator).Next() (*MetricDescriptor, error)

	 type MetricDescriptor_MetricDescriptorMetadata (struct)
		Additional annotations that can be used to guide the usage of a metric.

		Fields (total 6, in which 3 are exported)
			IngestDelay *durationpb.Duration
				The delay of data points caused by ingestion. Data points older than this
				age are guaranteed to be ingested and available to be read, excluding
				data loss due to errors.

			LaunchStage api.LaunchStage
				Deprecated. Must use the [MetricDescriptor.launch_stage][google.api.MetricDescriptor.launch_stage] instead.

				Deprecated: Do not use.

			SamplePeriod *durationpb.Duration
				The sampling period of metric data points. For metrics which are written
				periodically, consecutive data points are stored at this time interval,
				excluding data loss due to errors. Metrics with a higher granularity have
				a smaller sampling period.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 8, all are exported)
			(*T) Descriptor() ([]byte, []int)
				Deprecated: Use MetricDescriptor_MetricDescriptorMetadata.ProtoReflect.Descriptor instead.

			(*T) GetIngestDelay() *durationpb.Duration
			(*T) GetLaunchStage() api.LaunchStage
				Deprecated: Do not use.

			(*T) GetSamplePeriod() *durationpb.Duration
			(*T) ProtoMessage()
			(*T) ProtoReflect() protoreflect.Message
			(*T) Reset()
			(*T) String() string
		Implements (at least 7, in which 4 are exported)
			*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*T : expvar.Var
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : google.golang.org/protobuf/internal/impl.messageV1
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least one exported)
			func (*MetricDescriptor).GetMetadata() *MetricDescriptor_MetricDescriptorMetadata

	 type MetricDescriptor_MetricKind int32 (basic type)
		The kind of measurement. It describes how the data is reported.

		Methods (total 6, all are exported)
			( T) Descriptor() protoreflect.EnumDescriptor
			( T) Enum() *MetricDescriptor_MetricKind
			( T) EnumDescriptor() ([]byte, []int)
				Deprecated: Use MetricDescriptor_MetricKind.Descriptor instead.

			( T) Number() protoreflect.EnumNumber
			( T) String() string
			( T) Type() protoreflect.EnumType
		Implements (at least 6, in which 3 are exported)
			 T : google.golang.org/protobuf/reflect/protoreflect.Enum
			 T : expvar.Var
			 T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			 T : google.golang.org/protobuf/internal/impl.enumV1
			 T : context.stringer
			 T : runtime.stringer
		As Outputs Of (at least 6, in which 4 are exported)
			func (*MetricDescriptor).GetMetricKind() MetricDescriptor_MetricKind
			func MetricDescriptor_MetricKind.Enum() *MetricDescriptor_MetricKind
			func google.golang.org/genproto/googleapis/monitoring/v3.(*TimeSeries).GetMetricKind() MetricDescriptor_MetricKind
			func google.golang.org/genproto/googleapis/monitoring/v3.(*TimeSeriesDescriptor_ValueDescriptor).GetMetricKind() MetricDescriptor_MetricKind
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func contrib.go.opencensus.io/exporter/stackdriver.metricDescriptorTypeToMetricKind(m *metricdata.Metric) (MetricDescriptor_MetricKind, MetricDescriptor_ValueType)
			func contrib.go.opencensus.io/exporter/stackdriver.protoMetricDescriptorTypeToMetricKind(m *metricspb.Metric) (MetricDescriptor_MetricKind, MetricDescriptor_ValueType)
		As Types Of (total 4, all are exported)
			const MetricDescriptor_CUMULATIVE
			const MetricDescriptor_DELTA
			const MetricDescriptor_GAUGE
			const MetricDescriptor_METRIC_KIND_UNSPECIFIED

	 type MetricDescriptor_ValueType int32 (basic type)
		The value type of a metric.

		Methods (total 6, all are exported)
			( T) Descriptor() protoreflect.EnumDescriptor
			( T) Enum() *MetricDescriptor_ValueType
			( T) EnumDescriptor() ([]byte, []int)
				Deprecated: Use MetricDescriptor_ValueType.Descriptor instead.

			( T) Number() protoreflect.EnumNumber
			( T) String() string
			( T) Type() protoreflect.EnumType
		Implements (at least 6, in which 3 are exported)
			 T : google.golang.org/protobuf/reflect/protoreflect.Enum
			 T : expvar.Var
			 T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			 T : google.golang.org/protobuf/internal/impl.enumV1
			 T : context.stringer
			 T : runtime.stringer
		As Outputs Of (at least 6, in which 4 are exported)
			func (*MetricDescriptor).GetValueType() MetricDescriptor_ValueType
			func MetricDescriptor_ValueType.Enum() *MetricDescriptor_ValueType
			func google.golang.org/genproto/googleapis/monitoring/v3.(*TimeSeries).GetValueType() MetricDescriptor_ValueType
			func google.golang.org/genproto/googleapis/monitoring/v3.(*TimeSeriesDescriptor_ValueDescriptor).GetValueType() MetricDescriptor_ValueType
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func contrib.go.opencensus.io/exporter/stackdriver.metricDescriptorTypeToMetricKind(m *metricdata.Metric) (MetricDescriptor_MetricKind, MetricDescriptor_ValueType)
			func contrib.go.opencensus.io/exporter/stackdriver.protoMetricDescriptorTypeToMetricKind(m *metricspb.Metric) (MetricDescriptor_MetricKind, MetricDescriptor_ValueType)
		As Types Of (total 7, all are exported)
			const MetricDescriptor_BOOL
			const MetricDescriptor_DISTRIBUTION
			const MetricDescriptor_DOUBLE
			const MetricDescriptor_INT64
			const MetricDescriptor_MONEY
			const MetricDescriptor_STRING
			const MetricDescriptor_VALUE_TYPE_UNSPECIFIED


Package-Level Functions (total 3, none are exported)

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func file_google_api_metric_proto_init()
	 func file_google_api_metric_proto_rawDescGZIP() []byte
	 func init()
Package-Level Variables (total 12, in which 5 are exported)

	  var File_google_api_metric_proto protoreflect.FileDescriptor
	  var MetricDescriptor_MetricKind_name map[int32]string
		Enum value maps for MetricDescriptor_MetricKind.

	  var MetricDescriptor_MetricKind_value map[string]int32
		Enum value maps for MetricDescriptor_MetricKind.

	  var MetricDescriptor_ValueType_name map[int32]string
		Enum value maps for MetricDescriptor_ValueType.

	  var MetricDescriptor_ValueType_value map[string]int32
		Enum value maps for MetricDescriptor_ValueType.

	/* 7 unexporteds ... *//* 7 unexporteds: */
	  var file_google_api_metric_proto_depIdxs []int32
	  var file_google_api_metric_proto_enumTypes []impl.EnumInfo
	  var file_google_api_metric_proto_goTypes []interface{}
	  var file_google_api_metric_proto_msgTypes []impl.MessageInfo
	  var file_google_api_metric_proto_rawDesc []byte
	  var file_google_api_metric_proto_rawDescData []byte
	  var file_google_api_metric_proto_rawDescOnce sync.Once
Package-Level Constants (total 11, all are exported)

	const MetricDescriptor_BOOL MetricDescriptor_ValueType = 1
		The value is a boolean.
		This value type can be used only if the metric kind is `GAUGE`.

	const MetricDescriptor_CUMULATIVE MetricDescriptor_MetricKind = 3
		A value accumulated over a time interval.  Cumulative
		measurements in a time series should have the same start time
		and increasing end times, until an event resets the cumulative
		value to zero and sets a new start time for the following
		points.

	const MetricDescriptor_DELTA MetricDescriptor_MetricKind = 2
		The change in a value during a time interval.

	const MetricDescriptor_DISTRIBUTION MetricDescriptor_ValueType = 5
		The value is a [`Distribution`][google.api.Distribution].

	const MetricDescriptor_DOUBLE MetricDescriptor_ValueType = 3
		The value is a double precision floating point number.

	const MetricDescriptor_GAUGE MetricDescriptor_MetricKind = 1
		An instantaneous measurement of a value.

	const MetricDescriptor_INT64 MetricDescriptor_ValueType = 2
		The value is a signed 64-bit integer.

	const MetricDescriptor_METRIC_KIND_UNSPECIFIED MetricDescriptor_MetricKind = 0
		Do not use this default value.

	const MetricDescriptor_MONEY MetricDescriptor_ValueType = 6
		The value is money.

	const MetricDescriptor_STRING MetricDescriptor_ValueType = 4
		The value is a text string.
		This value type can be used only if the metric kind is `GAUGE`.

	const MetricDescriptor_VALUE_TYPE_UNSPECIFIED MetricDescriptor_ValueType = 0
		Do not use this default value.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.