mirror of
https://github.com/zitadel/zitadel.git
synced 2025-11-16 03:34:48 +00:00
01bbcc1a48
# Which Problems Are Solved
There were multiple issues in the OpenTelemetry (OTEL) implementation
and usage for tracing and metrics, which lead to high cardinality and
potential memory leaks:
- wrongly initiated tracing interceptors
- high cardinality in traces:
- HTTP/1.1 endpoints containing host names
- HTTP/1.1 endpoints containing object IDs like userID (e.g.
`/management/v1/users/2352839823/`)
- high amount of traces from internal processes (spooler)
- high cardinality in metrics endpoint:
- GRPC entries containing host names
- notification metrics containing instanceIDs and error messages
# How the Problems Are Solved
- Properly initialize the interceptors once and update them to use the
grpc stats handler (unary interceptors were deprecated).
- Remove host names from HTTP/1.1 span names and use path as default.
- Set / overwrite the uri for spans on the grpc-gateway with the uri
pattern (`/management/v1/users/{user_id}`). This is used for spans in
traces and metric entries.
- Created a new sampler which will only sample spans in the following
cases:
- remote was already sampled
- remote was not sampled, root span is of kind `Server` and based on
fraction set in the runtime configuration
- This will prevent having a lot of spans from the spooler back ground
jobs if they were not started by a client call querying an object (e.g.
UserByID).
- Filter out host names and alike from OTEL generated metrics (using a
`view`).
- Removed instance and error messages from notification metrics.
# Additional Changes
Fixed the middleware handling for serving Console. Telemetry and
instance selection are only used for the environment.json, but not on
statically served files.
# Additional Context
- closes #8096
- relates to #9074
- back ports to at least 2.66.x, 2.67.x and 2.68.x
(cherry picked from commit 990e1982c7)
40 lines
912 B
Go
40 lines
912 B
Go
package google
|
|
|
|
import (
|
|
texporter "github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/trace"
|
|
sdk_trace "go.opentelemetry.io/otel/sdk/trace"
|
|
|
|
"github.com/zitadel/zitadel/internal/telemetry/tracing"
|
|
"github.com/zitadel/zitadel/internal/telemetry/tracing/otel"
|
|
)
|
|
|
|
type Config struct {
|
|
ProjectID string
|
|
Fraction float64
|
|
}
|
|
|
|
func NewTracer(rawConfig map[string]interface{}) (err error) {
|
|
c := new(Config)
|
|
c.ProjectID, _ = rawConfig["projectid"].(string)
|
|
c.Fraction, err = otel.FractionFromConfig(rawConfig["fraction"])
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return c.NewTracer()
|
|
}
|
|
|
|
type Tracer struct {
|
|
otel.Tracer
|
|
}
|
|
|
|
func (c *Config) NewTracer() error {
|
|
sampler := otel.NewSampler(sdk_trace.TraceIDRatioBased(c.Fraction))
|
|
exporter, err := texporter.New(texporter.WithProjectID(c.ProjectID))
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
tracing.T, err = otel.NewTracer(sampler, exporter)
|
|
return err
|
|
}
|