[chore] Move mobile events to the registry (#872)
Co-authored-by: Alexander Wert <AlexanderWert@users.noreply.github.com>
This commit is contained in:
parent
48892b8080
commit
8c4d6986e0
|
|
@ -45,6 +45,7 @@ body:
|
|||
- area:heroku
|
||||
- area:host
|
||||
- area:http
|
||||
- area:ios
|
||||
- area:k8s
|
||||
- area:messaging
|
||||
- area:network
|
||||
|
|
|
|||
|
|
@ -38,6 +38,7 @@ body:
|
|||
- area:heroku
|
||||
- area:host
|
||||
- area:http
|
||||
- area:ios
|
||||
- area:k8s
|
||||
- area:messaging
|
||||
- area:network
|
||||
|
|
|
|||
|
|
@ -47,6 +47,7 @@ body:
|
|||
- area:heroku
|
||||
- area:host
|
||||
- area:http
|
||||
- area:ios
|
||||
- area:k8s
|
||||
- area:messaging
|
||||
- area:network
|
||||
|
|
|
|||
|
|
@ -52,6 +52,7 @@ Currently, the following namespaces exist:
|
|||
* [Heroku](heroku.md)
|
||||
* [Host](host.md)
|
||||
* [HTTP](http.md)
|
||||
* [iOS](ios.md)
|
||||
* [K8s](k8s.md)
|
||||
* [Network](network.md)
|
||||
* [OCI](oci.md)
|
||||
|
|
|
|||
|
|
@ -1,8 +1,33 @@
|
|||
# Android
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [Android Attributes](#android-attributes)
|
||||
- [Android Lifecycle Event Attributes](#android-lifecycle-event-attributes)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
## Android Attributes
|
||||
<!-- semconv registry.android(omit_requirement_level) -->
|
||||
| Attribute | Type | Description | Examples | Stability |
|
||||
|---|---|---|---|---|
|
||||
| `android.os.api_level` | string | Uniquely identifies the framework API revision offered by a version (`os.version`) of the android operating system. More information can be found [here](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels). | `33`; `32` |  |
|
||||
<!-- endsemconv -->
|
||||
|
||||
## Android Lifecycle Event Attributes
|
||||
|
||||
<!-- semconv registry.android.lifecycle.events(omit_requirement_level) -->
|
||||
| Attribute | Type | Description | Examples | Stability |
|
||||
|---|---|---|---|---|
|
||||
| `android.state` | string | This attribute represents the state the application has transitioned into at the occurrence of the event. [1] | `created` |  |
|
||||
|
||||
**[1]:** The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc), and from which the `OS identifiers` are derived.
|
||||
|
||||
`android.state` MUST be one of the following:
|
||||
|
||||
| Value | Description | Stability |
|
||||
|---|---|---|
|
||||
| `created` | Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time. |  |
|
||||
| `background` | Any time after Activity.onPause() or, if the app has no Activity, Context.stopService() has been called when the app was in the foreground state. |  |
|
||||
| `foreground` | Any time after Activity.onResume() or, if the app has no Activity, Context.startService() has been called when the app was in either the created or background states. |  |
|
||||
<!-- endsemconv -->
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
<!--- Hugo front matter used to generate the website version of this page:
|
||||
--->
|
||||
|
||||
# iOS
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [iOS Lifecycle Event Attributes](#ios-lifecycle-event-attributes)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
## iOS Lifecycle Event Attributes
|
||||
|
||||
<!-- semconv registry.ios.lifecycle.events(omit_requirement_level) -->
|
||||
| Attribute | Type | Description | Examples | Stability |
|
||||
|---|---|---|---|---|
|
||||
| `ios.state` | string | This attribute represents the state the application has transitioned into at the occurrence of the event. [1] | `active` |  |
|
||||
|
||||
**[1]:** The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902), and from which the `OS terminology` column values are derived.
|
||||
|
||||
`ios.state` MUST be one of the following:
|
||||
|
||||
| Value | Description | Stability |
|
||||
|---|---|---|
|
||||
| `active` | The app has become `active`. Associated with UIKit notification `applicationDidBecomeActive`. |  |
|
||||
| `inactive` | The app is now `inactive`. Associated with UIKit notification `applicationWillResignActive`. |  |
|
||||
| `background` | The app is now in the background. This value is associated with UIKit notification `applicationDidEnterBackground`. |  |
|
||||
| `foreground` | The app is now in the foreground. This value is associated with UIKit notification `applicationWillEnterForeground`. |  |
|
||||
| `terminate` | The app is about to terminate. Associated with UIKit notification `applicationWillTerminate`. |  |
|
||||
<!-- endsemconv -->
|
||||
|
|
@ -23,12 +23,12 @@ mobile operating system (e.g. Android, iOS).
|
|||
|
||||
### iOS
|
||||
|
||||
<!-- semconv ios.lifecycle.events -->
|
||||
<!-- semconv ios.lifecycle.events(full) -->
|
||||
The event name MUST be `device.app.lifecycle`.
|
||||
|
||||
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||
|---|---|---|---|---|---|
|
||||
| `ios.state` | string | This attribute represents the state the application has transitioned into at the occurrence of the event. [1] | `active` | `Required` |  |
|
||||
| [`ios.state`](../attributes-registry/ios.md) | string | This attribute represents the state the application has transitioned into at the occurrence of the event. [1] | `active` | `Required` |  |
|
||||
|
||||
**[1]:** The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902), and from which the `OS terminology` column values are derived.
|
||||
|
||||
|
|
@ -45,12 +45,12 @@ The event name MUST be `device.app.lifecycle`.
|
|||
|
||||
### Android
|
||||
|
||||
<!-- semconv android.lifecycle.events -->
|
||||
<!-- semconv android.lifecycle.events(full) -->
|
||||
The event name MUST be `device.app.lifecycle`.
|
||||
|
||||
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||
|---|---|---|---|---|---|
|
||||
| `android.state` | string | This attribute represents the state the application has transitioned into at the occurrence of the event. [1] | `created` | `Required` |  |
|
||||
| [`android.state`](../attributes-registry/android.md) | string | This attribute represents the state the application has transitioned into at the occurrence of the event. [1] | `created` | `Required` |  |
|
||||
|
||||
**[1]:** The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc), and from which the `OS identifiers` are derived.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,82 +1,17 @@
|
|||
groups:
|
||||
- id: ios.lifecycle.events
|
||||
type: event
|
||||
prefix: ios
|
||||
name: device.app.lifecycle
|
||||
brief: >
|
||||
This event represents an occurrence of a lifecycle transition on the iOS platform.
|
||||
attributes:
|
||||
- id: state
|
||||
stability: experimental
|
||||
- ref: ios.state
|
||||
requirement_level: "required"
|
||||
note: >
|
||||
The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902),
|
||||
and from which the `OS terminology` column values are derived.
|
||||
brief: >
|
||||
This attribute represents the state the application has transitioned into at the occurrence of the event.
|
||||
type:
|
||||
allow_custom_values: false
|
||||
members:
|
||||
- id: active
|
||||
value: 'active'
|
||||
brief: >
|
||||
The app has become `active`. Associated with UIKit notification `applicationDidBecomeActive`.
|
||||
stability: experimental
|
||||
- id: inactive
|
||||
value: 'inactive'
|
||||
brief: >
|
||||
The app is now `inactive`. Associated with UIKit notification `applicationWillResignActive`.
|
||||
stability: experimental
|
||||
- id: background
|
||||
value: 'background'
|
||||
brief: >
|
||||
The app is now in the background.
|
||||
This value is associated with UIKit notification `applicationDidEnterBackground`.
|
||||
stability: experimental
|
||||
- id: foreground
|
||||
value: 'foreground'
|
||||
brief: >
|
||||
The app is now in the foreground.
|
||||
This value is associated with UIKit notification `applicationWillEnterForeground`.
|
||||
stability: experimental
|
||||
- id: terminate
|
||||
value: 'terminate'
|
||||
brief: >
|
||||
The app is about to terminate. Associated with UIKit notification `applicationWillTerminate`.
|
||||
stability: experimental
|
||||
- id: android.lifecycle.events
|
||||
type: event
|
||||
prefix: android
|
||||
name: device.app.lifecycle
|
||||
brief: >
|
||||
This event represents an occurrence of a lifecycle transition on the Android platform.
|
||||
attributes:
|
||||
- id: state
|
||||
stability: experimental
|
||||
- ref: android.state
|
||||
requirement_level: required
|
||||
brief: >
|
||||
This attribute represents the state the application has transitioned into at the occurrence of the event.
|
||||
note: >
|
||||
The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc),
|
||||
and from which the `OS identifiers` are derived.
|
||||
type:
|
||||
allow_custom_values: false
|
||||
members:
|
||||
- id: created
|
||||
value: 'created'
|
||||
brief: >
|
||||
Any time before Activity.onResume() or, if the app has no Activity, Context.startService()
|
||||
has been called in the app for the first time.
|
||||
stability: experimental
|
||||
- id: background
|
||||
value: 'background'
|
||||
brief: >
|
||||
Any time after Activity.onPause() or, if the app has no Activity,
|
||||
Context.stopService() has been called when the app was in the foreground state.
|
||||
stability: experimental
|
||||
- id: foreground
|
||||
value: 'foreground'
|
||||
brief: >
|
||||
Any time after Activity.onResume() or, if the app has no Activity,
|
||||
Context.startService() has been called when the app was in either the created or background states.
|
||||
stability: experimental
|
||||
|
|
|
|||
|
|
@ -13,3 +13,37 @@ groups:
|
|||
(`os.version`) of the android operating system. More information can be found
|
||||
[here](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels).
|
||||
examples: ['33', '32']
|
||||
- id: registry.android.lifecycle.events
|
||||
prefix: android
|
||||
type: attribute_group
|
||||
brief: >
|
||||
This document defines attributes that represents an occurrence of a lifecycle transition on the Android platform.
|
||||
attributes:
|
||||
- id: state
|
||||
stability: experimental
|
||||
brief: >
|
||||
This attribute represents the state the application has transitioned into at the occurrence of the event.
|
||||
note: >
|
||||
The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc),
|
||||
and from which the `OS identifiers` are derived.
|
||||
type:
|
||||
allow_custom_values: false
|
||||
members:
|
||||
- id: created
|
||||
value: 'created'
|
||||
brief: >
|
||||
Any time before Activity.onResume() or, if the app has no Activity, Context.startService()
|
||||
has been called in the app for the first time.
|
||||
stability: experimental
|
||||
- id: background
|
||||
value: 'background'
|
||||
brief: >
|
||||
Any time after Activity.onPause() or, if the app has no Activity,
|
||||
Context.stopService() has been called when the app was in the foreground state.
|
||||
stability: experimental
|
||||
- id: foreground
|
||||
value: 'foreground'
|
||||
brief: >
|
||||
Any time after Activity.onResume() or, if the app has no Activity,
|
||||
Context.startService() has been called when the app was in either the created or background states.
|
||||
stability: experimental
|
||||
|
|
|
|||
|
|
@ -0,0 +1,44 @@
|
|||
groups:
|
||||
- id: registry.ios.lifecycle.events
|
||||
prefix: ios
|
||||
type: attribute_group
|
||||
brief: >
|
||||
The iOS platform on which the iOS application is running.
|
||||
attributes:
|
||||
- id: state
|
||||
stability: experimental
|
||||
note: >
|
||||
The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902),
|
||||
and from which the `OS terminology` column values are derived.
|
||||
brief: >
|
||||
This attribute represents the state the application has transitioned into at the occurrence of the event.
|
||||
type:
|
||||
allow_custom_values: false
|
||||
members:
|
||||
- id: active
|
||||
value: 'active'
|
||||
brief: >
|
||||
The app has become `active`. Associated with UIKit notification `applicationDidBecomeActive`.
|
||||
stability: experimental
|
||||
- id: inactive
|
||||
value: 'inactive'
|
||||
brief: >
|
||||
The app is now `inactive`. Associated with UIKit notification `applicationWillResignActive`.
|
||||
stability: experimental
|
||||
- id: background
|
||||
value: 'background'
|
||||
brief: >
|
||||
The app is now in the background.
|
||||
This value is associated with UIKit notification `applicationDidEnterBackground`.
|
||||
stability: experimental
|
||||
- id: foreground
|
||||
value: 'foreground'
|
||||
brief: >
|
||||
The app is now in the foreground.
|
||||
This value is associated with UIKit notification `applicationWillEnterForeground`.
|
||||
stability: experimental
|
||||
- id: terminate
|
||||
value: 'terminate'
|
||||
brief: >
|
||||
The app is about to terminate. Associated with UIKit notification `applicationWillTerminate`.
|
||||
stability: experimental
|
||||
Loading…
Reference in New Issue