view release on metacpan or  search on metacpan

docs/schema.ts  view on Meta::CPAN

 *          }
 *        }
 *      ]
 *    }
 *  }
 *  ```
 */
export type Breadcrumb = {
  /**
   *  A dotted string indicating what the crumb is or from where it comes. _Optional._
   *
   *  Typically it is a module name or a descriptive string. For instance, _ui.click_ could be
   *  used to indicate that a click happened in the UI or _flask_ could be used to indicate that
   *  the event originated in the Flask framework.
   */
  category?: string | null
  /**
   *  Arbitrary data associated with this breadcrumb.
   *
   *  Contains a dictionary whose contents depend on the breadcrumb `type`. Additional parameters
   *  that are unsupported by the type are rendered as a key/value table.
   */
  data?: {
    [k: string]: unknown
  } | null
  /**
   *  Severity level of the breadcrumb. _Optional._
   *
   *  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. Defaults to
   *  `info`.
   */
  level?: Level | null
  /**
   *  Human readable message for the breadcrumb.
   *
   *  If a message is provided, it is rendered as text with all whitespace preserved. Very long
   *  text might be truncated in the UI.
   */
  message?: string | null
  /**
   *  The timestamp of the breadcrumb. Recommended.
   *
   *  A timestamp representing when the breadcrumb occurred. The format is either a string as
   *  defined in [RFC 3339](https://tools.ietf.org/html/rfc3339) or a numeric (integer or float)
   *  value representing the number of seconds that have elapsed since the [Unix
   *  epoch](https://en.wikipedia.org/wiki/Unix_time).
   *
   *  Breadcrumbs are most useful when they include a timestamp, as it creates a timeline leading
   *  up to an event.
   */
  timestamp?: Timestamp | null
  /**
   *  The type of the breadcrumb. _Optional_, defaults to `default`.
   *
   *  - `default`: Describes a generic breadcrumb. This is typically a log message or
   *    user-generated breadcrumb. The `data` field is entirely undefined and as such, completely
   *    rendered as a key/value table.
   *
   *  - `navigation`: Describes a navigation breadcrumb. A navigation event can be a URL change
   *    in a web application, or a UI transition in a mobile or desktop application, etc.
   *
   *    Such a breadcrumb's `data` object has the required fields `from` and `to`, which
   *    represent an application route/url each.
   *
   *  - `http`: Describes an HTTP request breadcrumb. This represents an HTTP request transmitted
   *    from your application. This could be an AJAX request from a web application, or a
   *    server-to-server HTTP request to an API service provider, etc.
   *
   *    Such a breadcrumb's `data` property has the fields `url`, `method`, `status_code`
   *    (integer) and `reason` (string).
   */
  type?: string | null
  [k: string]: unknown
}
/**
 * Severity level of an event or breadcrumb.
 */
export type Level = "debug" | "info" | "warning" | "error" | "fatal"
/**
 * Can be a ISO-8601 formatted string or a unix timestamp in seconds (floating point values allowed).
 *
 * Must be UTC.
 */
export type Timestamp = number | string
/**
 *  The Contexts Interface provides additional context data. Typically, this is data related to the
 *  current user and the environment. For example, the device or application version. Its canonical
 *  name is `contexts`.
 *
 *  The `contexts` type can be used to define arbitrary contextual data on the event. It accepts an
 *  object of key/value pairs. The key is the “alias” of the context and can be freely chosen.
 *  However, as per policy, it should match the type of the context unless there are two values for
 *  a type. You can omit `type` if the key name is the type.
 *
 *  Unknown data for the contexts is rendered as a key/value list.
 *
 *  For more details about sending additional data with your event, see the [full documentation on
 *  Additional Data](https://docs.sentry.io/enriching-error-data/additional-data/).
 */
export type Contexts = {
  [k: string]: ContextInner | null
}
export type ContextInner = Context
/**
 *  A context describes environment info (e.g. device, os or browser).
 */
export type Context =
  | DeviceContext
  | OsContext
  | RuntimeContext
  | AppContext
  | BrowserContext
  | GpuContext
  | TraceContext
  | MonitorContext
  | {
      [k: string]: unknown
    }
/**
 *  Device information.