From 59d93c93128e9fa1e2e895d3149e20395db51fce Mon Sep 17 00:00:00 2001 From: michel-laterman Date: Mon, 27 Nov 2023 11:06:57 -0800 Subject: [PATCH] Add additional transaction labels with error details to requests. --- ...1111919-Enrich-transaction-APM-errors.yaml | 32 +++++++++++++++++++ internal/pkg/api/error.go | 16 +++++++++- 2 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 changelog/fragments/1701111919-Enrich-transaction-APM-errors.yaml diff --git a/changelog/fragments/1701111919-Enrich-transaction-APM-errors.yaml b/changelog/fragments/1701111919-Enrich-transaction-APM-errors.yaml new file mode 100644 index 0000000000..0b78d8b1bc --- /dev/null +++ b/changelog/fragments/1701111919-Enrich-transaction-APM-errors.yaml @@ -0,0 +1,32 @@ +# Kind can be one of: +# - breaking-change: a change to previously-documented behavior +# - deprecation: functionality that is being removed in a later release +# - bug-fix: fixes a problem in a previous version +# - enhancement: extends functionality but does not break or fix existing behavior +# - feature: new functionality +# - known-issue: problems that we are aware of in a given version +# - security: impacts on the security of a product or a user’s deployment. +# - upgrade: important information for someone upgrading from a prior version +# - other: does not fit into any of the other categories +kind: enhancement + +# Change summary; a 80ish characters long description of the change. +summary: Enrich transaction APM errors + +# Long description; in case the summary is not enough to describe the change +# this field accommodate a description without length limits. +# NOTE: This field will be rendered only for breaking-change and known-issue kinds at the moment. +#description: + +# Affected component; a word indicating the component this changeset affects. +component: + +# PR URL; optional; the PR number that added the changeset. +# If not present is automatically filled by the tooling finding the PR where this changelog fragment has been added. +# NOTE: the tooling supports backports, so it's able to fill the original PR number instead of the backport PR number. +# Please provide it if you are adding a fragment for a different PR. +#pr: https://github.com/owner/repo/1234 + +# Issue URL; optional; the GitHub issue related to this changeset (either closes or is part of). +# If not present is automatically filled by the tooling with the issue linked to the PR number. +issue: 3098 diff --git a/internal/pkg/api/error.go b/internal/pkg/api/error.go index dff6002ef3..03acadc6f1 100644 --- a/internal/pkg/api/error.go +++ b/internal/pkg/api/error.go @@ -8,6 +8,7 @@ import ( "context" "encoding/json" "errors" + "fmt" "net/http" "os" "strings" @@ -15,6 +16,7 @@ import ( "github.com/elastic/fleet-server/v7/internal/pkg/apikey" "github.com/elastic/fleet-server/v7/internal/pkg/dl" + "github.com/elastic/fleet-server/v7/internal/pkg/es" "github.com/elastic/fleet-server/v7/internal/pkg/file" "github.com/elastic/fleet-server/v7/internal/pkg/file/delivery" "github.com/elastic/fleet-server/v7/internal/pkg/file/uploader" @@ -518,13 +520,25 @@ func (er HTTPErrResp) Write(w http.ResponseWriter) error { func ErrorResp(w http.ResponseWriter, r *http.Request, err error) { zlog := hlog.FromRequest(r) resp := NewHTTPErrResp(err) - e := zlog.WithLevel(resp.Level).Err(err).Int(ECSHTTPResponseCode, resp.StatusCode) + e := zlog.WithLevel(resp.Level).Err(err).Int(ECSHTTPResponseCode, resp.StatusCode).String("error.type", fmt.Sprintf("%T", err)) if ts, ok := logger.CtxStartTime(r.Context()); ok { e = e.Int64(ECSEventDuration, time.Since(ts).Nanoseconds()) } e.Msg("HTTP request error") if resp.StatusCode >= 500 { + trans := apm.TransactionFromContext(c.Context()) + switch typ := err.(type) { + case *es.ErrElastic: + trans.Context.SetLabel("error.type", "ErrElastic") + trans.Context.SetLabel("error.details.status", typ.Status) + trans.Context.SetLabel("error.details.type", typ.Type) + trans.Context.SetLabel("error.details.reason", typ.Reason) + trans.Context.SetLabel("error.details.cause.type", typ.Cause.Type) + trans.Context.SetLabel("error.details.cause.reason", typ.Cause.Reason) + default: + trans.Context.SetLabel("error.type", fmt.Sprintf("%T", typ)) + } apm.CaptureError(r.Context(), err).Send() }