mirror of
https://github.com/SigNoz/signoz.git
synced 2026-03-26 06:00:25 +00:00
95ed125bd9
Some checks failed
build-staging / prepare (push) Has been cancelled
build-staging / js-build (push) Has been cancelled
build-staging / go-build (push) Has been cancelled
build-staging / staging (push) Has been cancelled
Release Drafter / update_release_draft (push) Has been cancelled
* feat(instrumentation): add OTel exception semantic convention log handler
Add a loghandler.Wrapper that enriches error log records with OpenTelemetry
exception semantic convention attributes (exception.type, exception.code,
exception.message, exception.stacktrace).
- Add errors.Attr() helper for standardized error logging under "exception" key
- Add exception log handler that replaces raw error attrs with structured group
- Wire exception handler into the instrumentation SDK logger chain
- Remove LogValue() from errors.base as the handler now owns structuring
* refactor: replace "error", err with errors.Attr(err) across codebase
Migrate all slog error logging from ad-hoc "error", err key-value pairs
to the standardized errors.Attr(err) helper, enabling the exception log
handler to enrich these logs with OTel semantic convention attributes.
* refactor: enforce attr-only slog style across codebase
Change sloglint from kv-only to attr-only, requiring all slog calls to
use typed attributes (slog.String, slog.Any, etc.) instead of key-value
pairs. Convert all existing kv-style slog calls in non-excluded paths.
* refactor: tighten slog.Any to specific types and standardize error attrs
- Replace slog.Any with slog.String for string values (action, key, where_clause)
- Replace slog.Any with slog.Uint64 for uint64 values (start, end, step, etc.)
- Replace slog.Any("err", err) with errors.Attr(err) in dispatcher and segment analytics
- Replace slog.Any("error", ctx.Err()) with errors.Attr in factory registry
* fix(instrumentation): use Unwrapb message for exception.message
Use the explicit error message (m) from Unwrapb instead of
foundErr.Error(), which resolves to the inner cause's message
for wrapped errors.
* feat(errors): capture stacktrace at error creation time
Store program counters ([]uintptr) in base errors at creation time
using runtime.Callers, inspired by thanos-io/thanos/pkg/errors. The
exception log handler reads the stacktrace from the error instead of
capturing at log time, showing where the error originated.
* fix(instrumentation): apply default log wrappers uniformly in NewLogger
Move correlation, filtering, and exception wrappers into NewLogger so
all call sites (including CLI loggers in cmd/) get them automatically.
* refactor(instrumentation): remove variadic wrappers from NewLogger
NewLogger no longer accepts arbitrary wrappers. The core wrappers
(correlation, filtering, exception) are hardcoded, preventing callers
from accidentally duplicating behavior.
* refactor: migrate remaining "error", <var> to errors.Attr across legacy paths
Replace all remaining "error", <variable> key-value pairs with
errors.Attr(<variable>) in pkg/query-service/ and ee/query-service/
paths that were missed in the initial migration due to non-standard
variable names (res.Err, filterErr, apiErrorObj.Err, etc).
* refactor(instrumentation): use flat exception.* keys instead of nested group
Use flat keys (exception.type, exception.code, exception.message,
exception.stacktrace) instead of a nested slog.Group in the exception
log handler.
77 lines
1.8 KiB
Go
77 lines
1.8 KiB
Go
package middleware
|
|
|
|
import (
|
|
"context"
|
|
"log/slog"
|
|
"net/http"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/SigNoz/signoz/pkg/errors"
|
|
)
|
|
|
|
const (
|
|
headerName string = "timeout"
|
|
)
|
|
|
|
type Timeout struct {
|
|
logger *slog.Logger
|
|
excluded map[string]struct{}
|
|
// The default timeout
|
|
defaultTimeout time.Duration
|
|
// The max allowed timeout
|
|
maxTimeout time.Duration
|
|
}
|
|
|
|
func NewTimeout(logger *slog.Logger, excludedRoutes []string, defaultTimeout time.Duration, maxTimeout time.Duration) *Timeout {
|
|
excluded := make(map[string]struct{}, len(excludedRoutes))
|
|
for _, route := range excludedRoutes {
|
|
excluded[route] = struct{}{}
|
|
}
|
|
|
|
if defaultTimeout.Seconds() == 0 {
|
|
defaultTimeout = 60 * time.Second
|
|
}
|
|
|
|
if maxTimeout == 0 {
|
|
maxTimeout = 600 * time.Second
|
|
}
|
|
|
|
return &Timeout{
|
|
logger: logger.With(slog.String("pkg", pkgname)),
|
|
excluded: excluded,
|
|
defaultTimeout: defaultTimeout,
|
|
maxTimeout: maxTimeout,
|
|
}
|
|
}
|
|
|
|
func (middleware *Timeout) Wrap(next http.Handler) http.Handler {
|
|
return http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
|
|
if _, ok := middleware.excluded[req.URL.Path]; !ok {
|
|
actual := middleware.defaultTimeout
|
|
incoming := req.Header.Get(headerName)
|
|
if incoming != "" {
|
|
parsed, err := time.ParseDuration(strings.TrimSpace(incoming) + "s")
|
|
if err != nil {
|
|
middleware.logger.WarnContext(req.Context(), "cannot parse timeout in header, using default timeout", slog.String("timeout", incoming), errors.Attr(err))
|
|
} else {
|
|
if parsed > middleware.maxTimeout {
|
|
actual = middleware.maxTimeout
|
|
} else {
|
|
actual = parsed
|
|
}
|
|
}
|
|
}
|
|
|
|
ctx, cancel := context.WithTimeout(req.Context(), actual)
|
|
defer cancel()
|
|
|
|
req = req.WithContext(ctx)
|
|
next.ServeHTTP(rw, req)
|
|
return
|
|
}
|
|
|
|
next.ServeHTTP(rw, req)
|
|
})
|
|
}
|