HTTPError.message contains request-specific dynamic data, breaking error monitoring grouping (Sentry, Datadog, etc.)

[aruscus]

Description:

The gotBeforeErrorHook in GotHooks.ts appends the HTTP method, full URL, and the entire JSON-stringified response body into error.message: error.message += (${method} ${url}). ${JSON.stringify(detail)};

This means every error has a unique message containing request-specific values like correlation keys and process instance IDs.

Error monitoring tools (Sentry, Datadog, etc.) use error.message as a primary grouping key. Because every message contains unique identifiers, each occurrence creates a separate issue instead of grouping together, making it impossible to track error frequency or set alerts.

The structured data is already available on error.response.body (inherited from got.HTTPError), so embedding it into the message is redundant for programmatic access.

Suggested fix:

Use a static, parameterized message and expose the dynamic details as structured properties:

Instead of:
error.message += (${method} ${url}). ${JSON.stringify(detail)};

Use static message with structured properties
error.method = method;
error.url = url;
error.detail = detail;

error.message stays as the original got HTTPError message: "Response code 404 (Not Found)"

[jwulf]

Thanks for using the SDK @aruscus. I added that for ease of debugging in the console. I can see how it messes with automated aggregation.

Which particular client(s) are you using in the SDK?

I ask because changing this will change behaviour for all users, so I want to triage the surface we'll be impacting.

[aruscus]

Thanks for the quick response, @jwulf . We're using CamundaRestClient