mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 05:52:51 +00:00
11dbb1b277
# Which Problems Are Solved Streams allow differentiating logs produced by different components of Zitadel. # How the Problems Are Solved The `backend/v3/instrumentation/logging` package now exposes convenience function for setting and getting a logger from the context. As well as high-level functions to emit log records at various levels. When constructing a new logger a "stream" needs to be specified: - **runtime**: General runtime logs, such as startup and shutdown messages. Default for logs that do not belong to the other categories. - **request**: Logs for incoming API and HTTP requests. - **event_handler**: Logs for event handling in projections. - **queue**: Logs for the job queue processing. - **event_pusher**: Logs for event pushing to the database. Disabled by default, contains sensitive information. Each line from the returned logger contains a `stream` field as well as a `version` field with the current Zitadel version. ## Runtime config Streams can be enabled by passing an array of stream names in the runtime config. Because some log streams may contain sensitive data (especially events), it is now also possible to mask values by their key. # Additional Changes - Wrap `slogctx` in the `logging` package. (Except API error converter packages, because of import cycle) - Add some docs to `logging` package so other devs understand how to add logging to Zitadel - Add `logging.OnError` and `logging.WithError` helper functions with `Panic()` and `Fatal()` methods, to preserve current calls in the `cmd` packages. - Add instance context extractor. - Only output request details in the request info log. Request ID remains propagated through context. - Moved middleware functionality into protocol specific packages. - Removed setting of URI to context in metric middleware. There were ony setters and no getters. (Unused value) - Reuse a single statusWriter in the middleware package for middlewares that need to know the response status. # Additional Context - Closes #11333 - Closes #11331 - Partly #11330 --------- Co-authored-by: Silvan <[email protected]>
81 lines
2.1 KiB
Go
81 lines
2.1 KiB
Go
// Package instrumentation initializes and configures telemetry and logging instrumentation.
|
|
// After [Start] is called, the instrumentation providers can be accessed using global getters.
|
|
package instrumentation
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
"slices"
|
|
"strings"
|
|
"sync"
|
|
|
|
"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
|
|
"go.opentelemetry.io/otel"
|
|
"go.opentelemetry.io/otel/metric"
|
|
"go.opentelemetry.io/otel/sdk/log"
|
|
"go.opentelemetry.io/otel/trace"
|
|
)
|
|
|
|
const Name = "zitadel/backend/v3/instrumentation/tracing"
|
|
|
|
type Config struct {
|
|
ServiceName string
|
|
Trace TraceConfig
|
|
Metric MetricConfig
|
|
Log LogConfig
|
|
Profile ProfileConfig
|
|
}
|
|
|
|
type ShutdownFunc func(context.Context) error
|
|
|
|
var (
|
|
startOnce sync.Once
|
|
shutdown ShutdownFunc
|
|
errStart error
|
|
)
|
|
|
|
// Start initializes global instrumentation once, based on the provided configuration.
|
|
// It is safe to call multiple times; subsequent calls will return the same shutdown function and error as the first call.
|
|
func Start(ctx context.Context, cfg Config) (ShutdownFunc, error) {
|
|
startOnce.Do(func() {
|
|
errStart = startProfiler(cfg.Profile, cfg.ServiceName)
|
|
if errStart != nil {
|
|
return
|
|
}
|
|
var logProvider *log.LoggerProvider
|
|
logProvider, shutdown, errStart = setupOTelSDK(ctx, cfg)
|
|
if errStart != nil {
|
|
return
|
|
}
|
|
setLogger(logProvider, cfg.Log)
|
|
})
|
|
return shutdown, errStart
|
|
}
|
|
|
|
// NewTracer creates a new tracer from the global provider.
|
|
// See [trace.TracerProvider.Tracer] for details.
|
|
func NewTracer(name string, options ...trace.TracerOption) *Tracer {
|
|
provider := otel.GetTracerProvider()
|
|
return &Tracer{provider.Tracer(name, options...)}
|
|
}
|
|
|
|
// NewMeter creates a new meter from the global provider.
|
|
// See [metric.MeterProvider.Meter] for details.
|
|
func NewMeter(name string, options ...metric.MeterOption) *Meter {
|
|
provider := otel.GetMeterProvider()
|
|
return &Meter{
|
|
Meter: provider.Meter(name, options...),
|
|
}
|
|
}
|
|
|
|
func RequestFilter(ignoredPrefix ...string) otelhttp.Filter {
|
|
return func(r *http.Request) bool {
|
|
return !slices.ContainsFunc(
|
|
ignoredPrefix,
|
|
func(endpoint string) bool {
|
|
return strings.HasPrefix(r.URL.RequestURI(), endpoint)
|
|
},
|
|
)
|
|
}
|
|
}
|