TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-08-11 16:47:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: Make service name configurable for Metrics and Tracing (#9563)

Browse Source 
# Which Problems Are Solved

The service name is hardcoded in the metrics code. Making the service
name to be configurable helps when running multiple instances of
Zitadel.

The defaults remain unchanged, the service name will be defaulted to
ZITADEL.

# How the Problems Are Solved

Add a config option to override the name in defaults.yaml and pass it
down to the corresponding metrics or tracing module (google or otel)

# Additional Changes
NA

# Additional Context
NA
This commit is contained in:
Harsha Reddy
2025-03-20 15:05:54 +05:30
committed by GitHub
parent 833e654a07
commit dc64e35128
7 changed files with 22 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
cmd/defaults.yaml
View File

@@ -14,6 +14,7 @@ Tracing:
# for type 'otel' is used for standard [open telemetry](https://opentelemetry.io) # for type 'otel' is used for standard [open telemetry](https://opentelemetry.io)
# Fraction: 1.0 # Fraction: 1.0
# Endpoint: 'otel.collector.endpoint' # Endpoint: 'otel.collector.endpoint'
# ServiceName: 'ZITADEL' # Name of the service in traces
# #
# type 'log' or '' disables tracing # type 'log' or '' disables tracing
# #
@@ -24,6 +25,8 @@ Tracing:
Fraction: 1.0 # ZITADEL_TRACING_FRACTION Fraction: 1.0 # ZITADEL_TRACING_FRACTION
# The endpoint of the otel collector endpoint # The endpoint of the otel collector endpoint
Endpoint: "" #ZITADEL_TRACING_ENDPOINT Endpoint: "" #ZITADEL_TRACING_ENDPOINT
# The name of the service in traces
ServiceName: "ZITADEL" #ZITADEL_TRACING_SERVICENAME
# Profiler enables capturing profiling data (CPU, Memory, ...) for performance analysis # Profiler enables capturing profiling data (CPU, Memory, ...) for performance analysis
Profiler: Profiler:

2
internal/telemetry/metrics/otel/open_telemetry.go
View File

@@ -27,7 +27,7 @@ type Metrics struct {
} }
func NewMetrics(meterName string) (metrics.Metrics, error) { func NewMetrics(meterName string) (metrics.Metrics, error) {
resource, err := otel_resource.ResourceWithService() resource, err := otel_resource.ResourceWithService("ZITADEL")
if err != nil { if err != nil {
return nil, err return nil, err
} }

4
internal/telemetry/otel/resource.go
View File

@@ -8,9 +8,9 @@ import (
"github.com/zitadel/zitadel/cmd/build" "github.com/zitadel/zitadel/cmd/build"
) )
func ResourceWithService() (*resource.Resource, error) { func ResourceWithService(serviceName string) (*resource.Resource, error) {
attributes := []attribute.KeyValue{ attributes := []attribute.KeyValue{
semconv.ServiceNameKey.String("ZITADEL"), semconv.ServiceNameKey.String(serviceName),
} }
if build.Version() != "" { if build.Version() != "" {
attributes = append(attributes, semconv.ServiceVersionKey.String(build.Version())) attributes = append(attributes, semconv.ServiceVersionKey.String(build.Version()))

8
internal/telemetry/tracing/google/google_tracer.go
View File

@@ -9,13 +9,15 @@ import (
) )
type Config struct { type Config struct {
ProjectID string ProjectID string
Fraction float64 Fraction float64
ServiceName string
} }
func NewTracer(rawConfig map[string]interface{}) (err error) { func NewTracer(rawConfig map[string]interface{}) (err error) {
c := new(Config) c := new(Config)
c.ProjectID, _ = rawConfig["projectid"].(string) c.ProjectID, _ = rawConfig["projectid"].(string)
c.ServiceName, _ = rawConfig["servicename"].(string)
c.Fraction, err = otel.FractionFromConfig(rawConfig["fraction"]) c.Fraction, err = otel.FractionFromConfig(rawConfig["fraction"])
if err != nil { if err != nil {
return err return err
@@ -34,6 +36,6 @@ func (c *Config) NewTracer() error {
return err return err
} }
tracing.T, err = otel.NewTracer(sampler, exporter) tracing.T, err = otel.NewTracer(sampler, exporter, c.ServiceName)
return err return err
} }

6
internal/telemetry/tracing/log/config.go
View File

@@ -9,12 +9,14 @@ import (
) )
type Config struct { type Config struct {
Fraction float64 Fraction float64
ServiceName string
} }
func NewTracer(rawConfig map[string]interface{}) (err error) { func NewTracer(rawConfig map[string]interface{}) (err error) {
c := new(Config) c := new(Config)
c.Fraction, err = otel.FractionFromConfig(rawConfig["fraction"]) c.Fraction, err = otel.FractionFromConfig(rawConfig["fraction"])
c.ServiceName, _ = rawConfig["servicename"].(string)
if err != nil { if err != nil {
return err return err
} }
@@ -32,6 +34,6 @@ func (c *Config) NewTracer() error {
return err return err
} }
tracing.T, err = otel.NewTracer(sampler, exporter) tracing.T, err = otel.NewTracer(sampler, exporter, c.ServiceName)
return err return err
} }

8
internal/telemetry/tracing/otel/config.go
View File

@@ -13,13 +13,15 @@ import (
) )
type Config struct { type Config struct {
Fraction float64 Fraction float64
Endpoint string Endpoint string
ServiceName string
} }
func NewTracerFromConfig(rawConfig map[string]interface{}) (err error) { func NewTracerFromConfig(rawConfig map[string]interface{}) (err error) {
c := new(Config) c := new(Config)
c.Endpoint, _ = rawConfig["endpoint"].(string) c.Endpoint, _ = rawConfig["endpoint"].(string)
c.ServiceName, _ = rawConfig["servicename"].(string)
c.Fraction, err = FractionFromConfig(rawConfig["fraction"]) c.Fraction, err = FractionFromConfig(rawConfig["fraction"])
if err != nil { if err != nil {
return err return err
@@ -54,7 +56,7 @@ func (c *Config) NewTracer() error {
return err return err
} }
tracing.T, err = NewTracer(sampler, exporter) tracing.T, err = NewTracer(sampler, exporter, c.ServiceName)
return err return err
} }

4
internal/telemetry/tracing/otel/open_telemetry.go
View File

@@ -18,8 +18,8 @@ type Tracer struct {
sampler sdk_trace.Sampler sampler sdk_trace.Sampler
} }
func NewTracer(sampler sdk_trace.Sampler, exporter sdk_trace.SpanExporter) (*Tracer, error) { func NewTracer(sampler sdk_trace.Sampler, exporter sdk_trace.SpanExporter, serviceName string) (*Tracer, error) {
resource, err := otel_resource.ResourceWithService() resource, err := otel_resource.ResourceWithService(serviceName)
if err != nil { if err != nil {
return nil, err return nil, err
} }