istio: istio.io/istio/mixer/template/metric Index | Files

package metric

import "istio.io/istio/mixer/template/metric"

Index

Package Files

template_handler.gen.go template_handler_service.pb.go

Constants

const TemplateName = "metric"

Fully qualified name of the template

Variables

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

func RegisterHandleMetricServiceServer Uses

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

type HandleMetricRequest Uses

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 Uses

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

func (*HandleMetricRequest) Marshal Uses

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

func (*HandleMetricRequest) MarshalTo Uses

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

func (*HandleMetricRequest) MarshalToSizedBuffer Uses

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

func (*HandleMetricRequest) ProtoMessage Uses

func (*HandleMetricRequest) ProtoMessage()

func (*HandleMetricRequest) Reset Uses

func (m *HandleMetricRequest) Reset()

func (*HandleMetricRequest) Size Uses

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

func (*HandleMetricRequest) String Uses

func (this *HandleMetricRequest) String() string

func (*HandleMetricRequest) Unmarshal Uses

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

func (*HandleMetricRequest) XXX_DiscardUnknown Uses

func (m *HandleMetricRequest) XXX_DiscardUnknown()

func (*HandleMetricRequest) XXX_Marshal Uses

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

func (*HandleMetricRequest) XXX_Merge Uses

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

func (*HandleMetricRequest) XXX_Size Uses

func (m *HandleMetricRequest) XXX_Size() int

func (*HandleMetricRequest) XXX_Unmarshal Uses

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

type HandleMetricServiceClient Uses

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 Uses

func NewHandleMetricServiceClient(cc *grpc.ClientConn) HandleMetricServiceClient

type HandleMetricServiceServer Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 `protobuf:"bytes,2,rep,name=dimensions,proto3" json:"dimensions,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // 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 `protobuf:"bytes,3,opt,name=monitored_resource_type,json=monitoredResourceType,proto3" json:"monitored_resource_type,omitempty"`
    // 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 `protobuf:"bytes,4,rep,name=monitored_resource_dimensions,json=monitoredResourceDimensions,proto3" json:"monitored_resource_dimensions,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
}

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

func (*InstanceMsg) Descriptor Uses

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

func (*InstanceMsg) Marshal Uses

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

func (*InstanceMsg) MarshalTo Uses

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

func (*InstanceMsg) MarshalToSizedBuffer Uses

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

func (*InstanceMsg) ProtoMessage Uses

func (*InstanceMsg) ProtoMessage()

func (*InstanceMsg) Reset Uses

func (m *InstanceMsg) Reset()

func (*InstanceMsg) Size Uses

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

func (*InstanceMsg) String Uses

func (this *InstanceMsg) String() string

func (*InstanceMsg) Unmarshal Uses

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

func (*InstanceMsg) XXX_DiscardUnknown Uses

func (m *InstanceMsg) XXX_DiscardUnknown()

func (*InstanceMsg) XXX_Marshal Uses

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

func (*InstanceMsg) XXX_Merge Uses

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

func (*InstanceMsg) XXX_Size Uses

func (m *InstanceMsg) XXX_Size() int

func (*InstanceMsg) XXX_Unmarshal Uses

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

type InstanceParam Uses

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 `protobuf:"bytes,2,rep,name=dimensions,proto3" json:"dimensions,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // 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 `protobuf:"bytes,3,opt,name=monitored_resource_type,json=monitoredResourceType,proto3" json:"monitored_resource_type,omitempty"`
    // 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 `protobuf:"bytes,4,rep,name=monitored_resource_dimensions,json=monitoredResourceDimensions,proto3" json:"monitored_resource_dimensions,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
}

Represents instance configuration schema for 'metric' template.

func (*InstanceParam) Descriptor Uses

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

func (*InstanceParam) Marshal Uses

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

func (*InstanceParam) MarshalTo Uses

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

func (*InstanceParam) MarshalToSizedBuffer Uses

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

func (*InstanceParam) ProtoMessage Uses

func (*InstanceParam) ProtoMessage()

func (*InstanceParam) Reset Uses

func (m *InstanceParam) Reset()

func (*InstanceParam) Size Uses

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

func (*InstanceParam) String Uses

func (this *InstanceParam) String() string

func (*InstanceParam) Unmarshal Uses

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

func (*InstanceParam) XXX_DiscardUnknown Uses

func (m *InstanceParam) XXX_DiscardUnknown()

func (*InstanceParam) XXX_Marshal Uses

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

func (*InstanceParam) XXX_Merge Uses

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

func (*InstanceParam) XXX_Size Uses

func (m *InstanceParam) XXX_Size() int

func (*InstanceParam) XXX_Unmarshal Uses

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

type Type Uses

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 `protobuf:"bytes,2,rep,name=dimensions,proto3" json:"dimensions,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"varint,2,opt,name=value,proto3,enum=istio.policy.v1beta1.ValueType"`
    // 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 `protobuf:"bytes,4,rep,name=monitored_resource_dimensions,json=monitoredResourceDimensions,proto3" json:"monitored_resource_dimensions,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"varint,2,opt,name=value,proto3,enum=istio.policy.v1beta1.ValueType"`
}

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 Uses

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

func (*Type) Marshal Uses

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

func (*Type) MarshalTo Uses

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

func (*Type) MarshalToSizedBuffer Uses

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

func (*Type) ProtoMessage Uses

func (*Type) ProtoMessage()

func (*Type) Reset Uses

func (m *Type) Reset()

func (*Type) Size Uses

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

func (*Type) String Uses

func (this *Type) String() string

func (*Type) Unmarshal Uses

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

func (*Type) XXX_DiscardUnknown Uses

func (m *Type) XXX_DiscardUnknown()

func (*Type) XXX_Marshal Uses

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

func (*Type) XXX_Merge Uses

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

func (*Type) XXX_Size Uses

func (m *Type) XXX_Size() int

func (*Type) XXX_Unmarshal Uses

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

type UnimplementedHandleMetricServiceServer Uses

type UnimplementedHandleMetricServiceServer struct {
}

UnimplementedHandleMetricServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedHandleMetricServiceServer) HandleMetric Uses

func (*UnimplementedHandleMetricServiceServer) HandleMetric(ctx context.Context, req *HandleMetricRequest) (*v1beta11.ReportResult, error)

Package metric imports 17 packages (graph) and is imported by 29 packages. Updated 2019-10-22. Refresh now. Tools for package owners.