Skip to content

Latest commit

 

History

History
80 lines (59 loc) · 3.92 KB

severity.md

File metadata and controls

80 lines (59 loc) · 3.92 KB
Raw

Severity Extension

Abstract

This extension defines attributes that MAY be included within a CloudEvent to describe the "severity" or "level" of an event in relation to other events.

Often systems produce events in form of logs, and these types of events usually share a common concept of "log-level". This extension aims to provide a standard way for describing this property in a language agnostic form.

Sharing a common way to describe severity of events allows for better monitoring systems, tooling and general log consumption.

This extension is heavily inspired by the OpenTelemetry Severity Fields and is intended to interoperate with them.

Notational Conventions

As with the main CloudEvents specification, the key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

However, the scope of these key words is limited to when this extension is used. For example, an attribute being marked as "REQUIRED" does not mean it needs to be in all CloudEvents, rather it needs to be included only when this extension is being used.

Attributes

When both attributes are used, all severitytext values which MAY be produced in a context of a source SHOULD be in a one-to-one and onto relationship with all severitynumber values which MAY be produced by the same source.

severitytext

  • Type: String

  • Description: Human readable text representation of the event severity (also known as log level name).

    This is the original string representation of the severity as it is known at the source. If this field is missing and severitynumber is present then the short name that corresponds to the severitynumber MAY be used as a substitution.

  • Constraints

    • OPTIONAL
    • if present, MUST be a non-empty string
    • SHOULD be uppercase
    • RECOMMENDED values are TRACE, DEBUG, INFO, WARN, ERROR, and FATAL, but others MAY be used.

severitynumber

  • Type: Integer

  • Description: Numerical representation of the event severity (also known as log level number), normalized to values described in this document.

    Severity of all values MUST be numerically ascending from least-severe to most-severe. An event with a lower numerical value (such as a debug event) MUST be less severe than an event with a higher numerical value (such as an error event).

    See OpenTelemetry for exact severity number meanings

  • Constraints

    • REQUIRED
    • if present, MUST NOT be negative

References