Migration from v0

The Go SDK now uses OpenTelemetry to collect and send metrics, logs, and traces.

Request logging and tracing are now enabled by default. If you previously used the SDK for metrics only, set SampleRate = 0 to keep that behavior.

Installation and setup

The SDK now requires Go 1.25 or later. Upgrade the module for your framework:

go get github.com/apitally/apitally-go/chi-v5

go get github.com/apitally/apitally-go/echo-v5

go get github.com/apitally/apitally-go/echo-v4

go get github.com/apitally/apitally-go/fiber-v3

go get github.com/apitally/apitally-go/fiber-v2

go get github.com/apitally/apitally-go/gin-v1

The Gin module has been renamed from github.com/apitally/apitally-go/gin to github.com/apitally/apitally-go/gin-v1. Update your imports and remove the old module with go mod tidy.

Write tokens replace client IDs

The SDK now authenticates with a write token instead of a client ID. Your existing app’s token (apt_...) is available under Setup instructions in the Apitally dashboard. NewConfig() no longer takes a client ID. Set the WriteToken option, or set the APITALLY_WRITE_TOKEN environment variable.

`Init` replaces the middleware

Replace the Middleware registration with a call to Init, which registers everything the SDK needs. Call it after your recovery middleware and OpenTelemetry HTTP instrumentation, and before your other middleware and routes.

// Before
r := gin.Default()
config := apitally.NewConfig("your-client-id")
config.Env = "dev"
r.Use(apitally.Middleware(r, config))

// After
r := gin.Default()
cfg := apitally.NewConfig()
cfg.WriteToken = "your-write-token"
cfg.Env = "dev"
apitally.Init(r, cfg)

Graceful shutdown

Call the new apitally.Shutdown function when your application exits, after your HTTP server has stopped, so the SDK can deliver the remaining telemetry. The setup guides show the full pattern.

srv.Shutdown(ctx)
apitally.Shutdown(ctx)

Configuration changes

The RequestLoggingConfig type and the RequestLogging field have been removed. Their settings are now fields directly on Config, with the option changes listed below.

// Before
config := apitally.NewConfig("your-client-id")
config.RequestLogging = &apitally.RequestLoggingConfig{
    Enabled:         true,
    LogRequestBody:  true,
    LogResponseBody: true,
    MaskHeaders:     []*regexp.Regexp{regexp.MustCompile(`(?i)^X-Internal-`)},
}

// After
cfg := apitally.NewConfig()
cfg.WriteToken = "your-write-token"
cfg.CaptureRequestBody = true
cfg.CaptureResponseBody = true
cfg.MaskHeaders = []string{`^X-Internal-`}

Changed options

The following options have been changed:

Option	Change
`ClientID`	Replaced by `WriteToken`, which requires a new credential.
`RequestLogging.LogRequestHeaders`	Renamed to `CaptureRequestHeaders`.
`RequestLogging.LogRequestBody`	Renamed to `CaptureRequestBody`.
`RequestLogging.LogResponseHeaders`	Renamed to `CaptureResponseHeaders`.
`RequestLogging.LogResponseBody`	Renamed to `CaptureResponseBody`.
`RequestLogging.MaskQueryParams`	Moved to `MaskQueryParams`, now `[]string`.
`RequestLogging.MaskHeaders`	Moved to `MaskHeaders`, now `[]string`.
`RequestLogging.MaskBodyFields`	Moved to `MaskBodyFields`, now `[]string`.
`RequestLogging.ExcludePaths`	Moved to `ExcludePaths`, now `[]string`. Matches actual request paths instead of matched route patterns.
`RequestLogging.MaskRequestBodyCallback`	Moved to `MaskRequestBody` with new arguments.
`RequestLogging.MaskResponseBodyCallback`	Moved to `MaskResponseBody` with new arguments.
`RequestLogging.ExcludeCallback`	Replaced by `SampleOnRequest` or `SampleOnResponse` with new arguments and return values.

Pattern options now take regular expressions as strings instead of *regexp.Regexp values. They are matched case-insensitively unless a pattern sets its own flags, such as (?-i:...).

Removed options

These options have been removed:

Removed option	Migration
`RequestLogging`	Set its fields directly on `Config`, applying the changes above. Remove its `Enabled` flag.
`RequestLogging.Enabled` and `RequestLogging.CaptureTraces`	Previously defaulted to `false`. Request logging and tracing are now enabled by default. Use `SampleRate = 0` to disable request logs and traces.
`RequestLogging.LogQueryParams`	Query parameters are now always captured. To mask all values, use .
`RequestLogging.CaptureLogs`	Logs are captured when you wrap your `log/slog` handler with `NewSlogHandler` (see below).
`RequestLogging.LogPanic`	Panics are now always captured in request traces.
`DisableSync`	Use the `Disabled` option or the `APITALLY_DISABLED` environment variable. Apitally is also disabled in `go test` binaries.

The configuration reference lists all available options.

Consumer identification

The request helpers, such as SetConsumer(), now take a context.Context instead of the framework’s request or context type. This changes the call sites on Echo, Fiber v2 and Chi:

Framework	Before	After
Gin	`apitally.SetConsumer(c, ...)`	`apitally.SetConsumer(c, ...)`
Echo	`apitally.SetConsumer(c, ...)`	`apitally.SetConsumer(c.Request().Context(), ...)`
Fiber v3	`apitally.SetConsumer(c, ...)`	`apitally.SetConsumer(c, ...)`
Fiber v2	`apitally.SetConsumer(c, ...)`	`apitally.SetConsumer(c.UserContext(), ...)` or `c.Context()`
Chi	`apitally.SetConsumer(r, ...)`	`apitally.SetConsumer(r.Context(), ...)`

SetConsumerIdentifier has been removed. Use SetConsumer with only the Identifier field set.

// Before
apitally.SetConsumerIdentifier(c, user.ID)

// After
apitally.SetConsumer(ctx, apitally.Consumer{Identifier: user.ID})

You can also provide custom attributes for each consumer:

apitally.SetConsumer(ctx, apitally.Consumer{
    Identifier: user.ID,
    Name:       user.Name,                            // optional
    Group:      user.Group,                           // optional
    Attributes: map[string]string{"plan": user.Plan}, // optional
})

Validation errors

CaptureValidationError has been removed. Pass validation errors to CaptureError with the request context instead. See request context for the context to pass on each framework.

// Before
apitally.CaptureValidationError(c, err)

// After
apitally.CaptureError(ctx, err)

Application logs

The SDK no longer wraps the default log/slog handler automatically. To capture logs, wrap your handler with NewSlogHandler and log with the request context, for example with slog.InfoContext:

handler := slog.NewJSONHandler(os.Stdout, nil)
slog.SetDefault(slog.New(apitally.NewSlogHandler(handler)))

slog.InfoContext(ctx, "Order created", "order_id", order.ID)

Records logged without the request context are not linked to requests and are not captured. See request context for the context to pass on each framework.

Body masking callbacks

MaskRequestBodyCallback and MaskResponseBodyCallback are now named MaskRequestBody and MaskResponseBody. Both receive (span, body), rather than the Request and Response objects. The body is passed as []byte. Request metadata is available through span.Attributes(). For example, a callback that masks bodies for admin routes becomes:

// Before
config.RequestLogging.MaskRequestBodyCallback = func(request *apitally.Request) []byte {
    if strings.HasPrefix(request.Path, "/admin/") {
        return nil
    }
    return request.Body
}

// After
cfg.MaskRequestBody = func(span sdktrace.ReadOnlySpan, body []byte) []byte {
    attrs := attribute.NewSet(span.Attributes()...)
    route, _ := attrs.Value("http.route")
    if strings.HasPrefix(route.AsString(), "/admin/") {
        return nil
    }
    return body
}

Request exclusion

Use sampling callbacks to exclude requests: SampleOnRequest for early decisions based on the request, or SampleOnResponse for decisions based on the response status or consumer. Both receive the span as their only argument. The callbacks should return 1, true to capture the request, and 0, true to exclude it. Callbacks can also return any probability between 0 and 1. Returning false as the second value from SampleOnRequest applies SampleRate, and from SampleOnResponse preserves the earlier sampling decision. For example, to capture only error responses:

// Before
config.RequestLogging.ExcludeCallback = func(request *apitally.Request, response *apitally.Response) bool {
    return response.StatusCode < 400
}

// After
cfg.SampleOnResponse = func(span sdktrace.ReadOnlySpan) (float64, bool) {
    attrs := attribute.NewSet(span.Attributes()...)
    statusCode, _ := attrs.Value("http.response.status_code")
    if statusCode.AsInt64() >= 400 {
        return 1, true
    }
    return 0, true
}

Replace the ExcludeCallback option with the appropriate sampling callback. Note that captured headers and bodies are not available in sampling callbacks. Sampling affects request logs and traces, but not metrics. See sampling for details.

Path exclusions

ExcludePaths now matches request paths rather than matched route patterns. If a pattern contains route parameters, update it to match concrete values. For example, replace ^/users/:id$ with ^/users/[^/]+$ to match /users/123.

Existing OpenTelemetry setups

If your application registers a tracer provider from go.opentelemetry.io/otel/sdk/trace with otel.SetTracerProvider before starting the server, the SDK automatically adds its span processor. No manual registration is required. Review these settings when upgrading:

Sampling: Previously, your provider’s sampler affected traces but not Apitally’s request logs. It now affects both. Check that its sampling rate provides the request log coverage you want. Metrics remain unsampled.

Other changes

Network access: The SDK now sends data to otlp.apitally.io instead of hub.apitally.io. Update firewall allowlists if necessary.
Removed types: The ApitallyMiddleware, ApitallyConfig and ApitallyConsumer aliases and the Request and Response types have been removed from the public API.

SDK reference

Setup guides

Installation and setup

Write tokens replace client IDs

`Init` replaces the middleware

Graceful shutdown

Configuration changes

Changed options

Removed options

Consumer identification

Validation errors

Application logs

Body masking callbacks

Request exclusion

Path exclusions

Existing OpenTelemetry setups

Other changes

​Installation and setup

​Write tokens replace client IDs

​Init replaces the middleware

​Graceful shutdown

​Configuration changes

​Changed options

​Removed options

​Consumer identification

​Validation errors

​Application logs

​Body masking callbacks

​Request exclusion

​Path exclusions

​Existing OpenTelemetry setups

​Other changes

Installation and setup

Write tokens replace client IDs

`Init` replaces the middleware

Graceful shutdown

Configuration changes

Changed options

Removed options

Consumer identification

Validation errors

Application logs

Body masking callbacks

Request exclusion

Path exclusions

Existing OpenTelemetry setups

Other changes