Skip to content

feat: add OpenTelemetry tracing support to log server #737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
miyunari wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: add OpenTelemetry tracing support to log server #737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions cmd/trillian_log_server/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ import (
"github.com/google/trillian/storage"
"github.com/google/trillian/util"
"github.com/google/trillian/util/clock"
oteltracing "github.com/sigstore/model-validation-operator/pkg/tracing"
clientv3 "go.etcd.io/etcd/client/v3"
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
"google.golang.org/grpc"
"k8s.io/klog/v2"

Expand Down Expand Up @@ -71,6 +73,12 @@ var (
tracingProjectID = flag.String("tracing_project_id", "", "project ID to pass to stackdriver. Can be empty for GCP, consult docs for other platforms.")
tracingPercent = flag.Int("tracing_percent", 0, "Percent of requests to be traced. Zero is a special case to use the DefaultSampler")

// OpenTelemetry tracing flags.
otelTracingEnabled = flag.Bool("tracing-enabled", false, "If true, OpenTelemetry tracing will be enabled with OTLP gRPC exporter")
otelTracingEndpoint = flag.String("tracing-endpoint", "", "OpenTelemetry collector endpoint (host:port). If empty, the SDK default (localhost:4317) is used")
otelTracingInsecure = flag.Bool("tracing-insecure", true, "If true, the OTLP gRPC connection will not use TLS")
otelTracingStdout = flag.Bool("tracing-stdout", false, "If true, traces are exported to stdout instead of OTLP (useful for debugging)")

configFile = flag.String("config", "", "Config file containing flags, file contents can be overridden by command line flags")

// Profiling related flags.
Expand Down Expand Up @@ -108,6 +116,31 @@ func main() {
options = append(options, opts...)
}

// Initialize OpenTelemetry tracing if enabled.
if *otelTracingEnabled {
tracingOpts := []oteltracing.Option{oteltracing.WithServiceName("trillian-logserver")}
if *otelTracingInsecure {
tracingOpts = append(tracingOpts, oteltracing.WithInsecure(true))
}
if *otelTracingEndpoint != "" {
tracingOpts = append(tracingOpts, oteltracing.WithEndpoint(*otelTracingEndpoint))
}
if *otelTracingStdout {
tracingOpts = append(tracingOpts, oteltracing.WithStdoutExporter())
}
shutdown, err := oteltracing.SetupTracing(ctx, tracingOpts...)
if err != nil {
klog.Exitf("Failed to initialize OpenTelemetry tracing: %v", err)
}
defer func() {
if err := shutdown(ctx); err != nil {
klog.Errorf("Error shutting down tracing: %v", err)
}
}()
klog.Info("OpenTelemetry tracing enabled")
options = append(options, grpc.StatsHandler(otelgrpc.NewServerHandler()))
}

if *maxMsgSize > 0 {
options = append(options, grpc.MaxRecvMsgSize(*maxMsgSize))
}
Expand Down
42 changes: 22 additions & 20 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,21 @@ require (
github.com/prometheus/client_golang v1.23.2
github.com/prometheus/client_model v0.6.2
github.com/pseudomuto/protoc-gen-doc v1.5.1
github.com/sigstore/model-validation-operator/pkg/tracing v0.0.0-20260613122948-a36fd5feae2c
github.com/transparency-dev/merkle v0.0.2
go.etcd.io/etcd/client/v3 v3.6.9
go.etcd.io/etcd/etcdctl/v3 v3.6.9
go.etcd.io/etcd/server/v3 v3.6.9
go.etcd.io/etcd/v3 v3.6.9
go.opencensus.io v0.24.0
golang.org/x/sync v0.20.0
golang.org/x/sys v0.42.0
golang.org/x/tools v0.43.0
golang.org/x/sys v0.45.0
golang.org/x/tools v0.44.0
google.golang.org/api v0.273.0
google.golang.org/genproto v0.0.0-20260319201613-d00831a3d3e7
google.golang.org/genproto/googleapis/api v0.0.0-20260319201613-d00831a3d3e7
google.golang.org/genproto/googleapis/rpc v0.0.0-20260319201613-d00831a3d3e7
google.golang.org/grpc v1.79.3
google.golang.org/genproto/googleapis/rpc v0.0.0-20260526163538-3dc84a4a5aaa
google.golang.org/grpc v1.81.1
google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.6.1
google.golang.org/protobuf v1.36.11
gopkg.in/yaml.v2 v2.4.0
Expand All @@ -54,6 +55,7 @@ require (
github.com/olekukonko/errors v0.0.0-20250405072817-4e6d85265da6 // indirect
github.com/olekukonko/ll v0.0.8-0.20250516010636-22ea57d81985 // indirect
github.com/rivo/uniseg v0.4.7 // indirect
go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.43.0 // indirect
)

require (
Expand All @@ -70,7 +72,7 @@ require (
cloud.google.com/go/trace v1.11.7 // indirect
filippo.io/edwards25519 v1.2.0 // indirect
github.com/GoogleCloudPlatform/grpc-gcp-go/grpcgcp v1.6.0 // indirect
github.com/GoogleCloudPlatform/opentelemetry-operations-go/detectors/gcp v1.30.0 // indirect
github.com/GoogleCloudPlatform/opentelemetry-operations-go/detectors/gcp v1.31.0 // indirect
github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/metric v0.55.0 // indirect
github.com/GoogleCloudPlatform/opentelemetry-operations-go/internal/resourcemapping v0.55.0 // indirect
github.com/Masterminds/goutils v1.1.1 // indirect
Expand Down Expand Up @@ -99,12 +101,12 @@ require (
github.com/docker/go-units v0.5.0 // indirect
github.com/dustin/go-humanize v1.0.1 // indirect
github.com/emicklei/go-restful/v3 v3.12.2 // indirect
github.com/envoyproxy/go-control-plane/envoy v1.36.0 // indirect
github.com/envoyproxy/go-control-plane/envoy v1.37.0 // indirect
github.com/envoyproxy/protoc-gen-validate v1.3.3 // indirect
github.com/fatih/color v1.18.0 // indirect
github.com/felixge/httpsnoop v1.0.4 // indirect
github.com/fxamacker/cbor/v2 v2.9.0 // indirect
github.com/go-jose/go-jose/v4 v4.1.3 // indirect
github.com/go-jose/go-jose/v4 v4.1.4 // indirect
github.com/go-logr/logr v1.4.3 // indirect
github.com/go-logr/stdr v1.2.2 // indirect
github.com/go-openapi/jsonpointer v0.22.5 // indirect
Expand Down Expand Up @@ -196,29 +198,29 @@ require (
go.etcd.io/gofail v0.2.0 // indirect
go.etcd.io/raft/v3 v3.6.0 // indirect
go.opentelemetry.io/auto/sdk v1.2.1 // indirect
go.opentelemetry.io/contrib/detectors/gcp v1.39.0 // indirect
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.67.0 // indirect
go.opentelemetry.io/contrib/detectors/gcp v1.42.0 // indirect
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.69.0
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.67.0 // indirect
go.opentelemetry.io/otel v1.42.0 // indirect
go.opentelemetry.io/otel v1.44.0 // indirect
go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.40.0 // indirect
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.40.0 // indirect
go.opentelemetry.io/otel/metric v1.42.0 // indirect
go.opentelemetry.io/otel/sdk v1.42.0 // indirect
go.opentelemetry.io/otel/sdk/metric v1.42.0 // indirect
go.opentelemetry.io/otel/trace v1.42.0 // indirect
go.opentelemetry.io/otel/metric v1.44.0 // indirect
go.opentelemetry.io/otel/sdk v1.44.0 // indirect
go.opentelemetry.io/otel/sdk/metric v1.44.0 // indirect
go.opentelemetry.io/otel/trace v1.44.0 // indirect
go.opentelemetry.io/proto/otlp v1.10.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
go.uber.org/zap v1.27.1 // indirect
go.yaml.in/yaml/v2 v2.4.3 // indirect
go.yaml.in/yaml/v3 v3.0.4 // indirect
golang.org/x/crypto v0.49.0 // indirect
golang.org/x/crypto v0.51.0 // indirect
golang.org/x/exp v0.0.0-20260312153236-7ab1446f8b90 // indirect
golang.org/x/mod v0.34.0 // indirect
golang.org/x/net v0.52.0 // indirect
golang.org/x/mod v0.35.0 // indirect
golang.org/x/net v0.55.0 // indirect
golang.org/x/oauth2 v0.36.0 // indirect
golang.org/x/telemetry v0.0.0-20260311193753-579e4da9a98c // indirect
golang.org/x/term v0.41.0 // indirect
golang.org/x/text v0.35.0 // indirect
golang.org/x/telemetry v0.0.0-20260409153401-be6f6cb8b1fa // indirect
golang.org/x/term v0.43.0 // indirect
golang.org/x/text v0.37.0 // indirect
golang.org/x/time v0.15.0 // indirect
gopkg.in/evanphx/json-patch.v4 v4.13.0 // indirect
gopkg.in/inf.v0 v0.9.1 // indirect
Expand Down
Loading
Loading