Skip to content

Breadcrumb.level has inconsistent descriptionsΒ #15293

@rhashimoto

Description

@rhashimoto

SDK

JavaScript SDK

Description

The documentation page for Javascript breadcrumbs says:

You can choose from the following breadcrumb log levels: "fatal", "critical", "error", "warning", "log", "info", and "debug".

https://github.com/getsentry/sentry-docs/blob/957a21b47ee78b1a28e002607f27d71f8477b63f/docs/platforms/javascript/common/enriching-events/breadcrumbs/index.mdx?plain=1#L30

This doesn't agree with the description in the code which does not include "critical" or "log":

  /**
   * Allowed values are, from highest to lowest:
   * `fatal`, `error`, `warning`, `info`, and `debug`.
   * Levels are used in the UI to emphasize and deemphasize the crumb. The default is `info`.
   *
   * @summary This defines the severity level of the breadcrumb.
   */
  level?: SeverityLevel;

And neither agrees with the definition of SecurityLevel which doesn't have "critical" but does have "log":

export type SeverityLevel = 'fatal' | 'error' | 'warning' | 'log' | 'info' | 'debug';

Suggested Solution

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions