View Source OpenTelemetry.SemConv.Incubating.UserAttributes (OpenTelemetry.SemConv v1.27.0)
OpenTelemetry Semantic Conventions for User attributes.
Summary
Functions
User email address.
User's full name
Unique user hash to correlate information for a user in anonymized form.
Unique identifier of the user.
Short name or login/username of the user.
Array of user roles at the time of the event.
Functions
@spec user_email() :: :"user.email"
User email address.
Value type
Value must be of type atom() | String.t().
Examples
["a.einstein@example.com"]iex> OpenTelemetry.SemConv.Incubating.UserAttributes.user_email()
:"user.email"?USER_EMAIL.
'user.email'@spec user_full_name() :: :"user.full_name"
User's full name
Value type
Value must be of type atom() | String.t().
Examples
["Albert Einstein"]iex> OpenTelemetry.SemConv.Incubating.UserAttributes.user_full_name()
:"user.full_name"?USER_FULL_NAME.
'user.full_name'@spec user_hash() :: :"user.hash"
Unique user hash to correlate information for a user in anonymized form.
Value type
Value must be of type atom() | String.t().
Notes
Useful if user.id or user.name contain confidential information and cannot be used.
Examples
["364fc68eaf4c8acec74a4e52d7d1feaa"]iex> OpenTelemetry.SemConv.Incubating.UserAttributes.user_hash()
:"user.hash"?USER_HASH.
'user.hash'@spec user_id() :: :"user.id"
Unique identifier of the user.
Value type
Value must be of type atom() | String.t().
Examples
["S-1-5-21-202424912787-2692429404-2351956786-1000"]iex> OpenTelemetry.SemConv.Incubating.UserAttributes.user_id()
:"user.id"?USER_ID.
'user.id'@spec user_name() :: :"user.name"
Short name or login/username of the user.
Value type
Value must be of type atom() | String.t().
Examples
["a.einstein"]iex> OpenTelemetry.SemConv.Incubating.UserAttributes.user_name()
:"user.name"?USER_NAME.
'user.name'@spec user_roles() :: :"user.roles"
Array of user roles at the time of the event.
Value type
Value must be of type [atom() | String.t()].
Examples
["admin", "reporting_user"]iex> OpenTelemetry.SemConv.Incubating.UserAttributes.user_roles()
:"user.roles"?USER_ROLES.
'user.roles'