metrics

package
v0.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 24, 2025 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source
const (
	Metrics_GetCapabilities_FullMethodName = "/cnpgi.metrics.v1.Metrics/GetCapabilities"
	Metrics_Define_FullMethodName          = "/cnpgi.metrics.v1.Metrics/Define"
	Metrics_Collect_FullMethodName         = "/cnpgi.metrics.v1.Metrics/Collect"
)

Variables

View Source
var (
	MetricType_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "TYPE_COUNTER",
		2: "TYPE_GAUGE",
		3: "TYPE_UNTYPED",
	}
	MetricType_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"TYPE_COUNTER":     1,
		"TYPE_GAUGE":       2,
		"TYPE_UNTYPED":     3,
	}
)

Enum value maps for MetricType_Type.

View Source
var (
	MetricsCapability_RPC_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "TYPE_METRICS",
	}
	MetricsCapability_RPC_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"TYPE_METRICS":     1,
	}
)

Enum value maps for MetricsCapability_RPC_Type.

View Source
var File_proto_metrics_proto protoreflect.FileDescriptor
View Source
var Metrics_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cnpgi.metrics.v1.Metrics",
	HandlerType: (*MetricsServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetCapabilities",
			Handler:    _Metrics_GetCapabilities_Handler,
		},
		{
			MethodName: "Define",
			Handler:    _Metrics_Define_Handler,
		},
		{
			MethodName: "Collect",
			Handler:    _Metrics_Collect_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/metrics.proto",
}

Metrics_ServiceDesc is the grpc.ServiceDesc for Metrics service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterMetricsServer

func RegisterMetricsServer(s grpc.ServiceRegistrar, srv MetricsServer)

Types

type CollectMetric

type CollectMetric struct {

	// value is the metric value
	Value float64 `protobuf:"fixed64,1,opt,name=value,proto3" json:"value,omitempty"`
	// fq_name is the fully qualified name of the metric
	FqName string `protobuf:"bytes,2,opt,name=fq_name,json=fqName,proto3" json:"fq_name,omitempty"`
	// variable_labels are the values for the variable labels of this metric
	VariableLabels []string `protobuf:"bytes,3,rep,name=variable_labels,json=variableLabels,proto3" json:"variable_labels,omitempty"`
	// contains filtered or unexported fields
}

func (*CollectMetric) Descriptor deprecated

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

Deprecated: Use CollectMetric.ProtoReflect.Descriptor instead.

func (*CollectMetric) GetFqName

func (x *CollectMetric) GetFqName() string

func (*CollectMetric) GetValue

func (x *CollectMetric) GetValue() float64

func (*CollectMetric) GetVariableLabels

func (x *CollectMetric) GetVariableLabels() []string

func (*CollectMetric) ProtoMessage

func (*CollectMetric) ProtoMessage()

func (*CollectMetric) ProtoReflect

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

func (*CollectMetric) Reset

func (x *CollectMetric) Reset()

func (*CollectMetric) String

func (x *CollectMetric) String() string

type CollectMetricsRequest

type CollectMetricsRequest struct {

	// This field is REQUIRED and contains the JSON serialization of the
	// Cluster being monitored
	ClusterDefinition []byte `protobuf:"bytes,1,opt,name=cluster_definition,json=clusterDefinition,proto3" json:"cluster_definition,omitempty"`
	// contains filtered or unexported fields
}

func (*CollectMetricsRequest) Descriptor deprecated

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

Deprecated: Use CollectMetricsRequest.ProtoReflect.Descriptor instead.

func (*CollectMetricsRequest) GetClusterDefinition

func (x *CollectMetricsRequest) GetClusterDefinition() []byte

func (*CollectMetricsRequest) ProtoMessage

func (*CollectMetricsRequest) ProtoMessage()

func (*CollectMetricsRequest) ProtoReflect

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

func (*CollectMetricsRequest) Reset

func (x *CollectMetricsRequest) Reset()

func (*CollectMetricsRequest) String

func (x *CollectMetricsRequest) String() string

type CollectMetricsResult

type CollectMetricsResult struct {

	// This field is REQUIRED and contains the JSON serialization of the
	// collected metrics
	Metrics []*CollectMetric `protobuf:"bytes,1,rep,name=metrics,proto3" json:"metrics,omitempty"`
	// contains filtered or unexported fields
}

func (*CollectMetricsResult) Descriptor deprecated

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

Deprecated: Use CollectMetricsResult.ProtoReflect.Descriptor instead.

func (*CollectMetricsResult) GetMetrics

func (x *CollectMetricsResult) GetMetrics() []*CollectMetric

func (*CollectMetricsResult) ProtoMessage

func (*CollectMetricsResult) ProtoMessage()

func (*CollectMetricsResult) ProtoReflect

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

func (*CollectMetricsResult) Reset

func (x *CollectMetricsResult) Reset()

func (*CollectMetricsResult) String

func (x *CollectMetricsResult) String() string

type DefineMetricsRequest

type DefineMetricsRequest struct {

	// This field is REQUIRED and contains the JSON serialization of the
	// Cluster being monitored
	ClusterDefinition []byte `protobuf:"bytes,1,opt,name=cluster_definition,json=clusterDefinition,proto3" json:"cluster_definition,omitempty"`
	// contains filtered or unexported fields
}

func (*DefineMetricsRequest) Descriptor deprecated

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

Deprecated: Use DefineMetricsRequest.ProtoReflect.Descriptor instead.

func (*DefineMetricsRequest) GetClusterDefinition

func (x *DefineMetricsRequest) GetClusterDefinition() []byte

func (*DefineMetricsRequest) ProtoMessage

func (*DefineMetricsRequest) ProtoMessage()

func (*DefineMetricsRequest) ProtoReflect

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

func (*DefineMetricsRequest) Reset

func (x *DefineMetricsRequest) Reset()

func (*DefineMetricsRequest) String

func (x *DefineMetricsRequest) String() string

type DefineMetricsResult

type DefineMetricsResult struct {

	// This field is REQUIRED and contains the JSON serialization of the
	// defined metrics
	Metrics []*Metric `protobuf:"bytes,1,rep,name=metrics,proto3" json:"metrics,omitempty"`
	// contains filtered or unexported fields
}

func (*DefineMetricsResult) Descriptor deprecated

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

Deprecated: Use DefineMetricsResult.ProtoReflect.Descriptor instead.

func (*DefineMetricsResult) GetMetrics

func (x *DefineMetricsResult) GetMetrics() []*Metric

func (*DefineMetricsResult) ProtoMessage

func (*DefineMetricsResult) ProtoMessage()

func (*DefineMetricsResult) ProtoReflect

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

func (*DefineMetricsResult) Reset

func (x *DefineMetricsResult) Reset()

func (*DefineMetricsResult) String

func (x *DefineMetricsResult) String() string

type Metric

type Metric struct {

	// fqName is the fully qualified name of the metric
	FqName string `protobuf:"bytes,1,opt,name=fq_name,json=fqName,proto3" json:"fq_name,omitempty"`
	// help provides a human-readable description of the metric
	Help string `protobuf:"bytes,2,opt,name=help,proto3" json:"help,omitempty"`
	// variable_labels are the label names that can vary for this metric
	VariableLabels []string `protobuf:"bytes,3,rep,name=variable_labels,json=variableLabels,proto3" json:"variable_labels,omitempty"`
	// const_labels are the constant labels applied to this metric
	ConstLabels map[string]string `` /* 168-byte string literal not displayed */
	// value_type indicates the Prometheus value type for this metric
	ValueType *MetricType `protobuf:"bytes,5,opt,name=value_type,json=valueType,proto3" json:"value_type,omitempty"`
	// contains filtered or unexported fields
}

func (*Metric) Descriptor deprecated

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

Deprecated: Use Metric.ProtoReflect.Descriptor instead.

func (*Metric) GetConstLabels

func (x *Metric) GetConstLabels() map[string]string

func (*Metric) GetFqName

func (x *Metric) GetFqName() string

func (*Metric) GetHelp

func (x *Metric) GetHelp() string

func (*Metric) GetValueType

func (x *Metric) GetValueType() *MetricType

func (*Metric) GetVariableLabels

func (x *Metric) GetVariableLabels() []string

func (*Metric) ProtoMessage

func (*Metric) ProtoMessage()

func (*Metric) ProtoReflect

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

func (*Metric) Reset

func (x *Metric) Reset()

func (*Metric) String

func (x *Metric) String() string

type MetricType

type MetricType struct {
	Type MetricType_Type `protobuf:"varint,1,opt,name=type,proto3,enum=cnpgi.metrics.v1.MetricType_Type" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*MetricType) Descriptor deprecated

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

Deprecated: Use MetricType.ProtoReflect.Descriptor instead.

func (*MetricType) GetType

func (x *MetricType) GetType() MetricType_Type

func (*MetricType) ProtoMessage

func (*MetricType) ProtoMessage()

func (*MetricType) ProtoReflect

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

func (*MetricType) Reset

func (x *MetricType) Reset()

func (*MetricType) String

func (x *MetricType) String() string

type MetricType_Type

type MetricType_Type int32
const (
	MetricType_TYPE_UNSPECIFIED MetricType_Type = 0
	// COUNTER represents a monotonically increasing value
	MetricType_TYPE_COUNTER MetricType_Type = 1
	// GAUGE represents a value that can go up and down
	MetricType_TYPE_GAUGE MetricType_Type = 2
	// UNTYPED represents an untyped metric
	MetricType_TYPE_UNTYPED MetricType_Type = 3
)

func (MetricType_Type) Descriptor

func (MetricType_Type) Enum

func (x MetricType_Type) Enum() *MetricType_Type

func (MetricType_Type) EnumDescriptor deprecated

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

Deprecated: Use MetricType_Type.Descriptor instead.

func (MetricType_Type) Number

func (MetricType_Type) String

func (x MetricType_Type) String() string

func (MetricType_Type) Type

type MetricsCapabilitiesRequest

type MetricsCapabilitiesRequest struct {
	// contains filtered or unexported fields
}

func (*MetricsCapabilitiesRequest) Descriptor deprecated

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

Deprecated: Use MetricsCapabilitiesRequest.ProtoReflect.Descriptor instead.

func (*MetricsCapabilitiesRequest) ProtoMessage

func (*MetricsCapabilitiesRequest) ProtoMessage()

func (*MetricsCapabilitiesRequest) ProtoReflect

func (*MetricsCapabilitiesRequest) Reset

func (x *MetricsCapabilitiesRequest) Reset()

func (*MetricsCapabilitiesRequest) String

func (x *MetricsCapabilitiesRequest) String() string

type MetricsCapabilitiesResult

type MetricsCapabilitiesResult struct {

	// All the capabilities that the controller service supports. This
	// field is OPTIONAL.
	Capabilities []*MetricsCapability `protobuf:"bytes,1,rep,name=capabilities,proto3" json:"capabilities,omitempty"`
	// contains filtered or unexported fields
}

func (*MetricsCapabilitiesResult) Descriptor deprecated

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

Deprecated: Use MetricsCapabilitiesResult.ProtoReflect.Descriptor instead.

func (*MetricsCapabilitiesResult) GetCapabilities

func (x *MetricsCapabilitiesResult) GetCapabilities() []*MetricsCapability

func (*MetricsCapabilitiesResult) ProtoMessage

func (*MetricsCapabilitiesResult) ProtoMessage()

func (*MetricsCapabilitiesResult) ProtoReflect

func (*MetricsCapabilitiesResult) Reset

func (x *MetricsCapabilitiesResult) Reset()

func (*MetricsCapabilitiesResult) String

func (x *MetricsCapabilitiesResult) String() string

type MetricsCapability

type MetricsCapability struct {

	// Types that are valid to be assigned to Type:
	//
	//	*MetricsCapability_Rpc
	Type isMetricsCapability_Type `protobuf_oneof:"type"`
	// contains filtered or unexported fields
}

func (*MetricsCapability) Descriptor deprecated

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

Deprecated: Use MetricsCapability.ProtoReflect.Descriptor instead.

func (*MetricsCapability) GetRpc

func (*MetricsCapability) GetType

func (x *MetricsCapability) GetType() isMetricsCapability_Type

func (*MetricsCapability) ProtoMessage

func (*MetricsCapability) ProtoMessage()

func (*MetricsCapability) ProtoReflect

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

func (*MetricsCapability) Reset

func (x *MetricsCapability) Reset()

func (*MetricsCapability) String

func (x *MetricsCapability) String() string

type MetricsCapability_RPC

type MetricsCapability_RPC struct {
	Type MetricsCapability_RPC_Type `protobuf:"varint,1,opt,name=type,proto3,enum=cnpgi.metrics.v1.MetricsCapability_RPC_Type" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*MetricsCapability_RPC) Descriptor deprecated

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

Deprecated: Use MetricsCapability_RPC.ProtoReflect.Descriptor instead.

func (*MetricsCapability_RPC) GetType

func (*MetricsCapability_RPC) ProtoMessage

func (*MetricsCapability_RPC) ProtoMessage()

func (*MetricsCapability_RPC) ProtoReflect

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

func (*MetricsCapability_RPC) Reset

func (x *MetricsCapability_RPC) Reset()

func (*MetricsCapability_RPC) String

func (x *MetricsCapability_RPC) String() string

type MetricsCapability_RPC_Type

type MetricsCapability_RPC_Type int32
const (
	MetricsCapability_RPC_TYPE_UNSPECIFIED MetricsCapability_RPC_Type = 0
	// TYPE_METRICS indicates that the Plugin is able to
	// collect metrics. This feature is required for every
	// plugin exposing the Metrics service
	MetricsCapability_RPC_TYPE_METRICS MetricsCapability_RPC_Type = 1
)

func (MetricsCapability_RPC_Type) Descriptor

func (MetricsCapability_RPC_Type) Enum

func (MetricsCapability_RPC_Type) EnumDescriptor deprecated

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

Deprecated: Use MetricsCapability_RPC_Type.Descriptor instead.

func (MetricsCapability_RPC_Type) Number

func (MetricsCapability_RPC_Type) String

func (MetricsCapability_RPC_Type) Type

type MetricsCapability_Rpc

type MetricsCapability_Rpc struct {
	Rpc *MetricsCapability_RPC `protobuf:"bytes,1,opt,name=rpc,proto3,oneof"`
}

type MetricsClient

type MetricsClient interface {
	// GetCapabilities gets the capabilities of the Metrics service
	GetCapabilities(ctx context.Context, in *MetricsCapabilitiesRequest, opts ...grpc.CallOption) (*MetricsCapabilitiesResult, error)
	// Define the metrics that are collected
	Define(ctx context.Context, in *DefineMetricsRequest, opts ...grpc.CallOption) (*DefineMetricsResult, error)
	// Collect the defined metrics
	Collect(ctx context.Context, in *CollectMetricsRequest, opts ...grpc.CallOption) (*CollectMetricsResult, error)
}

MetricsClient is the client API for Metrics service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewMetricsClient

func NewMetricsClient(cc grpc.ClientConnInterface) MetricsClient

type MetricsServer

type MetricsServer interface {
	// GetCapabilities gets the capabilities of the Metrics service
	GetCapabilities(context.Context, *MetricsCapabilitiesRequest) (*MetricsCapabilitiesResult, error)
	// Define the metrics that are collected
	Define(context.Context, *DefineMetricsRequest) (*DefineMetricsResult, error)
	// Collect the defined metrics
	Collect(context.Context, *CollectMetricsRequest) (*CollectMetricsResult, error)
	// contains filtered or unexported methods
}

MetricsServer is the server API for Metrics service. All implementations must embed UnimplementedMetricsServer for forward compatibility.

type UnimplementedMetricsServer

type UnimplementedMetricsServer struct{}

UnimplementedMetricsServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedMetricsServer) Collect

func (UnimplementedMetricsServer) Define

type UnsafeMetricsServer

type UnsafeMetricsServer interface {
	// contains filtered or unexported methods
}

UnsafeMetricsServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to MetricsServer will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL