metric

Documentation

Overview

Package metric is a generated protocol buffer package.

It is generated from these files:

bazel-out/local-fastbuild/genfiles/mixer/template/metric/go_default_library_tmpl.proto

It has these top-level messages:

Type
InstanceParam

Index

• Constants
• Variables
• type Handler
• type HandlerBuilder
• type Instance
• type InstanceParam
  • func (*InstanceParam) Descriptor() ([]byte, []int)
  • func (this *InstanceParam) Equal(that interface{}) bool
  • func (m *InstanceParam) GetDimensions() map[string]string
  • func (m *InstanceParam) GetMonitoredResourceDimensions() map[string]string
  • func (m *InstanceParam) GetMonitoredResourceType() string
  • func (m *InstanceParam) GetValue() string
  • func (this *InstanceParam) GoString() string
  • func (m *InstanceParam) Marshal() (dAtA []byte, err error)
  • func (m *InstanceParam) MarshalTo(dAtA []byte) (int, error)
  • func (*InstanceParam) ProtoMessage()
  • func (m *InstanceParam) Reset()
  • func (m *InstanceParam) Size() (n int)
  • func (this *InstanceParam) String() string
  • func (m *InstanceParam) Unmarshal(dAtA []byte) error
• type Type
  • func (*Type) Descriptor() ([]byte, []int)
  • func (this *Type) Equal(that interface{}) bool
  • func (m *Type) GetDimensions() map[string]istio_mixer_v1_config_descriptor.ValueType
  • func (m *Type) GetMonitoredResourceDimensions() map[string]istio_mixer_v1_config_descriptor.ValueType
  • func (m *Type) GetValue() istio_mixer_v1_config_descriptor.ValueType
  • func (this *Type) GoString() string
  • func (m *Type) Marshal() (dAtA []byte, err error)
  • func (m *Type) MarshalTo(dAtA []byte) (int, error)
  • func (*Type) ProtoMessage()
  • func (m *Type) Reset()
  • func (m *Type) Size() (n int)
  • func (this *Type) String() string
  • func (m *Type) Unmarshal(dAtA []byte) error

Constants

const TemplateName = "metric"

Fully qualified name of the template

Variables

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

Types

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.

Metric 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/mixer/expression-language.html). Please note that if the datatype of a field is not istio.mixer.v1.config.descriptor.ValueType, then the expression's [inferred type](https://istio.io/docs/reference/config/mixer/expression-language.html#type-checking) must match the datatype of the field.

Example config: ``` apiVersion: "config.istio.io/v1alpha2" kind: metric metadata:

name: requestsize
namespace: istio-system

spec:

value: request.size | 0
dimensions:
  source_service: source.service | "unknown"
  source_version: source.labels["version"] | "unknown"
  destination_service: destination.service | "unknown"
  destination_version: destination.labels["version"] | "unknown"
  response_code: response.code | 200
monitored_resource_type: '"UNSPECIFIED"'

```

type InstanceParam

type InstanceParam struct {
	Value                       string            `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	Dimensions                  map[string]string `` /* 154-byte string literal not displayed */
	MonitoredResourceType       string            `` /* 126-byte string literal not displayed */
	MonitoredResourceDimensions map[string]string `` /* 225-byte string literal not displayed */
}

func (*InstanceParam) Descriptor

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

func (*InstanceParam) Equal

func (this *InstanceParam) Equal(that interface{}) bool

func (*InstanceParam) GetDimensions

func (m *InstanceParam) GetDimensions() map[string]string

func (*InstanceParam) GetMonitoredResourceDimensions

func (m *InstanceParam) GetMonitoredResourceDimensions() map[string]string

func (*InstanceParam) GetMonitoredResourceType

func (m *InstanceParam) GetMonitoredResourceType() string

func (*InstanceParam) GetValue

func (m *InstanceParam) GetValue() string

func (*InstanceParam) GoString

func (this *InstanceParam) GoString() string

func (*InstanceParam) Marshal

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

func (*InstanceParam) MarshalTo

func (m *InstanceParam) MarshalTo(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

type Type

type Type struct {
	// The value being reported.
	Value istio_mixer_v1_config_descriptor.ValueType `protobuf:"varint,1,opt,name=value,proto3,enum=istio.mixer.v1.config.descriptor.ValueType" json:"value,omitempty"`
	// The unique identity of the particular metric to report.
	Dimensions map[string]istio_mixer_v1_config_descriptor.ValueType `` /* 203-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]istio_mixer_v1_config_descriptor.ValueType `` /* 274-byte string literal not displayed */
}

Metric 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/mixer/expression-language.html). Please note that if the datatype of a field is not istio.mixer.v1.config.descriptor.ValueType, then the expression's [inferred type](https://istio.io/docs/reference/config/mixer/expression-language.html#type-checking) must match the datatype of the field.

Example config: ``` apiVersion: "config.istio.io/v1alpha2" kind: metric metadata:

name: requestsize
namespace: istio-system

spec:

value: request.size | 0
dimensions:
  source_service: source.service | "unknown"
  source_version: source.labels["version"] | "unknown"
  destination_service: destination.service | "unknown"
  destination_version: destination.labels["version"] | "unknown"
  response_code: response.code | 200
monitored_resource_type: '"UNSPECIFIED"'

```

func (*Type) Descriptor

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

func (*Type) Equal

func (this *Type) Equal(that interface{}) bool

func (*Type) GetDimensions

func (m *Type) GetDimensions() map[string]istio_mixer_v1_config_descriptor.ValueType

func (*Type) GetMonitoredResourceDimensions

func (m *Type) GetMonitoredResourceDimensions() map[string]istio_mixer_v1_config_descriptor.ValueType

func (*Type) GetValue

func (m *Type) GetValue() istio_mixer_v1_config_descriptor.ValueType

func (*Type) GoString

func (this *Type) GoString() string

func (*Type) Marshal

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

func (*Type) MarshalTo

func (m *Type) MarshalTo(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