traefik/pkg/types/metrics.go

94 lines
6.2 KiB
Go
Raw Normal View History

2018-11-14 09:18:03 +00:00
package types
import (
"time"
2018-11-14 09:18:03 +00:00
)
2019-07-18 19:36:05 +00:00
// Metrics provides options to expose and send Traefik metrics to different third party monitoring systems.
2018-11-14 09:18:03 +00:00
type Metrics struct {
2019-07-01 09:30:05 +00:00
Prometheus *Prometheus `description:"Prometheus metrics exporter type." json:"prometheus,omitempty" toml:"prometheus,omitempty" yaml:"prometheus,omitempty" export:"true" label:"allowEmpty"`
2019-09-02 10:18:04 +00:00
Datadog *Datadog `description:"Datadog metrics exporter type." json:"datadog,omitempty" toml:"datadog,omitempty" yaml:"datadog,omitempty" export:"true" label:"allowEmpty"`
2019-07-01 09:30:05 +00:00
StatsD *Statsd `description:"StatsD metrics exporter type." json:"statsD,omitempty" toml:"statsD,omitempty" yaml:"statsD,omitempty" export:"true" label:"allowEmpty"`
InfluxDB *InfluxDB `description:"InfluxDB metrics exporter type." json:"influxDB,omitempty" toml:"influxDB,omitempty" yaml:"influxDB,omitempty" label:"allowEmpty"`
2018-11-14 09:18:03 +00:00
}
2019-07-18 19:36:05 +00:00
// Prometheus can contain specific configuration used by the Prometheus Metrics exporter.
2018-11-14 09:18:03 +00:00
type Prometheus struct {
2019-07-18 19:36:05 +00:00
Buckets []float64 `description:"Buckets for latency metrics." json:"buckets,omitempty" toml:"buckets,omitempty" yaml:"buckets,omitempty" export:"true"`
AddEntryPointsLabels bool `description:"Enable metrics on entry points." json:"addEntryPointsLabels,omitempty" toml:"addEntryPointsLabels,omitempty" yaml:"addEntryPointsLabels,omitempty" export:"true"`
AddServicesLabels bool `description:"Enable metrics on services." json:"addServicesLabels,omitempty" toml:"addServicesLabels,omitempty" yaml:"addServicesLabels,omitempty" export:"true"`
2019-09-06 13:08:04 +00:00
EntryPoint string `description:"EntryPoint" export:"true" json:"entryPoint,omitempty" toml:"entryPoint,omitempty" yaml:"entryPoint,omitempty"`
}
// SetDefaults sets the default values.
func (p *Prometheus) SetDefaults() {
p.Buckets = []float64{0.1, 0.3, 1.2, 5}
2019-07-18 19:36:05 +00:00
p.AddEntryPointsLabels = true
p.AddServicesLabels = true
2019-09-06 13:08:04 +00:00
p.EntryPoint = "traefik"
2018-11-14 09:18:03 +00:00
}
2019-09-02 10:18:04 +00:00
// Datadog contains address and metrics pushing interval configuration.
type Datadog struct {
Address string `description:"Datadog's address." json:"address,omitempty" toml:"address,omitempty" yaml:"address,omitempty"`
PushInterval Duration `description:"Datadog push interval." json:"pushInterval,omitempty" toml:"pushInterval,omitempty" yaml:"pushInterval,omitempty" export:"true"`
2019-07-18 19:36:05 +00:00
AddEntryPointsLabels bool `description:"Enable metrics on entry points." json:"addEntryPointsLabels,omitempty" toml:"addEntryPointsLabels,omitempty" yaml:"addEntryPointsLabels,omitempty" export:"true"`
AddServicesLabels bool `description:"Enable metrics on services." json:"addServicesLabels,omitempty" toml:"addServicesLabels,omitempty" yaml:"addServicesLabels,omitempty" export:"true"`
}
// SetDefaults sets the default values.
2019-09-02 10:18:04 +00:00
func (d *Datadog) SetDefaults() {
d.Address = "localhost:8125"
d.PushInterval = Duration(10 * time.Second)
2019-07-18 19:36:05 +00:00
d.AddEntryPointsLabels = true
d.AddServicesLabels = true
2018-11-14 09:18:03 +00:00
}
2019-07-18 19:36:05 +00:00
// Statsd contains address and metrics pushing interval configuration.
2018-11-14 09:18:03 +00:00
type Statsd struct {
2019-07-18 19:36:05 +00:00
Address string `description:"StatsD address." json:"address,omitempty" toml:"address,omitempty" yaml:"address,omitempty"`
PushInterval Duration `description:"StatsD push interval." json:"pushInterval,omitempty" toml:"pushInterval,omitempty" yaml:"pushInterval,omitempty" export:"true"`
AddEntryPointsLabels bool `description:"Enable metrics on entry points." json:"addEntryPointsLabels,omitempty" toml:"addEntryPointsLabels,omitempty" yaml:"addEntryPointsLabels,omitempty" export:"true"`
AddServicesLabels bool `description:"Enable metrics on services." json:"addServicesLabels,omitempty" toml:"addServicesLabels,omitempty" yaml:"addServicesLabels,omitempty" export:"true"`
}
// SetDefaults sets the default values.
func (s *Statsd) SetDefaults() {
s.Address = "localhost:8125"
s.PushInterval = Duration(10 * time.Second)
2019-07-18 19:36:05 +00:00
s.AddEntryPointsLabels = true
s.AddServicesLabels = true
2018-11-14 09:18:03 +00:00
}
2019-07-18 19:36:05 +00:00
// InfluxDB contains address, login and metrics pushing interval configuration.
2018-11-14 09:18:03 +00:00
type InfluxDB struct {
2019-07-18 19:36:05 +00:00
Address string `description:"InfluxDB address." json:"address,omitempty" toml:"address,omitempty" yaml:"address,omitempty"`
Protocol string `description:"InfluxDB address protocol (udp or http)." json:"protocol,omitempty" toml:"protocol,omitempty" yaml:"protocol,omitempty"`
PushInterval Duration `description:"InfluxDB push interval." json:"pushInterval,omitempty" toml:"pushInterval,omitempty" yaml:"pushInterval,omitempty" export:"true"`
Database string `description:"InfluxDB database used when protocol is http." json:"database,omitempty" toml:"database,omitempty" yaml:"database,omitempty" export:"true"`
RetentionPolicy string `description:"InfluxDB retention policy used when protocol is http." json:"retentionPolicy,omitempty" toml:"retentionPolicy,omitempty" yaml:"retentionPolicy,omitempty" export:"true"`
Username string `description:"InfluxDB username (only with http)." json:"username,omitempty" toml:"username,omitempty" yaml:"username,omitempty" export:"true"`
Password string `description:"InfluxDB password (only with http)." json:"password,omitempty" toml:"password,omitempty" yaml:"password,omitempty" export:"true"`
AddEntryPointsLabels bool `description:"Enable metrics on entry points." json:"addEntryPointsLabels,omitempty" toml:"addEntryPointsLabels,omitempty" yaml:"addEntryPointsLabels,omitempty" export:"true"`
AddServicesLabels bool `description:"Enable metrics on services." json:"addServicesLabels,omitempty" toml:"addServicesLabels,omitempty" yaml:"addServicesLabels,omitempty" export:"true"`
2018-11-14 09:18:03 +00:00
}
// SetDefaults sets the default values.
func (i *InfluxDB) SetDefaults() {
i.Address = "localhost:8089"
i.Protocol = "udp"
i.PushInterval = Duration(10 * time.Second)
2019-07-18 19:36:05 +00:00
i.AddEntryPointsLabels = true
i.AddServicesLabels = true
2018-11-14 09:18:03 +00:00
}
2019-07-18 19:36:05 +00:00
// Statistics provides options for monitoring request and response stats.
type Statistics struct {
2019-07-01 09:30:05 +00:00
RecentErrors int `description:"Number of recent errors logged." json:"recentErrors,omitempty" toml:"recentErrors,omitempty" yaml:"recentErrors,omitempty" export:"true"`
2018-11-14 09:18:03 +00:00
}
// SetDefaults sets the default values.
func (s *Statistics) SetDefaults() {
s.RecentErrors = 10
2018-11-14 09:18:03 +00:00
}