Skip to content

SigNoz is an open-source, OpenTelemetry-native observability platform for your team and their AI agents. Get logs, metrics, and traces in one tool with features like APM, distributed tracing, log management, infra monitoring, etc. Combined with SigNoz MCP and a native AI teammate (in SigNoz Cloud) it helps you build more resilient apps.

3.0 KB
Raw Blame
package plugin

import (
	"bytes"
	"io"
	"log/slog"
	"net"
	"net/http"

	"github.com/gojek/heimdall/v7"
	semconv "go.opentelemetry.io/otel/semconv/v1.27.0"

	"github.com/SigNoz/signoz/pkg/errors"
)

type reqResLog struct {
	logger *slog.Logger
}

func NewLog(logger *slog.Logger) heimdall.Plugin {
	return &reqResLog{
		logger: logger,
	}
}

func (plugin *reqResLog) OnRequestStart(request *http.Request) {
	host, port, _ := net.SplitHostPort(request.Host)
	fields := []any{
		string(semconv.HTTPRequestMethodKey), request.Method,
		string(semconv.URLPathKey), request.URL.Path,
		string(semconv.URLSchemeKey), request.URL.Scheme,
		string(semconv.UserAgentOriginalKey), request.UserAgent(),
		string(semconv.ServerAddressKey), host,
		string(semconv.ServerPortKey), port,
		string(semconv.HTTPRequestSizeKey), request.ContentLength,
	}

	// only include all the headers if we are at debug level
	if plugin.logger.Handler().Enabled(request.Context(), slog.LevelDebug) {
		fields = append(fields, "http.request.headers", request.Header)
	} else {
		fields = append(fields, "http.request.headers", redactSensitiveHeaders(request.Header))
	}

	plugin.logger.InfoContext(request.Context(), "::SENT-REQUEST::", fields...)
}

func (plugin *reqResLog) OnRequestEnd(request *http.Request, response *http.Response) {
	fields := []any{
		string(semconv.HTTPResponseStatusCodeKey), response.StatusCode,
		string(semconv.HTTPResponseBodySizeKey), response.ContentLength,
	}

	bodybytes, err := io.ReadAll(response.Body)
	if err != nil {
		plugin.logger.DebugContext(request.Context(), "::UNABLE-TO-LOG-RESPONSE-BODY::", errors.Attr(err))
	} else {
		_ = response.Body.Close()
		response.Body = io.NopCloser(bytes.NewBuffer(bodybytes))

		if len(bodybytes) > 0 {
			fields = append(fields, "http.response.body", string(bodybytes))
		} else {
			fields = append(fields, "http.response.body", "(empty)")
		}
	}

	plugin.logger.InfoContext(request.Context(), "::RECEIVED-RESPONSE::", fields...)
}

func (plugin *reqResLog) OnError(request *http.Request, err error) {
	host, port, _ := net.SplitHostPort(request.Host)
	fields := []any{
		errors.Attr(err),
		string(semconv.HTTPRequestMethodKey), request.Method,
		string(semconv.URLPathKey), request.URL.Path,
		string(semconv.URLSchemeKey), request.URL.Scheme,
		string(semconv.UserAgentOriginalKey), request.UserAgent(),
		string(semconv.ServerAddressKey), host,
		string(semconv.ServerPortKey), port,
		string(semconv.HTTPRequestSizeKey), request.ContentLength,
	}

	plugin.logger.ErrorContext(request.Context(), "::UNABLE-TO-SEND-REQUEST::", fields...)
}

func redactSensitiveHeaders(headers http.Header) http.Header {
	// maintained list of headers to redact
	sensitiveHeaders := map[string]bool{
		"Authorization":          true,
		"Cookie":                 true,
		"X-Signoz-Cloud-Api-Key": true,
	}

	safeHeaders := make(http.Header)

	for header, value := range headers {
		if sensitiveHeaders[header] {
			safeHeaders[header] = []string{"REDACTED"}
		} else {
			safeHeaders[header] = value
		}
	}

	return safeHeaders
}