Documentation

Index

Constants

View Source
const (
	Default_OutputMetricsOptions_AggregateInCloudprober = bool(false)
)

    Default values for OutputMetricsOptions fields.

    Variables

    View Source
    var (
    	OutputMetricsOptions_MetricsKind_name = map[int32]string{
    		0: "UNDEFINED",
    		1: "GAUGE",
    		2: "CUMULATIVE",
    	}
    	OutputMetricsOptions_MetricsKind_value = map[string]int32{
    		"UNDEFINED":  0,
    		"GAUGE":      1,
    		"CUMULATIVE": 2,
    	}
    )

      Enum value maps for OutputMetricsOptions_MetricsKind.

      View Source
      var File_github_com_google_cloudprober_metrics_payload_proto_config_proto protoreflect.FileDescriptor

      Functions

      This section is empty.

      Types

      type OutputMetricsOptions

      type OutputMetricsOptions struct {
      	MetricsKind *OutputMetricsOptions_MetricsKind `` /* 154-byte string literal not displayed */
      	// Additional labels (comma-separated) to attach to the output metrics, e.g.
      	// "region=us-east1,zone=us-east1-d". ptype="external" and probe="<probeName>"
      	// are attached automatically.
      	AdditionalLabels *string `protobuf:"bytes,2,opt,name=additional_labels,json=additionalLabels" json:"additional_labels,omitempty"`
      	// Whether to aggregate metrics in Cloudprober. If enabled, Cloudprober
      	// aggregates the metrics returned by the external probe process -- external
      	// probe process should return metrics only since the last probe run.
      	// Note that this option is mutually exclusive with GAUGE metrics and
      	// cloudprober will fail during initialization if both options are enabled.
      	AggregateInCloudprober *bool `` /* 129-byte string literal not displayed */
      	// Metrics that should be treated as distributions. These metrics are exported
      	// by the external probe program as comma-separated list of values, for
      	// example: "op_latency 4.7,5.6,5.9,6.1,4.9". To be able to build distribution
      	// from these values, these metrics should be pre-configured in external
      	// probe:
      	// dist_metric {
      	//   key: "op_latency"
      	//   value {
      	//     explicit_buckets: "1,2,4,8,16,32,64,128,256"
      	//   }
      	// }
      	DistMetric map[string]*proto1.Dist `` /* 158-byte string literal not displayed */
      	// contains filtered or unexported fields
      }

      func (*OutputMetricsOptions) Descriptor

      func (*OutputMetricsOptions) Descriptor() ([]byte, []int)

        Deprecated: Use OutputMetricsOptions.ProtoReflect.Descriptor instead.

        func (*OutputMetricsOptions) GetAdditionalLabels

        func (x *OutputMetricsOptions) GetAdditionalLabels() string

        func (*OutputMetricsOptions) GetAggregateInCloudprober

        func (x *OutputMetricsOptions) GetAggregateInCloudprober() bool

        func (*OutputMetricsOptions) GetDistMetric

        func (x *OutputMetricsOptions) GetDistMetric() map[string]*proto1.Dist

        func (*OutputMetricsOptions) GetMetricsKind

        func (*OutputMetricsOptions) ProtoMessage

        func (*OutputMetricsOptions) ProtoMessage()

        func (*OutputMetricsOptions) ProtoReflect

        func (x *OutputMetricsOptions) ProtoReflect() protoreflect.Message

        func (*OutputMetricsOptions) Reset

        func (x *OutputMetricsOptions) Reset()

        func (*OutputMetricsOptions) String

        func (x *OutputMetricsOptions) String() string

        type OutputMetricsOptions_MetricsKind

        type OutputMetricsOptions_MetricsKind int32

          MetricsKind specifies whether to treat output metrics as GAUGE or CUMULATIVE. If left unspecified, metrics from ONCE mode probes are treated as GAUGE and metrics from SERVER mode probes are treated as CUMULATIVE.

          const (
          	OutputMetricsOptions_UNDEFINED  OutputMetricsOptions_MetricsKind = 0
          	OutputMetricsOptions_GAUGE      OutputMetricsOptions_MetricsKind = 1
          	OutputMetricsOptions_CUMULATIVE OutputMetricsOptions_MetricsKind = 2
          )

          func (OutputMetricsOptions_MetricsKind) Descriptor

          func (OutputMetricsOptions_MetricsKind) Enum

          func (OutputMetricsOptions_MetricsKind) EnumDescriptor

          func (OutputMetricsOptions_MetricsKind) EnumDescriptor() ([]byte, []int)

            Deprecated: Use OutputMetricsOptions_MetricsKind.Descriptor instead.

            func (OutputMetricsOptions_MetricsKind) Number

            func (OutputMetricsOptions_MetricsKind) String

            func (OutputMetricsOptions_MetricsKind) Type

            func (*OutputMetricsOptions_MetricsKind) UnmarshalJSON

            func (x *OutputMetricsOptions_MetricsKind) UnmarshalJSON(b []byte) error

              Deprecated: Do not use.

              Source Files