package io_prometheus_client

Import Path
	github.com/prometheus/client_model/go (on go.dev)

Dependency Relation
	imports 5 packages, and imported by 4 packages

Involved Source Files

	    metrics.pb.go
Package-Level Type Names (total 13)

	/* sort by: alphabet | popularity */
	 type Bucket (struct)
		A Bucket of a conventional histogram, each of which is treated as
		an individual counter-like time series by Prometheus.

		Fields (total 4)
			CumulativeCount *uint64
				// Cumulative in increasing order.

			CumulativeCountFloat *float64
				// Overrides cumulative_count if > 0.

			Exemplar *Exemplar
			UpperBound *float64
				// Inclusive.

		Methods (total 9)
			(*Bucket) Descriptor() ([]byte, []int)
				Deprecated: Use Bucket.ProtoReflect.Descriptor instead.

			(*Bucket) GetCumulativeCount() uint64
			(*Bucket) GetCumulativeCountFloat() float64
			(*Bucket) GetExemplar() *Exemplar
			(*Bucket) GetUpperBound() float64
			(*Bucket) ProtoMessage()
			(*Bucket) ProtoReflect() protoreflect.Message
			(*Bucket) Reset()
			(*Bucket) String() string
		Implements (at least 5)
			*Bucket : github.com/gogo/protobuf/proto.Message
			*Bucket : expvar.Var
			*Bucket : fmt.Stringer
			*Bucket : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*Bucket : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least one exported)
			func (*Histogram).GetBucket() []*Bucket

	 type BucketSpan (struct)
		A BucketSpan defines a number of consecutive buckets in a native
		histogram with their offset. Logically, it would be more
		straightforward to include the bucket counts in the Span. However,
		the protobuf representation is more compact in the way the data is
		structured here (with all the buckets in a single array separate
		from the Spans).

		Fields (total 2)
			Length *uint32
				// Length of consecutive buckets.

			Offset *int32
				// Gap to previous span, or starting point for 1st span (which can be negative).

		Methods (total 7)
			(*BucketSpan) Descriptor() ([]byte, []int)
				Deprecated: Use BucketSpan.ProtoReflect.Descriptor instead.

			(*BucketSpan) GetLength() uint32
			(*BucketSpan) GetOffset() int32
			(*BucketSpan) ProtoMessage()
			(*BucketSpan) ProtoReflect() protoreflect.Message
			(*BucketSpan) Reset()
			(*BucketSpan) String() string
		Implements (at least 5)
			*BucketSpan : github.com/gogo/protobuf/proto.Message
			*BucketSpan : expvar.Var
			*BucketSpan : fmt.Stringer
			*BucketSpan : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*BucketSpan : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least 2)
			func (*Histogram).GetNegativeSpan() []*BucketSpan
			func (*Histogram).GetPositiveSpan() []*BucketSpan

	 type Counter (struct)

		Fields (total 3)
			CreatedTimestamp *timestamppb.Timestamp
			Exemplar *Exemplar
			Value *float64
		Methods (total 8)
			(*Counter) Descriptor() ([]byte, []int)
				Deprecated: Use Counter.ProtoReflect.Descriptor instead.

			(*Counter) GetCreatedTimestamp() *timestamppb.Timestamp
			(*Counter) GetExemplar() *Exemplar
			(*Counter) GetValue() float64
			(*Counter) ProtoMessage()
			(*Counter) ProtoReflect() protoreflect.Message
			(*Counter) Reset()
			(*Counter) String() string
		Implements (at least 5)
			*Counter : github.com/gogo/protobuf/proto.Message
			*Counter : expvar.Var
			*Counter : fmt.Stringer
			*Counter : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*Counter : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least one exported)
			func (*Metric).GetCounter() *Counter

	 type Exemplar (struct)

		Fields (total 3)
			Label []*LabelPair
			Timestamp *timestamppb.Timestamp
				// OpenMetrics-style.

			Value *float64
		Methods (total 8)
			(*Exemplar) Descriptor() ([]byte, []int)
				Deprecated: Use Exemplar.ProtoReflect.Descriptor instead.

			(*Exemplar) GetLabel() []*LabelPair
			(*Exemplar) GetTimestamp() *timestamppb.Timestamp
			(*Exemplar) GetValue() float64
			(*Exemplar) ProtoMessage()
			(*Exemplar) ProtoReflect() protoreflect.Message
			(*Exemplar) Reset()
			(*Exemplar) String() string
		Implements (at least 5)
			*Exemplar : github.com/gogo/protobuf/proto.Message
			*Exemplar : expvar.Var
			*Exemplar : fmt.Stringer
			*Exemplar : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*Exemplar : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least 3)
			func (*Bucket).GetExemplar() *Exemplar
			func (*Counter).GetExemplar() *Exemplar
			func (*Histogram).GetExemplars() []*Exemplar

	 type Gauge (struct)

		Fields (only one)
			Value *float64
		Methods (total 6)
			(*Gauge) Descriptor() ([]byte, []int)
				Deprecated: Use Gauge.ProtoReflect.Descriptor instead.

			(*Gauge) GetValue() float64
			(*Gauge) ProtoMessage()
			(*Gauge) ProtoReflect() protoreflect.Message
			(*Gauge) Reset()
			(*Gauge) String() string
		Implements (at least 5)
			*Gauge : github.com/gogo/protobuf/proto.Message
			*Gauge : expvar.Var
			*Gauge : fmt.Stringer
			*Gauge : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*Gauge : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least one exported)
			func (*Metric).GetGauge() *Gauge

	 type Histogram (struct)

		Fields (total 16)
			Bucket []*Bucket
				Buckets for the conventional histogram.
				// Ordered in increasing order of upper_bound, +Inf bucket is optional.

			CreatedTimestamp *timestamppb.Timestamp
			Exemplars []*Exemplar
				Only used for native histograms. These exemplars MUST have a timestamp.

			NegativeCount []float64
				// Absolute count of each bucket.

			NegativeDelta []int64
				Use either "negative_delta" or "negative_count", the former for
				regular histograms with integer counts, the latter for float
				histograms.
				// Count delta of each bucket compared to previous one (or to zero for 1st bucket).

			NegativeSpan []*BucketSpan
				Negative buckets for the native histogram.

			PositiveCount []float64
				// Absolute count of each bucket.

			PositiveDelta []int64
				Use either "positive_delta" or "positive_count", the former for
				regular histograms with integer counts, the latter for float
				histograms.
				// Count delta of each bucket compared to previous one (or to zero for 1st bucket).

			PositiveSpan []*BucketSpan
				Positive buckets for the native histogram.
				Use a no-op span (offset 0, length 0) for a native histogram without any
				observations yet and with a zero_threshold of 0. Otherwise, it would be
				indistinguishable from a classic histogram.

			SampleCount *uint64
			SampleCountFloat *float64
				// Overrides sample_count if > 0.

			SampleSum *float64
			Schema *int32
				schema defines the bucket schema. Currently, valid numbers are -4 <= n <= 8.
				They are all for base-2 bucket schemas, where 1 is a bucket boundary in each case, and
				then each power of two is divided into 2^n logarithmic buckets.
				Or in other words, each bucket boundary is the previous boundary times 2^(2^-n).
				In the future, more bucket schemas may be added using numbers < -4 or > 8.

			ZeroCount *uint64
				// Count in zero bucket.

			ZeroCountFloat *float64
				// Overrides sb_zero_count if > 0.

			ZeroThreshold *float64
				// Breadth of the zero bucket.

		Methods (total 21)
			(*Histogram) Descriptor() ([]byte, []int)
				Deprecated: Use Histogram.ProtoReflect.Descriptor instead.

			(*Histogram) GetBucket() []*Bucket
			(*Histogram) GetCreatedTimestamp() *timestamppb.Timestamp
			(*Histogram) GetExemplars() []*Exemplar
			(*Histogram) GetNegativeCount() []float64
			(*Histogram) GetNegativeDelta() []int64
			(*Histogram) GetNegativeSpan() []*BucketSpan
			(*Histogram) GetPositiveCount() []float64
			(*Histogram) GetPositiveDelta() []int64
			(*Histogram) GetPositiveSpan() []*BucketSpan
			(*Histogram) GetSampleCount() uint64
			(*Histogram) GetSampleCountFloat() float64
			(*Histogram) GetSampleSum() float64
			(*Histogram) GetSchema() int32
			(*Histogram) GetZeroCount() uint64
			(*Histogram) GetZeroCountFloat() float64
			(*Histogram) GetZeroThreshold() float64
			(*Histogram) ProtoMessage()
			(*Histogram) ProtoReflect() protoreflect.Message
			(*Histogram) Reset()
			(*Histogram) String() string
		Implements (at least 5)
			*Histogram : github.com/gogo/protobuf/proto.Message
			*Histogram : expvar.Var
			*Histogram : fmt.Stringer
			*Histogram : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*Histogram : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least one exported)
			func (*Metric).GetHistogram() *Histogram

	 type LabelPair (struct)

		Fields (total 2)
			Name *string
			Value *string
		Methods (total 7)
			(*LabelPair) Descriptor() ([]byte, []int)
				Deprecated: Use LabelPair.ProtoReflect.Descriptor instead.

			(*LabelPair) GetName() string
			(*LabelPair) GetValue() string
			(*LabelPair) ProtoMessage()
			(*LabelPair) ProtoReflect() protoreflect.Message
			(*LabelPair) Reset()
			(*LabelPair) String() string
		Implements (at least 5)
			*LabelPair : github.com/gogo/protobuf/proto.Message
			*LabelPair : expvar.Var
			*LabelPair : fmt.Stringer
			*LabelPair : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*LabelPair : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least 3)
			func (*Exemplar).GetLabel() []*LabelPair
			func (*Metric).GetLabel() []*LabelPair
			func github.com/prometheus/client_golang/prometheus.MakeLabelPairs(desc *prometheus.Desc, labelValues []string) []*LabelPair

	 type Metric (struct)

		Fields (total 7)
			Counter *Counter
			Gauge *Gauge
			Histogram *Histogram
			Label []*LabelPair
			Summary *Summary
			TimestampMs *int64
			Untyped *Untyped
		Methods (total 12)
			(*Metric) Descriptor() ([]byte, []int)
				Deprecated: Use Metric.ProtoReflect.Descriptor instead.

			(*Metric) GetCounter() *Counter
			(*Metric) GetGauge() *Gauge
			(*Metric) GetHistogram() *Histogram
			(*Metric) GetLabel() []*LabelPair
			(*Metric) GetSummary() *Summary
			(*Metric) GetTimestampMs() int64
			(*Metric) GetUntyped() *Untyped
			(*Metric) ProtoMessage()
			(*Metric) ProtoReflect() protoreflect.Message
			(*Metric) Reset()
			(*Metric) String() string
		Implements (at least 5)
			*Metric : github.com/gogo/protobuf/proto.Message
			*Metric : expvar.Var
			*Metric : fmt.Stringer
			*Metric : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*Metric : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least one exported)
			func (*MetricFamily).GetMetric() []*Metric
		As Inputs Of (at least 8)
			func github.com/prometheus/client_golang/prometheus.Counter.Write(*Metric) error
			func github.com/prometheus/client_golang/prometheus.CounterFunc.Write(*Metric) error
			func github.com/prometheus/client_golang/prometheus.Gauge.Write(*Metric) error
			func github.com/prometheus/client_golang/prometheus.GaugeFunc.Write(*Metric) error
			func github.com/prometheus/client_golang/prometheus.Histogram.Write(*Metric) error
			func github.com/prometheus/client_golang/prometheus.Metric.Write(*Metric) error
			func github.com/prometheus/client_golang/prometheus.Summary.Write(*Metric) error
			func github.com/prometheus/client_golang/prometheus.UntypedFunc.Write(*Metric) error

	 type MetricFamily (struct)

		Fields (total 5)
			Help *string
			Metric []*Metric
			Name *string
			Type *MetricType
			Unit *string
		Methods (total 10)
			(*MetricFamily) Descriptor() ([]byte, []int)
				Deprecated: Use MetricFamily.ProtoReflect.Descriptor instead.

			(*MetricFamily) GetHelp() string
			(*MetricFamily) GetMetric() []*Metric
			(*MetricFamily) GetName() string
			(*MetricFamily) GetType() MetricType
			(*MetricFamily) GetUnit() string
			(*MetricFamily) ProtoMessage()
			(*MetricFamily) ProtoReflect() protoreflect.Message
			(*MetricFamily) Reset()
			(*MetricFamily) String() string
		Implements (at least 5)
			*MetricFamily : github.com/gogo/protobuf/proto.Message
			*MetricFamily : expvar.Var
			*MetricFamily : fmt.Stringer
			*MetricFamily : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*MetricFamily : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least 9)
			func github.com/prometheus/client_golang/prometheus.Gatherer.Gather() ([]*MetricFamily, error)
			func github.com/prometheus/client_golang/prometheus.GathererFunc.Gather() ([]*MetricFamily, error)
			func github.com/prometheus/client_golang/prometheus.Gatherers.Gather() ([]*MetricFamily, error)
			func github.com/prometheus/client_golang/prometheus.(*MultiTRegistry).Gather() (mfs []*MetricFamily, done func(), err error)
			func github.com/prometheus/client_golang/prometheus.(*Registry).Gather() ([]*MetricFamily, error)
			func github.com/prometheus/client_golang/prometheus.TransactionalGatherer.Gather() (_ []*MetricFamily, done func(), err error)
			func github.com/prometheus/client_golang/prometheus/internal.NormalizeMetricFamilies(metricFamiliesByName map[string]*MetricFamily) []*MetricFamily
			func github.com/prometheus/common/expfmt.(*TextParser).TextToMetricFamilies(in io.Reader) (map[string]*MetricFamily, error)
			func github.com/prometheus/common/model.EscapeMetricFamily(v *MetricFamily, scheme model.EscapingScheme) *MetricFamily
		As Inputs Of (at least 7)
			func github.com/prometheus/client_golang/prometheus/internal.NormalizeMetricFamilies(metricFamiliesByName map[string]*MetricFamily) []*MetricFamily
			func github.com/prometheus/common/expfmt.ExtractSamples(o *expfmt.DecodeOptions, fams ...*MetricFamily) (model.Vector, error)
			func github.com/prometheus/common/expfmt.MetricFamilyToOpenMetrics(out io.Writer, in *MetricFamily, options ...expfmt.EncoderOption) (written int, err error)
			func github.com/prometheus/common/expfmt.MetricFamilyToText(out io.Writer, in *MetricFamily) (written int, err error)
			func github.com/prometheus/common/expfmt.Decoder.Decode(*MetricFamily) error
			func github.com/prometheus/common/expfmt.Encoder.Encode(*MetricFamily) error
			func github.com/prometheus/common/model.EscapeMetricFamily(v *MetricFamily, scheme model.EscapingScheme) *MetricFamily

	 type MetricType int32 (basic type)

		Methods (total 7)
			( MetricType) Descriptor() protoreflect.EnumDescriptor
			( MetricType) Enum() *MetricType
			( MetricType) EnumDescriptor() ([]byte, []int)
				Deprecated: Use MetricType.Descriptor instead.

			( MetricType) Number() protoreflect.EnumNumber
			( MetricType) String() string
			( MetricType) Type() protoreflect.EnumType
			(*MetricType) UnmarshalJSON(b []byte) error
				Deprecated: Do not use.

		Implements (at least 5)
			*MetricType : github.com/goccy/go-json.Unmarshaler
			*MetricType : encoding/json.Unmarshaler
			 MetricType : expvar.Var
			 MetricType : fmt.Stringer
			 MetricType : google.golang.org/protobuf/reflect/protoreflect.Enum
		As Outputs Of (at least 3)
			func (*MetricFamily).GetType() MetricType
			func MetricType.Enum() *MetricType
			func github.com/prometheus/client_golang/prometheus.ValueType.ToDTO() *MetricType
		As Types Of (total 9)
			const MetricType_COUNTER
			const MetricType_GAUGE
			const MetricType_GAUGE_HISTOGRAM
			const MetricType_HISTOGRAM
			const MetricType_SUMMARY
			const MetricType_UNTYPED
			  var github.com/prometheus/client_golang/prometheus.CounterMetricTypePtr *MetricType
			  var github.com/prometheus/client_golang/prometheus.GaugeMetricTypePtr *MetricType
			  var github.com/prometheus/client_golang/prometheus.UntypedMetricTypePtr *MetricType

	 type Quantile (struct)

		Fields (total 2)
			Quantile *float64
			Value *float64
		Methods (total 7)
			(*Quantile) Descriptor() ([]byte, []int)
				Deprecated: Use Quantile.ProtoReflect.Descriptor instead.

			(*Quantile) GetQuantile() float64
			(*Quantile) GetValue() float64
			(*Quantile) ProtoMessage()
			(*Quantile) ProtoReflect() protoreflect.Message
			(*Quantile) Reset()
			(*Quantile) String() string
		Implements (at least 5)
			*Quantile : github.com/gogo/protobuf/proto.Message
			*Quantile : expvar.Var
			*Quantile : fmt.Stringer
			*Quantile : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*Quantile : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least one exported)
			func (*Summary).GetQuantile() []*Quantile

	 type Summary (struct)

		Fields (total 4)
			CreatedTimestamp *timestamppb.Timestamp
			Quantile []*Quantile
			SampleCount *uint64
			SampleSum *float64
		Methods (total 9)
			(*Summary) Descriptor() ([]byte, []int)
				Deprecated: Use Summary.ProtoReflect.Descriptor instead.

			(*Summary) GetCreatedTimestamp() *timestamppb.Timestamp
			(*Summary) GetQuantile() []*Quantile
			(*Summary) GetSampleCount() uint64
			(*Summary) GetSampleSum() float64
			(*Summary) ProtoMessage()
			(*Summary) ProtoReflect() protoreflect.Message
			(*Summary) Reset()
			(*Summary) String() string
		Implements (at least 5)
			*Summary : github.com/gogo/protobuf/proto.Message
			*Summary : expvar.Var
			*Summary : fmt.Stringer
			*Summary : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*Summary : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least one exported)
			func (*Metric).GetSummary() *Summary

	 type Untyped (struct)

		Fields (only one)
			Value *float64
		Methods (total 6)
			(*Untyped) Descriptor() ([]byte, []int)
				Deprecated: Use Untyped.ProtoReflect.Descriptor instead.

			(*Untyped) GetValue() float64
			(*Untyped) ProtoMessage()
			(*Untyped) ProtoReflect() protoreflect.Message
			(*Untyped) Reset()
			(*Untyped) String() string
		Implements (at least 5)
			*Untyped : github.com/gogo/protobuf/proto.Message
			*Untyped : expvar.Var
			*Untyped : fmt.Stringer
			*Untyped : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*Untyped : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least one exported)
			func (*Metric).GetUntyped() *Untyped


Package-Level Variables (total 3)

	  var File_io_prometheus_client_metrics_proto protoreflect.FileDescriptor
	  var MetricType_name map[int32]string
		Enum value maps for MetricType.

	  var MetricType_value map[string]int32
		Enum value maps for MetricType.


Package-Level Constants (total 6)

	const MetricType_COUNTER MetricType = 0
		COUNTER must use the Metric field "counter".

	const MetricType_GAUGE MetricType = 1
		GAUGE must use the Metric field "gauge".

	const MetricType_GAUGE_HISTOGRAM MetricType = 5
		GAUGE_HISTOGRAM must use the Metric field "histogram".

	const MetricType_HISTOGRAM MetricType = 4
		HISTOGRAM must use the Metric field "histogram".

	const MetricType_SUMMARY MetricType = 2
		SUMMARY must use the Metric field "summary".

	const MetricType_UNTYPED MetricType = 3
		UNTYPED must use the Metric field "untyped".

The pages are generated with Golds v0.8.2. (GOOS=linux 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 @zigo_101 (reachable from the left QR code) to get the latest news of Golds.