feat: allow setting service.name for OTLP metrics

This commit is contained in:
Carlos Martell 2024-09-27 02:58:05 -07:00 committed by GitHub
parent 7bb181dfa0
commit eccfcc0924
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 202 additions and 143 deletions

View file

@ -283,3 +283,7 @@ issues:
- path: pkg/provider/acme/local_store.go - path: pkg/provider/acme/local_store.go
linters: linters:
- musttag - musttag
- path: pkg/types/metrics.go
linters:
- goconst

View file

@ -139,6 +139,28 @@ metrics:
--metrics.otlp.pushInterval=10s --metrics.otlp.pushInterval=10s
``` ```
#### `serviceName`
_Optional, Default="traefik"_
OTEL service name to use.
```yaml tab="File (YAML)"
metrics:
otlp:
serviceName: name
```
```toml tab="File (TOML)"
[metrics]
[metrics.otlp]
serviceName = "name"
```
```bash tab="CLI"
--metrics.otlp.serviceName=name
```
### HTTP configuration ### HTTP configuration
_Optional_ _Optional_

View file

@ -429,6 +429,9 @@ TLS key
`--metrics.otlp.pushinterval`: `--metrics.otlp.pushinterval`:
Period between calls to collect a checkpoint. (Default: ```10```) Period between calls to collect a checkpoint. (Default: ```10```)
`--metrics.otlp.servicename`:
OTEL service name to use. (Default: ```traefik```)
`--metrics.prometheus`: `--metrics.prometheus`:
Prometheus metrics exporter type. (Default: ```false```) Prometheus metrics exporter type. (Default: ```false```)

View file

@ -429,6 +429,9 @@ TLS key
`TRAEFIK_METRICS_OTLP_PUSHINTERVAL`: `TRAEFIK_METRICS_OTLP_PUSHINTERVAL`:
Period between calls to collect a checkpoint. (Default: ```10```) Period between calls to collect a checkpoint. (Default: ```10```)
`TRAEFIK_METRICS_OTLP_SERVICENAME`:
OTEL service name to use. (Default: ```traefik```)
`TRAEFIK_METRICS_PROMETHEUS`: `TRAEFIK_METRICS_PROMETHEUS`:
Prometheus metrics exporter type. (Default: ```false```) Prometheus metrics exporter type. (Default: ```false```)

View file

@ -342,6 +342,7 @@
addServicesLabels = true addServicesLabels = true
explicitBoundaries = [42.0, 42.0] explicitBoundaries = [42.0, 42.0]
pushInterval = "42s" pushInterval = "42s"
serviceName = "foobar"
[metrics.otlp.grpc] [metrics.otlp.grpc]
endpoint = "foobar" endpoint = "foobar"
insecure = true insecure = true

View file

@ -402,6 +402,7 @@ metrics:
- 42 - 42
- 42 - 42
pushInterval: 42s pushInterval: 42s
serviceName: foobar
ping: ping:
entryPoint: foobar entryPoint: foobar
manualRouting: true manualRouting: true

View file

@ -207,7 +207,7 @@ func newOpenTelemetryMeterProvider(ctx context.Context, config *types.OTLP) (*sd
} }
res, err := resource.New(ctx, res, err := resource.New(ctx,
resource.WithAttributes(semconv.ServiceNameKey.String("traefik")), resource.WithAttributes(semconv.ServiceNameKey.String(config.ServiceName)),
resource.WithAttributes(semconv.ServiceVersionKey.String(version.Version)), resource.WithAttributes(semconv.ServiceVersionKey.String(version.Version)),
resource.WithFromEnv(), resource.WithFromEnv(),
resource.WithTelemetrySDK(), resource.WithTelemetrySDK(),

View file

@ -282,6 +282,21 @@ func TestOpenTelemetry_GaugeCollectorSet(t *testing.T) {
} }
func TestOpenTelemetry(t *testing.T) { func TestOpenTelemetry(t *testing.T) {
tests := []struct {
desc string
serviceName string
}{
{
desc: "default",
},
{
desc: "custom-service-name",
serviceName: "custom-service-name",
},
}
for _, test := range tests {
t.Run(test.desc, func(t *testing.T) {
c := make(chan *string, 5) c := make(chan *string, 5)
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
@ -317,6 +332,12 @@ func TestOpenTelemetry(t *testing.T) {
} }
cfg.PushInterval = ptypes.Duration(10 * time.Millisecond) cfg.PushInterval = ptypes.Duration(10 * time.Millisecond)
wantServiceName := "traefik"
if test.serviceName != "" {
cfg.ServiceName = test.serviceName
wantServiceName = test.serviceName
}
registry := RegisterOpenTelemetry(context.Background(), &cfg) registry := RegisterOpenTelemetry(context.Background(), &cfg)
require.NotNil(t, registry) require.NotNil(t, registry)
@ -325,7 +346,7 @@ func TestOpenTelemetry(t *testing.T) {
} }
expected := []string{ expected := []string{
`({"key":"service.name","value":{"stringValue":"traefik"}})`, `({"key":"service.name","value":{"stringValue":"` + wantServiceName + `"}})`,
`({"key":"service.version","value":{"stringValue":"` + version.Version + `"}})`, `({"key":"service.version","value":{"stringValue":"` + version.Version + `"}})`,
} }
@ -427,6 +448,8 @@ func TestOpenTelemetry(t *testing.T) {
registry.EntryPointReqDurationHistogram().With("entrypoint", "myEntrypoint").Observe(20000) registry.EntryPointReqDurationHistogram().With("entrypoint", "myEntrypoint").Observe(20000)
tryAssertMessage(t, c, expectedEntryPointReqDuration) tryAssertMessage(t, c, expectedEntryPointReqDuration)
})
}
} }
func assertMessage(t *testing.T, msg string, expected []string) { func assertMessage(t *testing.T, msg string, expected []string) {

View file

@ -116,6 +116,7 @@ type OTLP struct {
AddServicesLabels bool `description:"Enable metrics on services." json:"addServicesLabels,omitempty" toml:"addServicesLabels,omitempty" yaml:"addServicesLabels,omitempty" export:"true"` AddServicesLabels bool `description:"Enable metrics on services." json:"addServicesLabels,omitempty" toml:"addServicesLabels,omitempty" yaml:"addServicesLabels,omitempty" export:"true"`
ExplicitBoundaries []float64 `description:"Boundaries for latency metrics." json:"explicitBoundaries,omitempty" toml:"explicitBoundaries,omitempty" yaml:"explicitBoundaries,omitempty" export:"true"` ExplicitBoundaries []float64 `description:"Boundaries for latency metrics." json:"explicitBoundaries,omitempty" toml:"explicitBoundaries,omitempty" yaml:"explicitBoundaries,omitempty" export:"true"`
PushInterval types.Duration `description:"Period between calls to collect a checkpoint." json:"pushInterval,omitempty" toml:"pushInterval,omitempty" yaml:"pushInterval,omitempty" export:"true"` PushInterval types.Duration `description:"Period between calls to collect a checkpoint." json:"pushInterval,omitempty" toml:"pushInterval,omitempty" yaml:"pushInterval,omitempty" export:"true"`
ServiceName string `description:"OTEL service name to use." json:"serviceName,omitempty" toml:"serviceName,omitempty" yaml:"serviceName,omitempty" export:"true"`
} }
// SetDefaults sets the default values. // SetDefaults sets the default values.
@ -127,6 +128,7 @@ func (o *OTLP) SetDefaults() {
o.AddServicesLabels = true o.AddServicesLabels = true
o.ExplicitBoundaries = []float64{.005, .01, .025, .05, .075, .1, .25, .5, .75, 1, 2.5, 5, 7.5, 10} o.ExplicitBoundaries = []float64{.005, .01, .025, .05, .075, .1, .25, .5, .75, 1, 2.5, 5, 7.5, 10}
o.PushInterval = types.Duration(10 * time.Second) o.PushInterval = types.Duration(10 * time.Second)
o.ServiceName = "traefik"
} }
// Statistics provides options for monitoring request and response stats. // Statistics provides options for monitoring request and response stats.