Os Attributes

10 attributes in this category. 9 stable · 1 deprecated

Stable Attributes

os.build_id

string PII: Maybe OTel: True

The build ID of the operating system.

Example 1234567890
Aliases os.build
Changelog
v0.5.0 #301 Added os.build as alias
v0.1.0 #127
v0.0.0
Raw JSON 
{
  "key": "os.build_id",
  "brief": "The build ID of the operating system.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "example": "1234567890",
  "alias": [
    "os.build"
  ],
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        301
      ],
      "description": "Added os.build as alias"
    },
    {
      "version": "0.1.0",
      "prs": [
        127
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

os.description

string PII: Maybe OTel: True

Human readable (not intended to be parsed) OS version information, like e.g. reported by ver or lsb_release -a commands.

Example Ubuntu 18.04.1 LTS
Changelog
v0.1.0 #127
v0.0.0
Raw JSON 
{
  "key": "os.description",
  "brief": "Human readable (not intended to be parsed) OS version information, like e.g. reported by ver or lsb_release -a commands.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "example": "Ubuntu 18.04.1 LTS",
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        127
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

os.kernel_version

string PII: Maybe OTel: False

An independent kernel version string. Typically the entire output of the `uname` syscall.

Example 20.2.0
Changelog
v0.5.0 #301 Added os.kernel_version attribute
Raw JSON 
{
  "key": "os.kernel_version",
  "brief": "An independent kernel version string. Typically the entire output of the `uname` syscall.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "20.2.0",
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        301
      ],
      "description": "Added os.kernel_version attribute"
    }
  ]
}

os.name

string PII: Maybe OTel: True

Human readable operating system name.

Example Ubuntu
Changelog
v0.1.0 #127
v0.0.0
Raw JSON 
{
  "key": "os.name",
  "brief": "Human readable operating system name.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "example": "Ubuntu",
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        127
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

os.raw_description

string PII: Maybe OTel: False

An unprocessed description string obtained by the operating system. For some well-known runtimes, Sentry will attempt to parse `name` and `version` from this string, if they are not explicitly given.

Example Ubuntu 22.04.4 LTS (Jammy Jellyfish)
Changelog
v0.5.0 #301 Added os.raw_description attribute
Raw JSON 
{
  "key": "os.raw_description",
  "brief": "An unprocessed description string obtained by the operating system. For some well-known runtimes, Sentry will attempt to parse `name` and `version` from this string, if they are not explicitly given.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "Ubuntu 22.04.4 LTS (Jammy Jellyfish)",
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        301
      ],
      "description": "Added os.raw_description attribute"
    }
  ]
}

os.rooted

boolean PII: Maybe OTel: False

Whether the operating system has been jailbroken or rooted.

Example true
Changelog
v0.5.0 #301 Added os.rooted attribute
Raw JSON 
{
  "key": "os.rooted",
  "brief": "Whether the operating system has been jailbroken or rooted.",
  "type": "boolean",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": true,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        301
      ],
      "description": "Added os.rooted attribute"
    }
  ]
}

os.theme

string PII: Maybe OTel: False

Whether the OS runs in dark mode or light mode.

Example dark
Changelog
v0.5.0 #301 Added os.theme attribute
Raw JSON 
{
  "key": "os.theme",
  "brief": "Whether the OS runs in dark mode or light mode.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "dark",
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        301
      ],
      "description": "Added os.theme attribute"
    }
  ]
}

os.type

string PII: Maybe OTel: True

The operating system type.

Example linux
Changelog
v0.1.0 #127
v0.0.0
Raw JSON 
{
  "key": "os.type",
  "brief": "The operating system type.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "example": "linux",
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        127
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

os.version

string PII: Maybe OTel: True

The version of the operating system.

Example 18.04.2
Changelog
v0.1.0 #127
v0.0.0
Raw JSON 
{
  "key": "os.version",
  "brief": "The version of the operating system.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "example": "18.04.2",
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        127
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

Deprecated Attributes

These attributes are deprecated and should not be used in new code. See each attribute for migration guidance.

os.build Deprecated

string PII: Maybe OTel: False

The build ID of the operating system.

Example 1234567890
Aliases os.build_id

Use os.build_id instead.

Status: backfill

Changelog
v0.5.0 #301 Added os.build attribute, deprecated in favor of os.build_id
Raw JSON 
{
  "key": "os.build",
  "brief": "The build ID of the operating system.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "1234567890",
  "deprecation": {
    "replacement": "os.build_id",
    "_status": "backfill"
  },
  "alias": [
    "os.build_id"
  ],
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        301
      ],
      "description": "Added os.build attribute, deprecated in favor of os.build_id"
    }
  ]
}