Skip to content
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

Add more tracing instrumentation #885

Merged
merged 7 commits into from
Mar 13, 2024
Merged

Add more tracing instrumentation #885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
74df77e
Enable telemetry in all services
sevein Mar 11, 2024
57ed379
Use automatic tracing in database/sql
sevein Mar 11, 2024
b8343e0
Bump goa from 3.14.1 to 3.15.1
sevein Mar 11, 2024
56896d9
Remove deprecated middleware RequestID
sevein Mar 11, 2024
a069c8e
Enable Goa OTel plugin for route tagging
sevein Mar 11, 2024
6a1ff2a
Use Temporal Go SDK OTel interceptor
sevein Mar 11, 2024
b7c471e
Disable analytics reporting in Grafana
sevein Mar 11, 2024
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
2 changes: 2 additions & 0 deletions .golangci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ linters-settings:
no-unaliased: true
no-extra-aliases: false
alias:
- pkg: go.temporal.io/sdk/contrib/(\w+)
alias: temporalsdk_contrib_$1
- pkg: go.temporal.io/sdk/(\w+)
alias: temporalsdk_$1
- pkg: go.temporal.io/api/(\w+)
Expand Down
31 changes: 26 additions & 5 deletions cmd/enduro-a3m-worker/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ import (
"go.artefactual.dev/tools/log"
temporalsdk_activity "go.temporal.io/sdk/activity"
temporalsdk_client "go.temporal.io/sdk/client"
temporalsdk_contrib_opentelemetry "go.temporal.io/sdk/contrib/opentelemetry"
temporalsdk_interceptor "go.temporal.io/sdk/interceptor"
temporalsdk_worker "go.temporal.io/sdk/worker"
goahttp "goa.design/goa/v3/http"

Expand All @@ -28,6 +30,7 @@ import (
"github.com/artefactual-sdps/enduro/internal/db"
"github.com/artefactual-sdps/enduro/internal/event"
"github.com/artefactual-sdps/enduro/internal/package_"
"github.com/artefactual-sdps/enduro/internal/telemetry"
"github.com/artefactual-sdps/enduro/internal/temporal"
"github.com/artefactual-sdps/enduro/internal/version"
"github.com/artefactual-sdps/enduro/internal/watcher"
Expand Down Expand Up @@ -76,17 +79,35 @@ func main() {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

enduroDatabase, err := db.Connect(cfg.Database.Driver, cfg.Database.DSN)
// Set up the tracer provider.
tp, shutdown, err := telemetry.TracerProvider(ctx, logger, cfg.Telemetry, appName, version.Long)
if err != nil {
logger.Error(err, "Error creating tracer provider.")
os.Exit(1)
}
defer func() { _ = shutdown(ctx) }()

enduroDatabase, err := db.Connect(ctx, tp, cfg.Database.Driver, cfg.Database.DSN)
if err != nil {
logger.Error(err, "Enduro database configuration failed.")
os.Exit(1)
}
_ = enduroDatabase.Ping()

// Set up the Temporal client.
tracingInterceptor, err := temporalsdk_contrib_opentelemetry.NewTracingInterceptor(
temporalsdk_contrib_opentelemetry.TracerOptions{
Tracer: tp.Tracer("temporal-sdk-go"),
},
)
if err != nil {
logger.Error(err, "Unable to create OpenTelemetry interceptor.")
os.Exit(1)
}
temporalClient, err := temporalsdk_client.Dial(temporalsdk_client.Options{
Namespace: cfg.Temporal.Namespace,
HostPort: cfg.Temporal.Address,
Logger: temporal.Logger(logger.WithName("temporal-client")),
Namespace: cfg.Temporal.Namespace,
HostPort: cfg.Temporal.Address,
Logger: temporal.Logger(logger.WithName("temporal-client")),
Interceptors: []temporalsdk_interceptor.ClientInterceptor{tracingInterceptor},
})
if err != nil {
logger.Error(err, "Error creating Temporal client.")
Expand Down
30 changes: 26 additions & 4 deletions cmd/enduro-am-worker/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ import (
"go.artefactual.dev/tools/log"
temporalsdk_activity "go.temporal.io/sdk/activity"
temporalsdk_client "go.temporal.io/sdk/client"
temporalsdk_contrib_opentelemetry "go.temporal.io/sdk/contrib/opentelemetry"
temporalsdk_interceptor "go.temporal.io/sdk/interceptor"
temporalsdk_worker "go.temporal.io/sdk/worker"

"github.com/artefactual-sdps/enduro/internal/am"
Expand All @@ -28,6 +30,7 @@ import (
"github.com/artefactual-sdps/enduro/internal/event"
"github.com/artefactual-sdps/enduro/internal/package_"
"github.com/artefactual-sdps/enduro/internal/sftp"
"github.com/artefactual-sdps/enduro/internal/telemetry"
"github.com/artefactual-sdps/enduro/internal/temporal"
"github.com/artefactual-sdps/enduro/internal/version"
"github.com/artefactual-sdps/enduro/internal/watcher"
Expand Down Expand Up @@ -76,17 +79,36 @@ func main() {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

enduroDatabase, err := db.Connect(cfg.Database.Driver, cfg.Database.DSN)
// Set up the tracer provider.
tp, shutdown, err := telemetry.TracerProvider(ctx, logger, cfg.Telemetry, appName, version.Long)
if err != nil {
logger.Error(err, "Error creating tracer provider.")
os.Exit(1)
}
defer func() { _ = shutdown(ctx) }()

enduroDatabase, err := db.Connect(ctx, tp, cfg.Database.Driver, cfg.Database.DSN)
if err != nil {
logger.Error(err, "Enduro database configuration failed.")
os.Exit(1)
}
_ = enduroDatabase.Ping()

// Set up the Temporal client.
tracingInterceptor, err := temporalsdk_contrib_opentelemetry.NewTracingInterceptor(
temporalsdk_contrib_opentelemetry.TracerOptions{
Tracer: tp.Tracer("temporal-sdk-go"),
},
)
if err != nil {
logger.Error(err, "Unable to create OpenTelemetry interceptor.")
os.Exit(1)
}
temporalClient, err := temporalsdk_client.Dial(temporalsdk_client.Options{
Namespace: cfg.Temporal.Namespace,
HostPort: cfg.Temporal.Address,
Logger: temporal.Logger(logger.WithName("temporal-client")),
Namespace: cfg.Temporal.Namespace,
HostPort: cfg.Temporal.Address,
Logger: temporal.Logger(logger.WithName("temporal-client")),
Interceptors: []temporalsdk_interceptor.ClientInterceptor{tracingInterceptor},
})
if err != nil {
logger.Error(err, "Error creating Temporal client.")
Expand Down
18 changes: 10 additions & 8 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ require (
buf.build/gen/go/artefactual/a3m/protocolbuffers/go v1.31.0-20230508184533-2e9432075630.2
chainguard.dev/go-oidctest v0.2.0
entgo.io/ent v0.12.5
github.com/XSAM/otelsql v0.29.0
github.com/alicebob/miniredis/v2 v2.31.0
github.com/aws/aws-sdk-go-v2 v1.24.0
github.com/aws/aws-sdk-go-v2/config v1.26.2
Expand Down Expand Up @@ -41,7 +42,7 @@ require (
github.com/spf13/afero v1.11.0
github.com/spf13/pflag v1.0.5
github.com/spf13/viper v1.18.2
github.com/stretchr/testify v1.8.4
github.com/stretchr/testify v1.9.0
go.artefactual.dev/amclient v0.3.0
go.artefactual.dev/tools v0.8.0
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.49.0
Expand All @@ -51,9 +52,10 @@ require (
go.opentelemetry.io/otel/trace v1.24.0
go.temporal.io/api v1.24.0
go.temporal.io/sdk v1.25.1
go.temporal.io/sdk/contrib/opentelemetry v0.3.0
go.uber.org/mock v0.4.0
goa.design/goa/v3 v3.14.1
goa.design/plugins/v3 v3.14.1
goa.design/goa/v3 v3.15.1
goa.design/plugins/v3 v3.15.1
gocloud.dev v0.35.0
golang.org/x/crypto v0.21.0
google.golang.org/grpc v1.62.1
Expand Down Expand Up @@ -93,7 +95,7 @@ require (
github.com/dsnet/compress v0.0.2-0.20210315054119-f66993602bf5 // indirect
github.com/facebookgo/clock v0.0.0-20150410010913-600d898af40a // indirect
github.com/felixge/httpsnoop v1.0.4 // indirect
github.com/go-chi/chi/v5 v5.0.11 // indirect
github.com/go-chi/chi/v5 v5.0.12 // indirect
github.com/go-jose/go-jose/v3 v3.0.3 // indirect
github.com/go-logr/stdr v1.2.2 // indirect
github.com/go-logr/zapr v1.3.0 // indirect
Expand Down Expand Up @@ -138,7 +140,7 @@ require (
github.com/sergi/go-diff v1.3.1 // indirect
github.com/sourcegraph/conc v0.3.0 // indirect
github.com/spf13/cast v1.6.0 // indirect
github.com/stretchr/objx v0.5.1 // indirect
github.com/stretchr/objx v0.5.2 // indirect
github.com/subosito/gotenv v1.6.0 // indirect
github.com/ulikunitz/xz v0.5.11 // indirect
github.com/xi2/xz v0.0.0-20171230120015-48954b6210f8 // indirect
Expand All @@ -150,16 +152,16 @@ require (
go.opentelemetry.io/proto/otlp v1.1.0 // indirect
go.uber.org/atomic v1.11.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
go.uber.org/zap v1.26.0 // indirect
go.uber.org/zap v1.27.0 // indirect
golang.org/x/exp v0.0.0-20231219180239-dc181d75b848 // indirect
golang.org/x/mod v0.14.0 // indirect
golang.org/x/mod v0.15.0 // indirect
golang.org/x/net v0.21.0 // indirect
golang.org/x/oauth2 v0.16.0 // indirect
golang.org/x/sync v0.6.0 // indirect
golang.org/x/sys v0.18.0 // indirect
golang.org/x/text v0.14.0 // indirect
golang.org/x/time v0.5.0 // indirect
golang.org/x/tools v0.16.1 // indirect
golang.org/x/tools v0.18.0 // indirect
golang.org/x/xerrors v0.0.0-20231012003039-104605ab7028 // indirect
google.golang.org/api v0.154.0 // indirect
google.golang.org/appengine v1.6.8 // indirect
Expand Down
Loading
Loading