Documentation

Index

Constants

View Source
const TemplateName = "metric"

Fully qualified name of the template

Variables

View Source
var (
	ErrInvalidLengthTemplateHandlerService = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTemplateHandlerService   = fmt.Errorf("proto: integer overflow")
)

Functions

func RegisterHandleMetricServiceServer

func RegisterHandleMetricServiceServer(s *grpc.Server, srv HandleMetricServiceServer)

Types

type HandleMetricRequest

type HandleMetricRequest struct {
	// 'metric' instances.
	Instances []*InstanceMsg `protobuf:"bytes,1,rep,name=instances,proto3" json:"instances,omitempty"`
	// Adapter specific handler configuration.
	//
	// Note: Backends can also implement [InfrastructureBackend][https://istio.io/docs/reference/config/mixer/istio.mixer.adapter.model.v1beta1.html#InfrastructureBackend]
	// service and therefore opt to receive handler configuration during session creation through [InfrastructureBackend.CreateSession][TODO: Link to this fragment]
	// call. In that case, adapter_config will have type_url as 'google.protobuf.Any.type_url' and would contain string
	// value of session_id (returned from InfrastructureBackend.CreateSession).
	AdapterConfig *types.Any `protobuf:"bytes,2,opt,name=adapter_config,json=adapterConfig,proto3" json:"adapter_config,omitempty"`
	// Id to dedupe identical requests from Mixer.
	DedupId string `protobuf:"bytes,3,opt,name=dedup_id,json=dedupId,proto3" json:"dedup_id,omitempty"`
}

Request message for HandleMetric method.

func (*HandleMetricRequest) Descriptor

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

func (*HandleMetricRequest) Marshal

func (m *HandleMetricRequest) Marshal() (dAtA []byte, err error)

func (*HandleMetricRequest) MarshalTo

func (m *HandleMetricRequest) MarshalTo(dAtA []byte) (int, error)

func (*HandleMetricRequest) MarshalToSizedBuffer

func (m *HandleMetricRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*HandleMetricRequest) ProtoMessage

func (*HandleMetricRequest) ProtoMessage()

func (*HandleMetricRequest) Reset

func (m *HandleMetricRequest) Reset()

func (*HandleMetricRequest) Size

func (m *HandleMetricRequest) Size() (n int)

func (*HandleMetricRequest) String

func (this *HandleMetricRequest) String() string

func (*HandleMetricRequest) Unmarshal

func (m *HandleMetricRequest) Unmarshal(dAtA []byte) error

func (*HandleMetricRequest) XXX_DiscardUnknown

func (m *HandleMetricRequest) XXX_DiscardUnknown()

func (*HandleMetricRequest) XXX_Marshal

func (m *HandleMetricRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HandleMetricRequest) XXX_Merge

func (m *HandleMetricRequest) XXX_Merge(src proto.Message)

func (*HandleMetricRequest) XXX_Size

func (m *HandleMetricRequest) XXX_Size() int

func (*HandleMetricRequest) XXX_Unmarshal

func (m *HandleMetricRequest) XXX_Unmarshal(b []byte) error

type HandleMetricServiceClient

type HandleMetricServiceClient interface {
	// HandleMetric is called by Mixer at request-time to deliver 'metric' instances to the backend.
	HandleMetric(ctx context.Context, in *HandleMetricRequest, opts ...grpc.CallOption) (*v1beta11.ReportResult, error)
}

HandleMetricServiceClient is the client API for HandleMetricService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewHandleMetricServiceClient

func NewHandleMetricServiceClient(cc *grpc.ClientConn) HandleMetricServiceClient

type HandleMetricServiceServer

type HandleMetricServiceServer interface {
	// HandleMetric is called by Mixer at request-time to deliver 'metric' instances to the backend.
	HandleMetric(context.Context, *HandleMetricRequest) (*v1beta11.ReportResult, error)
}

HandleMetricServiceServer is the server API for HandleMetricService service.

type Handler

type Handler interface {
	adapter.Handler

	// HandleMetric is called by Mixer at request time to deliver instances to
	// to an adapter.
	HandleMetric(context.Context, []*Instance) error
}

Handler must be implemented by adapter code if it wants to process data associated with the 'metric' template.

Mixer uses this interface to call into the adapter at request time in order to dispatch created instances to the adapter. Adapters take the incoming instances and do what they need to achieve their primary function.

The name of each instance can be used as a key into the Type map supplied to the adapter at configuration time via the method 'SetMetricTypes'. These Type associated with an instance describes the shape of the instance

type HandlerBuilder

type HandlerBuilder interface {
	adapter.HandlerBuilder

	// SetMetricTypes is invoked by Mixer to pass the template-specific Type information for instances that an adapter
	// may receive at runtime. The type information describes the shape of the instance.
	SetMetricTypes(map[string]*Type)
}

HandlerBuilder must be implemented by adapters if they want to process data associated with the 'metric' template.

Mixer uses this interface to call into the adapter at configuration time to configure it with adapter-specific configuration as well as all template-specific type information.

type Instance

type Instance struct {
	// Name of the instance as specified in configuration.
	Name string

	// The value being reported.
	Value interface{}

	// The unique identity of the particular metric to report.
	Dimensions map[string]interface{}

	// Optional. An expression to compute the type of the monitored resource this metric is being reported on.
	// If the metric backend supports monitored resources, these fields are used to populate that resource. Otherwise
	// these fields will be ignored by the adapter.
	MonitoredResourceType string

	// Optional. A set of expressions that will form the dimensions of the monitored resource this metric is being reported on.
	// If the metric backend supports monitored resources, these fields are used to populate that resource. Otherwise
	// these fields will be ignored by the adapter.
	MonitoredResourceDimensions map[string]interface{}
}

Instance is constructed by Mixer for the 'metric' template.

The `metric` template represents a single piece of data to report.

When writing the configuration, the value for the fields associated with this template can either be a literal or an [expression](https://istio.io/docs/reference//config/policy-and-telemetry/expression-language/). Please note that if the datatype of a field is not istio.policy.v1beta1.Value, then the expression's [inferred type](https://istio.io/docs/reference//config/policy-and-telemetry/expression-language/#type-checking) must match the datatype of the field.

type InstanceMsg

type InstanceMsg struct {
	// Name of the instance as specified in configuration.
	Name string `protobuf:"bytes,72295727,opt,name=name,proto3" json:"name,omitempty"`
	// The value being reported.
	Value *v1beta1.Value `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// The unique identity of the particular metric to report.
	Dimensions map[string]*v1beta1.Value `` /* 161-byte string literal not displayed */
	// Optional. An expression to compute the type of the monitored resource this metric is being reported on.
	// If the metric backend supports monitored resources, these fields are used to populate that resource. Otherwise
	// these fields will be ignored by the adapter.
	MonitoredResourceType string `` /* 126-byte string literal not displayed */
	// Optional. A set of expressions that will form the dimensions of the monitored resource this metric is being reported on.
	// If the metric backend supports monitored resources, these fields are used to populate that resource. Otherwise
	// these fields will be ignored by the adapter.
	MonitoredResourceDimensions map[string]*v1beta1.Value `` /* 232-byte string literal not displayed */
}

Contains instance payload for 'metric' template. This is passed to infrastructure backends during request-time through HandleMetricService.HandleMetric.

func (*InstanceMsg) Descriptor

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

func (*InstanceMsg) Marshal

func (m *InstanceMsg) Marshal() (dAtA []byte, err error)

func (*InstanceMsg) MarshalTo

func (m *InstanceMsg) MarshalTo(dAtA []byte) (int, error)

func (*InstanceMsg) MarshalToSizedBuffer

func (m *InstanceMsg) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*InstanceMsg) ProtoMessage

func (*InstanceMsg) ProtoMessage()

func (*InstanceMsg) Reset

func (m *InstanceMsg) Reset()

func (*InstanceMsg) Size

func (m *InstanceMsg) Size() (n int)

func (*InstanceMsg) String

func (this *InstanceMsg) String() string

func (*InstanceMsg) Unmarshal

func (m *InstanceMsg) Unmarshal(dAtA []byte) error

func (*InstanceMsg) XXX_DiscardUnknown

func (m *InstanceMsg) XXX_DiscardUnknown()

func (*InstanceMsg) XXX_Marshal

func (m *InstanceMsg) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*InstanceMsg) XXX_Merge

func (m *InstanceMsg) XXX_Merge(src proto.Message)

func (*InstanceMsg) XXX_Size

func (m *InstanceMsg) XXX_Size() int

func (*InstanceMsg) XXX_Unmarshal

func (m *InstanceMsg) XXX_Unmarshal(b []byte) error

type InstanceParam

type InstanceParam struct {
	// The value being reported.
	Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// The unique identity of the particular metric to report.
	Dimensions map[string]string `` /* 161-byte string literal not displayed */
	// Optional. An expression to compute the type of the monitored resource this metric is being reported on.
	// If the metric backend supports monitored resources, these fields are used to populate that resource. Otherwise
	// these fields will be ignored by the adapter.
	MonitoredResourceType string `` /* 126-byte string literal not displayed */
	// Optional. A set of expressions that will form the dimensions of the monitored resource this metric is being reported on.
	// If the metric backend supports monitored resources, these fields are used to populate that resource. Otherwise
	// these fields will be ignored by the adapter.
	MonitoredResourceDimensions map[string]string `` /* 232-byte string literal not displayed */
}

Represents instance configuration schema for 'metric' template.

func (*InstanceParam) Descriptor

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

func (*InstanceParam) Marshal

func (m *InstanceParam) Marshal() (dAtA []byte, err error)

func (*InstanceParam) MarshalTo

func (m *InstanceParam) MarshalTo(dAtA []byte) (int, error)

func (*InstanceParam) MarshalToSizedBuffer

func (m *InstanceParam) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*InstanceParam) ProtoMessage

func (*InstanceParam) ProtoMessage()

func (*InstanceParam) Reset

func (m *InstanceParam) Reset()

func (*InstanceParam) Size

func (m *InstanceParam) Size() (n int)

func (*InstanceParam) String

func (this *InstanceParam) String() string

func (*InstanceParam) Unmarshal

func (m *InstanceParam) Unmarshal(dAtA []byte) error

func (*InstanceParam) XXX_DiscardUnknown

func (m *InstanceParam) XXX_DiscardUnknown()

func (*InstanceParam) XXX_Marshal

func (m *InstanceParam) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*InstanceParam) XXX_Merge

func (m *InstanceParam) XXX_Merge(src proto.Message)

func (*InstanceParam) XXX_Size

func (m *InstanceParam) XXX_Size() int

func (*InstanceParam) XXX_Unmarshal

func (m *InstanceParam) XXX_Unmarshal(b []byte) error

type Type

type Type struct {
	// The value being reported.
	Value v1beta1.ValueType `protobuf:"varint,1,opt,name=value,proto3,enum=istio.policy.v1beta1.ValueType" json:"value,omitempty"`
	// The unique identity of the particular metric to report.
	Dimensions map[string]v1beta1.ValueType `` /* 198-byte string literal not displayed */
	// Optional. A set of expressions that will form the dimensions of the monitored resource this metric is being reported on.
	// If the metric backend supports monitored resources, these fields are used to populate that resource. Otherwise
	// these fields will be ignored by the adapter.
	MonitoredResourceDimensions map[string]v1beta1.ValueType `` /* 269-byte string literal not displayed */
}

Contains inferred type information about specific instance of 'metric' template. This is passed to infrastructure backends during configuration-time through [InfrastructureBackend.CreateSession][TODO: Link to this fragment].

func (*Type) Descriptor

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

func (*Type) Marshal

func (m *Type) Marshal() (dAtA []byte, err error)

func (*Type) MarshalTo

func (m *Type) MarshalTo(dAtA []byte) (int, error)

func (*Type) MarshalToSizedBuffer

func (m *Type) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Type) ProtoMessage

func (*Type) ProtoMessage()

func (*Type) Reset

func (m *Type) Reset()

func (*Type) Size

func (m *Type) Size() (n int)

func (*Type) String

func (this *Type) String() string

func (*Type) Unmarshal

func (m *Type) Unmarshal(dAtA []byte) error

func (*Type) XXX_DiscardUnknown

func (m *Type) XXX_DiscardUnknown()

func (*Type) XXX_Marshal

func (m *Type) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Type) XXX_Merge

func (m *Type) XXX_Merge(src proto.Message)

func (*Type) XXX_Size

func (m *Type) XXX_Size() int

func (*Type) XXX_Unmarshal

func (m *Type) XXX_Unmarshal(b []byte) error

type UnimplementedHandleMetricServiceServer

type UnimplementedHandleMetricServiceServer struct {
}

UnimplementedHandleMetricServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedHandleMetricServiceServer) HandleMetric