config

Documentation

Overview

Package config is a generated protocol buffer package.

The `dogstatsd` adapter is designed to deliver Istio metric instances to a listening [DataDog](https://www.datadoghq.com/) agent.

This adapter supports the [metric template](https://istio.io/docs/reference/config/policy-and-telemetry/templates/metric/).

It is generated from these files:

mixer/adapter/dogstatsd/config/config.proto

It has these top-level messages:

Params

Index

• Variables
• type Params
  • func (*Params) Descriptor() ([]byte, []int)
  • func (this *Params) Equal(that interface{}) bool
  • func (m *Params) GetAddress() string
  • func (m *Params) GetBufferLength() int32
  • func (m *Params) GetGlobalTags() map[string]string
  • func (m *Params) GetMetrics() map[string]*Params_MetricInfo
  • func (m *Params) GetPrefix() string
  • func (m *Params) GetSampleRate() float64
  • func (this *Params) GoString() string
  • func (m *Params) Marshal() (dAtA []byte, err error)
  • func (m *Params) MarshalTo(dAtA []byte) (int, error)
  • func (*Params) ProtoMessage()
  • func (m *Params) Reset()
  • func (m *Params) Size() (n int)
  • func (this *Params) String() string
  • func (m *Params) Unmarshal(dAtA []byte) error
• type Params_MetricInfo
  • func (*Params_MetricInfo) Descriptor() ([]byte, []int)
  • func (this *Params_MetricInfo) Equal(that interface{}) bool
  • func (m *Params_MetricInfo) GetName() string
  • func (m *Params_MetricInfo) GetTags() map[string]string
  • func (m *Params_MetricInfo) GetType() Params_MetricInfo_Type
  • func (this *Params_MetricInfo) GoString() string
  • func (m *Params_MetricInfo) Marshal() (dAtA []byte, err error)
  • func (m *Params_MetricInfo) MarshalTo(dAtA []byte) (int, error)
  • func (*Params_MetricInfo) ProtoMessage()
  • func (m *Params_MetricInfo) Reset()
  • func (m *Params_MetricInfo) Size() (n int)
  • func (this *Params_MetricInfo) String() string
  • func (m *Params_MetricInfo) Unmarshal(dAtA []byte) error
• type Params_MetricInfo_Type
  • func (Params_MetricInfo_Type) EnumDescriptor() ([]byte, []int)
  • func (x Params_MetricInfo_Type) String() string

Variables

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

var Params_MetricInfo_Type_name = map[int32]string{
	0: "UNKNOWN_TYPE",
	1: "COUNTER",
	2: "GAUGE",
	3: "DISTRIBUTION",
}

var Params_MetricInfo_Type_value = map[string]int32{
	"UNKNOWN_TYPE": 0,
	"COUNTER":      1,
	"GAUGE":        2,
	"DISTRIBUTION": 3,
}

Types

type Params

type Params struct {
	// Address of the dogstatsd server.
	// Default: localhost:8125
	Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	// Prefix to prepend to all metrics handled by the adapter. Metric "bar" with prefix "foo." becomes "foo.bar" in DataDog. In order to make sure the metrics get populated into Datadog properly and avoid any billing issues, it's important to leave the metric prefix to its default value of 'istio.'
	// Default: "istio."
	Prefix string `protobuf:"bytes,2,opt,name=prefix,proto3" json:"prefix,omitempty"`
	// Number of individual metrics to buffer before flushing metrics to the network. When buffered, metrics are flushed every 100ms or when the buffer is filled.
	// When buffer is 0, metrics are not buffered.
	// Default: 0
	BufferLength int32 `protobuf:"varint,3,opt,name=buffer_length,json=bufferLength,proto3" json:"buffer_length,omitempty"`
	// Tags to add to every metric. "global": "tag" becomes "global:tag" in DataDog
	// Default: []
	GlobalTags map[string]string `` /* 172-byte string literal not displayed */
	// Chance that any particular metric is sampled when emitted; can take the range [0, 1].
	// Default: 1
	SampleRate float64 `protobuf:"fixed64,5,opt,name=sample_rate,json=sampleRate,proto3" json:"sample_rate,omitempty"`
	// Map of a specific metric instance name -> info. If a metric's instance name is not in the map then the metric will not be exported to DataDog.
	Metrics map[string]*Params_MetricInfo `` /* 141-byte string literal not displayed */
}

Configuration parameter for the DataDog adapter. These params control how Mixer telemetry is transformed and sent to a dogstatsd agent.

The adapter assumes that a dogstatsd agent is running as a sidecar or at some other endpoint that the Mixer can reach. Any dimension that is a part of the metric is converted to a tag automatically. The configuration of the DataDog agent/daemon is outside the scope of the adapter.

func (*Params) Descriptor

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

func (*Params) Equal

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

func (*Params) GetAddress

func (m *Params) GetAddress() string

func (*Params) GetBufferLength

func (m *Params) GetBufferLength() int32

func (*Params) GetGlobalTags

func (m *Params) GetGlobalTags() map[string]string

func (*Params) GetMetrics

func (m *Params) GetMetrics() map[string]*Params_MetricInfo

func (*Params) GetPrefix

func (m *Params) GetPrefix() string

func (*Params) GetSampleRate

func (m *Params) GetSampleRate() float64

func (*Params) GoString

func (this *Params) GoString() string

func (*Params) Marshal

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

func (*Params) MarshalTo

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

func (*Params) ProtoMessage

func (*Params) ProtoMessage()

func (*Params) Reset

func (m *Params) Reset()

func (*Params) Size

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

func (*Params) String

func (this *Params) String() string

func (*Params) Unmarshal

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

type Params_MetricInfo

type Params_MetricInfo struct {
	// Name of the metric in DataDog
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The type of metric
	Type Params_MetricInfo_Type `protobuf:"varint,2,opt,name=type,proto3,enum=adapter.dogstatsd.config.Params_MetricInfo_Type" json:"type,omitempty"`
	// Tags to add to the metric in addition to the dimensions. "tag": "val" becomes "tag:val" in DataDog
	// Default: []
	Tags map[string]string `` /* 142-byte string literal not displayed */
}

Describes how to represent this metric in DataDog

func (*Params_MetricInfo) Descriptor

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

func (*Params_MetricInfo) Equal

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

func (*Params_MetricInfo) GetName

func (m *Params_MetricInfo) GetName() string

func (*Params_MetricInfo) GetTags

func (m *Params_MetricInfo) GetTags() map[string]string

func (*Params_MetricInfo) GetType

func (m *Params_MetricInfo) GetType() Params_MetricInfo_Type

func (*Params_MetricInfo) GoString

func (this *Params_MetricInfo) GoString() string

func (*Params_MetricInfo) Marshal

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

func (*Params_MetricInfo) MarshalTo

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

func (*Params_MetricInfo) ProtoMessage

func (*Params_MetricInfo) ProtoMessage()

func (*Params_MetricInfo) Reset

func (m *Params_MetricInfo) Reset()

func (*Params_MetricInfo) Size

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

func (*Params_MetricInfo) String

func (this *Params_MetricInfo) String() string

func (*Params_MetricInfo) Unmarshal

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

type Params_MetricInfo_Type

type Params_MetricInfo_Type int32

Describes the type of metric

const (
	// Default Unknown Type
	UNKNOWN_TYPE Params_MetricInfo_Type = 0
	// Increments a DataDog counter
	COUNTER Params_MetricInfo_Type = 1
	// Sets the new value of a DataDog gauge
	GAUGE Params_MetricInfo_Type = 2
	// DISTRIBUTION is converted to a Timing Histogram for metrics with a time unit and a Histogram for all other units
	DISTRIBUTION Params_MetricInfo_Type = 3
)

func (Params_MetricInfo_Type) EnumDescriptor

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

func (Params_MetricInfo_Type) String

func (x Params_MetricInfo_Type) String() string