Breadcrumbs Data Quality

[AbhiPrasad]

https://www.notion.so/sentry/Breadcrumbs-in-the-SDK-1848b10e4b5d80558a84ff391eef9638#1848b10e4b5d8038a744d2d8d56c0008

Copying over stuff from the notion doc here when I'm done with it so we can share with everyone.

[AbhiPrasad]

JavaScript SDK: https://github.com/getsentry/sentry-javascript

Browser SDK

Sentry Breadcrumb

Description	Adds breadcrumb every time an event (error/transaction) is sent to Sentry
Integration Name	Breadcrumbs
Docs	https://docs.sentry.io/platforms/javascript/configuration/integrations/breadcrumbs/
Integration Option	sentry: boolean

• Category is sentry.transaction or sentry.event
• Level is level of event (so nothing for transactions, event.level for errors)
• Message is event ID for transactions, event.message for errors

DOM Breadcrumb

Description	Adds breadcrumb every time a click or keypress event happens
Integration Name	Breadcrumbs
Docs	https://docs.sentry.io/platforms/javascript/configuration/integrations/breadcrumbs/
Integration Option	dom: boolean

• Category is ui.${HANDLER_NAME} where HANDLER_NAME is the name of the dom event that fired the event (click/keypress)
• Message is target (CSS selector) of element that got interacted with
• Data
  • ui.component_name: The human readable component name grabbed from data-sentry-component or data-sentry-element HTML attribute (inserted in by our React Component Names instrumentation for ex.)

Console Breadcrumb

Description	Adds breadcrumbs for calls to console.X (console.log, console.error, etc.)
Integration Name	Breadcrumbs
Docs	https://docs.sentry.io/platforms/javascript/configuration/integrations/breadcrumbs/
Integration Option	console: boolean

• Category is console
• Level is level of console call
• Message is string emitted from console call
• Data
  • arguments: The individual arguments provided to console call
  • logger: always the string console

XHR Breadcrumb

Description	Adds breadcrumb representing a completed XHR call (http call)
Integration Name	Breadcrumbs
Docs	https://docs.sentry.io/platforms/javascript/configuration/integrations/breadcrumbs/
Integration Option	xhr: boolean

• Type is http
• Category is xhr
• Level is based on HTTP status code (4xx → warning, 5xx → error)
• Data
  • method: The HTTP method of the XHR request
  • url: The URL the XHR request was made to
  • status_code: The status code returned by the response to the XHR request

Fetch Breadcrumb

Description	Adds breadcrumb representing a completed fetch call (http call)
Integration Name	Breadcrumbs
Docs	https://docs.sentry.io/platforms/javascript/configuration/integrations/breadcrumbs/
Integration Option	fetch: boolean

• Type is http
• Category is fetch
• Level is based on HTTP status code (4xx → warning, 5xx → error)
• Data
  • method: The HTTP method of the fetch request
  • url: The URL the fetch request was made to
  • status_code: The status code returned by the response to the fetch request
  • request_body_size: The size of the request body (bytes)
  • response_body_size: The size of the response body (bytes)

History Breadcrumb

Description	Adds breadcrumb representing changes to the browser history (page navigations, page redirect)
Integration Name	Breadcrumbs
Docs	https://docs.sentry.io/platforms/javascript/configuration/integrations/breadcrumbs/
Integration Option	history: boolean

• Category is navigation
• Data
  • from: The URL before the navigation
  • to: The URL after the navigation

Cloudflare SDK

D1 Breadcrumb

Description	Adds breadcrumb representing completed queries to Cloudflare D1
Docs	https://docs.sentry.io/platforms/javascript/guides/cloudflare/features/d1/

• Category is query
• Message is the full paramaterized query
• Data
  • cloudflare.d1.query_type: The query type of the d1 query
  • cloudflare.d1.duration: The duration of the d1 query
  • cloudflare.d1.rows_read: The number of rows read during the query
  • cloudflare.d1.rows_written: The number of rows written during the query

Fetch Breadcrumb

Description	Adds breadcrumb representing a completed fetch call (http call)
Integration Name	Fetch

• Category is fetch
• Type is http
• Level is based on HTTP status code (4xx → warning, 5xx → error)
• Data
  • method: The HTTP method of the fetch request
  • url: The URL the fetch request was made to
  • status_code: The status code returned by the response to the fetch request
  • request_body_size: The size of the request body (bytes)
  • response_body_size: The size of the response body (bytes)

Deno SDK

Sentry Breadcrumb

Description	Adds breadcrumb every time an event (error/transaction) is sent to Sentry
Integration Name	Breadcrumbs
Docs	https://docs.sentry.io/platforms/javascript/guides/deno/configuration/integrations/breadcrumbs/
Integration Option	sentry: boolean

• Category is sentry.transaction or sentry.event
• Level is level of event (so nothing for transactions, event.level for errors)
• Message is event ID for transactions, event.message for errors

Console Breadcrumb

Description	Adds breadcrumbs for calls to console.X (console.log, console.error, etc.)
Integration Name	Breadcrumbs
Docs	https://docs.sentry.io/platforms/javascript/guides/deno/configuration/integrations/breadcrumbs/
Integration Option	console: boolean

• Category is console
• Level is level of console call
• Message is string emitted from console call
• Data
  • arguments: The individual arguments provided to console call
  • logger: always the string console

Fetch Breadcrumb

Description	Adds breadcrumb representing a completed fetch call (http call)
Integration Name	Breadcrumbs
Docs	https://docs.sentry.io/platforms/javascript/guides/deno/configuration/integrations/breadcrumbs/
Integration Option	fetch: boolean

• Type is http
• Category is fetch
• Level is based on HTTP status code (4xx → warning, 5xx → error)
• Data
  • method: The HTTP method of the fetch request
  • url: The URL the fetch request was made to
  • status_code: The status code returned by the response to the fetch request
  • request_body_size: The size of the request body (bytes)
  • response_body_size: The size of the response body (bytes)

Node SDK

Console Breadcrumb

Description	Adds breadcrumbs for calls to console.X (console.log, console.error, etc.)
Integration Name	Console
Docs	https://docs.sentry.io/platforms/javascript/guides/node/configuration/integrations/console/

• Category is console
• Level is level of console call
• Message is string emitted from console call, truncated to 2048 characters

Fetch Breadcrumb

Description	Adds breadcrumb representing a completed fetch call (http call)
Integration Name	NodeFetch
Docs	https://docs.sentry.io/platforms/javascript/guides/node/configuration/integrations/nodefetch/

• Category is http
• Type is http
• Level is based on HTTP status code (4xx → warning, 5xx → error)
• Data
  • status_code: The status code returned by the response to the fetch request
  • url: The URL the fetch request was made to
  • http.method: The HTTP method of the fetch request
  • http.query: The http query of the URL the fetch request was made to
  • http.fragment: The http query of the URL the fetch request was made to

HTTP Breadcrumb

Description	Adds breadcrumb representing a completed http call
Integration Name	Http
Docs	https://docs.sentry.io/platforms/javascript/guides/node/configuration/integrations/http/

• Category is http
• Type is http
• Level is based on HTTP status code (4xx → warning, 5xx → error)
• Data
  • status_code: The status code returned by the response to the fetch request
  • url: The URL the fetch request was made to
  • http.method: The HTTP method of the fetch request
  • http.query: The http query of the URL the fetch request was made to
  • http.fragment: The http query of the URL the fetch request was made to

Child Process Exit Breadcrumb

Description	Adds breadcrumb representing a child process exiting
Integration Name	ChildProcess
Docs	https://docs.sentry.io/platforms/javascript/guides/node/configuration/integrations/childProcess/

• Category is child_process
• Message
  • regular exit: is Child process exited with code '${code}' where code is the process exit code.
  • errored exit: Child process errored with '${error.message}'
• Level is either error, info, or warning depending on the exit code
• Data
  • spawnfile: The executable file name of the child process that is launched
  • spawnargs: The full list of command-line arguments the child process was launched with

Worker Thread Error Breadcrumb

Description	Adds breadcrumb representing a worker thread erroring
Integration Name	ChildProcess
Docs	https://docs.sentry.io/platforms/javascript/guides/node/configuration/integrations/childProcess/

• Category is worker_thread
• Message Worker thread errored with '${error.message}'
• Level is error
• Data
  • threadId: The thread ID of the worker thread

React SDK

Redux Breadcrumb

Description	Adds breadcrumb representing a change in redux state
Docs	https://docs.sentry.io/platforms/javascript/guides/react/features/redux/

• Category is redux.action
• Type is info
• Data is the redux action payload (arbitrary object, contains any kind of keys/objects)

Vercel Edge SDK

WinterCG Fetch Breadcrumb

Description	Adds breadcrumb representing a completed fetch call (http call)
Integration Name	Breadcrumbs
Docs	https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/integrations/wintercgfetch/

• Category is fetch
• Type is http
• Level is based on HTTP status code (4xx → warning, 5xx → error)
• Data
  • status_code: The status code returned by the response to the fetch request
  • url: The URL the fetch request was made to
  • http.method: The HTTP method of the fetch request
  • http.query: The http query of the URL the fetch request was made to
  • http.fragment: The http query of the URL the fetch request was made to

Vue SDK

Pinia Breadcrumb

Description	Adds breadcrumb representing a change in pinia state
Docs	https://docs.sentry.io/platforms/javascript/guides/vue/features/pinia/

• Category is action
• Level is info
• Message is pinia action name