Apps, devices and users

as of v1.44.0

Mobile and desktop clients: the app, the device it runs on, the session, and who is using it.

feature_flag 13 app 12 security_rule 8 user 6 device 4 enduser 4 android 3 ios 2 session 2

attributes: 54
metrics: 0
signals: 11
stable: 0
deprecated: 8

Signals

What this domain emits, and the attributes each one carries, most strongly required first. An attribute marked * is required on that signal; * is conditionally required.

Events 8

app.crashDevelopmentThis event represents a termination of a user-facing application due to unrecoverable programming errors such as excepti
app.build_id*os.name*os.version*service.version*app.crash.idexception.messageexception.stacktraceexception.typesession.id
app.jankDevelopmentThis event indicates that the application has detected substandard UI rendering performance.
app.jank.frame_countapp.jank.periodapp.jank.threshold
app.screen.clickDevelopmentThis event represents an instantaneous click on the screen of an application.
app.screen.coordinate.x*app.screen.coordinate.y*app.screen.idapp.screen.name
app.widget.clickDevelopmentThis event indicates that an application widget has been clicked.
app.widget.id*app.screen.idapp.screen.coordinate.xapp.screen.coordinate.yapp.screen.nameapp.widget.name
device.app.lifecycleDevelopmentThis event represents an occurrence of a lifecycle transition on Android or iOS platform.
android.app.state*ios.app.state*
feature_flag.evaluationRelease candidateDefines feature flag evaluation as an event.
feature_flag.key*error.type*feature_flag.result.value*feature_flag.result.variant*feature_flag.context.idfeature_flag.error.messagefeature_flag.provider.namefeature_flag.result.reasonfeature_flag.set.idfeature_flag.version
session.endDevelopmentIndicates that a session has ended.
session.id*
session.startDevelopmentIndicates that a new session has been started, optionally linking to the prior session.
session.id*session.previous_id*

Entities 3

androidDevelopmentThe Android platform on which the Android application is running.
android.os.api_level
appDevelopmentAn app used directly by end users — like mobile, web, or desktop.
app.build_idapp.installation.id
deviceDevelopmentThe device on which the process represented by this resource is running.
device.manufacturerdevice.model.identifierdevice.model.namedevice.id

Specification

Eventsare bound by the logs specification — 162 requirements across 5 documents, 83 of them MUST or SHALL.
Entitiesare bound by the entities specification — 53 requirements across 3 documents, 23 of them MUST or SHALL.

Requirements that name this domain 3

MUSTAsynchronous Instrument APIStable
Callback functions MUST be documented as follows for the end user:
MUSTExtending API/SDK abstractionsStable
Hereby, backwards-compatible means that end user's code that implements the plugin interfaces MUST continue to be possible to use with newer versions of the SDK without making changes to the end user's code.
MUSTExtending API/SDK abstractionsStable
For languages that commonly share code via binary artifacts, e.g. Java, backwards-compatible means that end user's code that implements plugin interfaces MUST continue to be possible to use with newer minor or patch versions without recompiling the end user's code.

On the wire, this lands in logs/v1/logs, resource/v1/resource. Field-by-field definitions are under OTLP.

Attributes 54

feature_flag13 attributes

feature_flag.context.id
Release candidateThe unique identifier for the flag evaluation context. For example, the targeting key.
feature_flag.error.message
Release candidateA message providing more detail about an error that occurred during feature flag evaluation in human-readable form.
feature_flag.evaluation.error.message
Deprecated→ feature_flag.error.messageDeprecated, use feature_flag.error.message instead.
feature_flag.evaluation.reason
Deprecated→ feature_flag.result.reasonDeprecated, use feature_flag.result.reason instead.
feature_flag.key
Release candidateThe lookup key of the feature flag.
feature_flag.provider_name
Deprecated→ feature_flag.provider.nameDeprecated, use feature_flag.provider.name instead.
feature_flag.provider.name
Release candidateIdentifies the feature flag provider.
feature_flag.result.reason
Release candidateThe reason code which shows how a feature flag value was determined.
feature_flag.result.value
Release candidateThe evaluated value of the feature flag.
feature_flag.result.variant
Release candidateA semantic identifier for an evaluated flag value.
feature_flag.set.id
Release candidateThe identifier of the flag set to which the feature flag belongs.
feature_flag.variant
Deprecated→ feature_flag.result.variantDeprecated, use feature_flag.result.variant instead.
feature_flag.version
Release candidateThe version of the ruleset used during the evaluation. This may be any stable value which uniquely identifies the ruleset.

app12 attributes

app.build_id
DevelopmentUnique identifier for a particular build or compilation of the application.
app.crash.id
DevelopmentA unique identifier representing an instance of an end user facing app crash.
app.installation.id
DevelopmentA unique identifier representing the installation of an application on a specific device
app.jank.frame_count
DevelopmentA number of frame renders that experienced jank.
app.jank.period
DevelopmentThe time period, in seconds, for which this jank is being reported.
app.jank.threshold
DevelopmentThe minimum rendering threshold for this jank, in seconds.
app.screen.coordinate.x
DevelopmentThe x (horizontal) coordinate of a screen coordinate, in screen pixels.
app.screen.coordinate.y
DevelopmentThe y (vertical) component of a screen coordinate, in screen pixels.
app.screen.id
DevelopmentAn identifier that uniquely differentiates this screen from other screens in the same application.
app.screen.name
DevelopmentThe name of an application screen.
app.widget.id
DevelopmentAn identifier that uniquely differentiates this widget from other widgets in the same application.
app.widget.name
DevelopmentThe name of an application widget.

security_rule8 attributes

security_rule.category
DevelopmentA categorization value keyword used by the entity using the rule for detection of this event
security_rule.description
DevelopmentThe description of the rule generating the event.
security_rule.license
DevelopmentName of the license under which the rule used to generate this event is made available.
security_rule.name
DevelopmentThe name of the rule or signature generating the event.
security_rule.reference
DevelopmentReference URL to additional information about the rule used to generate this event.
security_rule.ruleset.name
DevelopmentName of the ruleset, policy, group, or parent category in which the rule used to generate this event is a member.
security_rule.uuid
DevelopmentA rule ID that is unique within the scope of a set or group of agents, observers, or other entities using the rule for detection of this event.
security_rule.version
DevelopmentThe version / revision of the rule being used for analysis.

user6 attributes

user.email
DevelopmentUser email address.
user.full_name
DevelopmentUser's full name
user.hash
DevelopmentUnique user hash to correlate information for a user in anonymized form.
user.id
DevelopmentUnique identifier of the user.
user.name
DevelopmentShort name or login/username of the user.
user.roles
DevelopmentArray of user roles at the time of the event.

device4 attributes

device.id
DevelopmentA unique identifier representing the device
device.manufacturer
DevelopmentThe name of the device manufacturer
device.model.identifier
DevelopmentThe model identifier for the device
device.model.name
DevelopmentThe marketing name for the device model

enduser4 attributes

enduser.id
DevelopmentUnique identifier of an end user in the system. It maybe a username, email address, or other identifier.
enduser.pseudo.id
DevelopmentPseudonymous identifier of an end user. This identifier should be a random value that is not directly linked or associated with the end user's actual identity.
enduser.role
DeprecatedDeprecated, use user.roles instead.
enduser.scope
DeprecatedDeprecated, no replacement at this time.

android3 attributes

android.app.state
DevelopmentThis attribute represents the state of the application.
android.os.api_level
DevelopmentUniquely identifies the framework API revision offered by a version (os.version) of the Android operating system. More information can be found in the Android A
android.state
Deprecated→ android.app.stateDeprecated. Use android.app.state attribute instead.

ios2 attributes

ios.app.state
DevelopmentThis attribute represents the state of the application.
ios.state
Deprecated→ ios.app.stateDeprecated. Use the ios.app.state attribute.

session2 attributes

session.id
DevelopmentA unique ID to identify a session.
session.previous_id
DevelopmentThe previous session.id for this user, when known.

Recent changes

Breaking and notable changes to this domain across the last 6 semantic-conventions releases.

renamedattributefeature_flag.evaluation.error.messageRenamed to feature_flag.error.message.

Topics are this site's grouping of upstream namespaces, not a structure the OpenTelemetry project publishes. JSON · All domains