User Attributes

12 attributes in this category.12 stable

12 attributes

Stable Attributes

user.email

stringScrub: AutoVisibility: PublicOTel: True

User email address.

Exampletest@example.com
Changelog
v0.0.0
Raw JSON
{
  "key": "user.email",
  "brief": "User email address.",
  "type": "string",
  "apply_scrubbing": {
    "key": "auto"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "test@example.com",
  "alias": [
    "sentry.user.email"
  ],
  "changelog": [
    {
      "version": "0.0.0"
    }
  ]
}

user.full_name

stringScrub: AutoVisibility: PublicOTel: True

User's full name.

ExampleJohn Smith
Changelog
v0.0.0
Raw JSON
{
  "key": "user.full_name",
  "brief": "User's full name.",
  "type": "string",
  "apply_scrubbing": {
    "key": "auto"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "John Smith",
  "changelog": [
    {
      "version": "0.0.0"
    }
  ]
}

user.geo.city

stringScrub: ManualVisibility: PublicOTel: False

Human readable city name.

ExampleToronto
Changelog
v0.0.0
Raw JSON
{
  "key": "user.geo.city",
  "brief": "Human readable city name.",
  "type": "string",
  "apply_scrubbing": {
    "key": "manual"
  },
  "is_in_otel": false,
  "visibility": "public",
  "example": "Toronto",
  "alias": [
    "sentry.user.geo.city"
  ],
  "changelog": [
    {
      "version": "0.0.0"
    }
  ]
}

user.geo.country_code

stringScrub: ManualVisibility: PublicOTel: False

Two-letter country code (ISO 3166-1 alpha-2).

Changelog
v0.0.0
Raw JSON
{
  "key": "user.geo.country_code",
  "brief": "Two-letter country code (ISO 3166-1 alpha-2).",
  "type": "string",
  "apply_scrubbing": {
    "key": "manual"
  },
  "is_in_otel": false,
  "visibility": "public",
  "example": "CA",
  "alias": [
    "sentry.user.geo.country_code"
  ],
  "changelog": [
    {
      "version": "0.0.0"
    }
  ]
}

user.geo.region

stringScrub: ManualVisibility: PublicOTel: False

Human readable region name or code.

ExampleCanada
Changelog
v0.0.0
Raw JSON
{
  "key": "user.geo.region",
  "brief": "Human readable region name or code.",
  "type": "string",
  "apply_scrubbing": {
    "key": "manual"
  },
  "is_in_otel": false,
  "visibility": "public",
  "example": "Canada",
  "alias": [
    "sentry.user.geo.region"
  ],
  "changelog": [
    {
      "version": "0.0.0"
    }
  ]
}

user.geo.subdivision

stringScrub: ManualVisibility: PublicOTel: False

Human readable subdivision name.

ExampleOntario
Changelog
v0.0.0
Raw JSON
{
  "key": "user.geo.subdivision",
  "brief": "Human readable subdivision name.",
  "type": "string",
  "apply_scrubbing": {
    "key": "manual"
  },
  "is_in_otel": false,
  "visibility": "public",
  "example": "Ontario",
  "alias": [
    "sentry.user.geo.subdivision"
  ],
  "changelog": [
    {
      "version": "0.0.0"
    }
  ]
}

user.geo.subregion

stringScrub: ManualVisibility: PublicOTel: False

UN M49 subregion code of the user's location, derived from user.geo.country_code. Sub-Saharan Africa and Latin America and the Caribbean are split into their M49 intermediate regions.

Examples15521
Well-defined Values
  • 5South America
  • 11Western Africa
  • 13Central America
  • 14Eastern Africa
  • 15Northern Africa
  • 17Middle Africa
  • 18Southern Africa
  • 21Northern America
  • 29Caribbean
  • 30Eastern Asia
  • 34Southern Asia
  • 35South-Eastern Asia
  • 39Southern Europe
  • 53Australia and New Zealand
  • 54Melanesia
  • 57Micronesia
  • 61Polynesia
  • 143Central Asia
  • 145Western Asia
  • 151Eastern Europe
  • 154Northern Europe
  • 155Western Europe
Changelog
v0.31.0#753Added user.geo.subregion attribute
Raw JSON
{
  "key": "user.geo.subregion",
  "brief": "UN M49 subregion code of the user's location, derived from user.geo.country_code. Sub-Saharan Africa and Latin America and the Caribbean are split into their M49 intermediate regions.",
  "type": "string",
  "apply_scrubbing": {
    "key": "manual"
  },
  "is_in_otel": false,
  "visibility": "public",
  "examples": [
    "155",
    "21"
  ],
  "enum_values": [
    {
      "value": "5",
      "brief": "South America"
    },
    {
      "value": "11",
      "brief": "Western Africa"
    },
    {
      "value": "13",
      "brief": "Central America"
    },
    {
      "value": "14",
      "brief": "Eastern Africa"
    },
    {
      "value": "15",
      "brief": "Northern Africa"
    },
    {
      "value": "17",
      "brief": "Middle Africa"
    },
    {
      "value": "18",
      "brief": "Southern Africa"
    },
    {
      "value": "21",
      "brief": "Northern America"
    },
    {
      "value": "29",
      "brief": "Caribbean"
    },
    {
      "value": "30",
      "brief": "Eastern Asia"
    },
    {
      "value": "34",
      "brief": "Southern Asia"
    },
    {
      "value": "35",
      "brief": "South-Eastern Asia"
    },
    {
      "value": "39",
      "brief": "Southern Europe"
    },
    {
      "value": "53",
      "brief": "Australia and New Zealand"
    },
    {
      "value": "54",
      "brief": "Melanesia"
    },
    {
      "value": "57",
      "brief": "Micronesia"
    },
    {
      "value": "61",
      "brief": "Polynesia"
    },
    {
      "value": "143",
      "brief": "Central Asia"
    },
    {
      "value": "145",
      "brief": "Western Asia"
    },
    {
      "value": "151",
      "brief": "Eastern Europe"
    },
    {
      "value": "154",
      "brief": "Northern Europe"
    },
    {
      "value": "155",
      "brief": "Western Europe"
    }
  ],
  "alias": [
    "sentry.user.geo.subregion"
  ],
  "changelog": [
    {
      "version": "0.31.0",
      "prs": [
        753
      ],
      "description": "Added user.geo.subregion attribute"
    }
  ]
}

user.hash

stringScrub: AutoVisibility: PublicOTel: True

Unique user hash to correlate information for a user in anonymized form.

Example8ae4c2993e0f4f3b8b2d1b1f3b5e8f4d
Changelog
v0.0.0
Raw JSON
{
  "key": "user.hash",
  "brief": "Unique user hash to correlate information for a user in anonymized form.",
  "type": "string",
  "apply_scrubbing": {
    "key": "auto"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "8ae4c2993e0f4f3b8b2d1b1f3b5e8f4d",
  "changelog": [
    {
      "version": "0.0.0"
    }
  ]
}

user.id

stringScrub: AutoVisibility: PublicOTel: True

Unique identifier of the user.

ExampleS-1-5-21-202424912787-2692429404-2351956786-1000
Changelog
v0.0.0
Raw JSON
{
  "key": "user.id",
  "brief": "Unique identifier of the user.",
  "type": "string",
  "apply_scrubbing": {
    "key": "auto"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "S-1-5-21-202424912787-2692429404-2351956786-1000",
  "alias": [
    "sentry.user.id"
  ],
  "changelog": [
    {
      "version": "0.0.0"
    }
  ]
}

user.ip_address

stringScrub: AutoVisibility: PublicOTel: False

The IP address of the user.

Example192.168.1.1
Changelog
v0.1.0#75
Raw JSON
{
  "key": "user.ip_address",
  "brief": "The IP address of the user.",
  "type": "string",
  "apply_scrubbing": {
    "key": "auto"
  },
  "is_in_otel": false,
  "visibility": "public",
  "example": "192.168.1.1",
  "alias": [
    "sentry.user.ip"
  ],
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        75
      ]
    }
  ]
}

user.name

stringScrub: AutoVisibility: PublicOTel: True

Short name or login/username of the user.

Examplej.smith
Changelog
v0.0.0
Raw JSON
{
  "key": "user.name",
  "brief": "Short name or login/username of the user.",
  "type": "string",
  "apply_scrubbing": {
    "key": "auto"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "j.smith",
  "alias": [
    "sentry.user.username"
  ],
  "changelog": [
    {
      "version": "0.0.0"
    }
  ]
}

user.roles

string[]Scrub: AutoVisibility: PublicOTel: True

Array of user roles at the time of the event.

Example["admin","editor"]
Changelog
v0.0.0
Raw JSON
{
  "key": "user.roles",
  "brief": "Array of user roles at the time of the event.",
  "type": "string[]",
  "apply_scrubbing": {
    "key": "auto"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": [
    "admin",
    "editor"
  ],
  "changelog": [
    {
      "version": "0.0.0"
    }
  ]
}