Deeply Nested objects aren't being serialised

[drwharris]

Important Details

I have a Node JS 11.9 application

• On-Premise docker [Version xyz]
• Saas (sentry.io)
• Other AWS Fargate

Description

Just upgraded the package to "@sentry/node": "^4.6.5" from "@sentry/node": "^4.5.4".

When adding objects to Addition Data I would see the following logged:

{
	ExMessage: ,
	level: error,
	Payload: {
		AcquisitionId: ,
		ClientId: ,
		DeviceData: {  <<  - Note this 
			Browser: {
				major: ,
				name: ,
				version:
			},
			Cpu: {},
			Device: {
				type:
			},
			Engine: {
				name: ,
				version:
			},
			Os: {
				name: ,
				version:
			}
		},
		Environment: ,
		EventDate: {},  <<  - Note this 
		Fingerprint: ,
		Geographical: {}, <<  - Note this 
		IpAddress: ,
		Referer: ,
		Sequence: ,
		SessionId: ,
		Type: ,
		Url: ,
		UserAgent: ,
		UserName: ,
		Version: ,
		Weather: {} <<  - Note this
	}
}

Unfortunately, now after upgrading I am getting:

{
	ExMessage: ,
	level: ,
	Payload: {
		AcquisitionId: ,
		ClientId: ,
		DeviceData: [Object],  <<- Note this
		Environment: ,
		EventDate: [Object],  <<- Note this
		Fingerprint: ,
		Geographical: [Object],  <<- Note this
		IpAddress: ,
		Referer: ,
		Sequence: ,
		SessionId: ,
		Type: ,
		Url: ,
		UserAgent: ,
		UserName: ,
		Version: ,
		Weather: [Object] <<- Note this
	}
}

Steps to Reproduce

I have this class

export class TrackerError extends Error {
	Payload: any;
	ExMessage: string;
	constructor(message: string, err: Error, payload: any) {
		super(message);
		if (err) {
			this.stack = this.stack
				.split("\n")
				.slice(0, 2)
				.join("\n") +
				"\n" +
				err.stack;
			this.ExMessage = err.message;
		} else {
			Error.captureStackTrace(this, this.constructor);
		}

		if (payload) {
			this.Payload = payload;
		}
	}
}

which I then use as follows:

Sentry.captureException(new TrackerError("My Error Message", myErrObj, myPayloadObj));

What you expected to happen

As per previous versions, deep objects should be logged in detail

[HazAT]

You should be able to define the depth yourself:

Sentry.init({
...
integrations: [new Sentry.Integrations.ExtraErrorData({ depth: 10 })],
...
});

We reduced the limit drastically since it caused many problems for users.
Hope this helps.

[drwharris]

@HazAT
Where is this documented? And is this specific to the JS library?

[HazAT]

TBH, this is sadly poorly documented and should be here:
https://docs.sentry.io/platforms/javascript/default-integrations/#extraerrordata

I will write this down to improve, and yes, this is JS specific.

[drwharris]

OK Thank you.

[drwharris]

Sorry to come back to this but I have just updated to 5.4.0 and its now erroring with:

Property 'ExtraErrorData' does not exist on type '{ Console: typeof Console; Http: typeof Http; OnUncaughtException: typeof OnUncaughtException; OnUnhandledRejection: typeof OnUnhandledRejection; LinkedErrors: typeof LinkedErrors; Modules: typeof Modules; FunctionToString: typeof FunctionToString; InboundFilters: typeof InboundFilters; }'.

21 integrations: [new Sentry.Integrations.ExtraErrorData({ depth: 10 })]

[kamilogorek]

@drwharris

import { ExtraErrorData } from '@sentry/integrations';

[drwharris]

This seems to have regressed. I have this:

import { ExtraErrorData } from '@sentry/integrations';
Sentry.init({
        dsn: 'MYDSN',
        release: `${Settings.name}@${module.exports.version}`,
        integrations: [new ExtraErrorData({ depth: 10 })],
    });

And I get this

{
	AcquisitionId: "",
	ClientId: "",
	DeviceData: [Object], <<- Note this
	Environment: "",
	EventDate: [Object], <<- Note this
	Fingerprint: "",
	Geographical: [Object], <<- Note this
	IpAddress: "",
	Referer: "", 
	Sequence: "", 
	SessionId: "", 
	Type: "", 
	Url: "", 
	UserAgent: "", 
	UserName: "", 
	Version: ""
}

[mcastets]

You need to use the undocumented new param normalizeDepth and set it to normalizeDepth: depth + 1 :

In your example:

Sentry.init({
        dsn: 'MYDSN',
        release: `${Settings.name}@${module.exports.version}`,
        integrations: [new ExtraErrorData({ depth: 10 })],
        normalizeDepth: 11
    });

See also: #2404

[gr2m]

I've run into the same problem and can confirm that adding normalizeDepth resolves the problem. I also double checked if integrations: [new ExtraErrorData({ depth: 10 })], is necessary at all and it turns out it is not, removing it results in the same output on Sentry.

The option was add in #2404 (shipped in v5.12.0), but I could not find any documentation