Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the device.app.lifecycle event description and constraints #794

Merged
merged 7 commits into from
Apr 22, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add the removed attributes as deprecated
  • Loading branch information
MSNev committed Apr 19, 2024
commit 374fc1c1b42c1772c483f5ff6325fbae502e20af
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -46,7 +46,6 @@ body:
- area:heroku
- area:host
- area:http
- area:ios
- area:k8s
- area:messaging
- area:network
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/change_proposal.yaml
Original file line number Diff line number Diff line change
@@ -39,7 +39,6 @@ body:
- area:heroku
- area:host
- area:http
- area:ios
- area:k8s
- area:messaging
- area:network
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/new-conventions.yaml
Original file line number Diff line number Diff line change
@@ -48,7 +48,6 @@ body:
- area:heroku
- area:host
- area:http
- area:ios
- area:k8s
- area:messaging
- area:network
9 changes: 5 additions & 4 deletions docs/attributes-registry/android.md
Original file line number Diff line number Diff line change
@@ -3,23 +3,24 @@
<!-- toc -->

- [Android Attributes](#android-attributes)
- [Android Lifecycle Event Attributes](#android-lifecycle-event-attributes)
- [Deprecated Android Attributes](#deprecated-android-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` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
<!-- endsemconv -->

## Android Lifecycle Event Attributes
## Deprecated Android Attributes

<!-- semconv registry.android.lifecycle.events(omit_requirement_level) -->
<!-- semconv registry.android.deprecated(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` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `android.state` | string | Deprecated use the `device.app.lifecycle` event definition including `android.state` as a payload field instead. [1] | `created` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

**[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.

8 changes: 4 additions & 4 deletions docs/attributes-registry/ios.md
Original file line number Diff line number Diff line change
@@ -5,16 +5,16 @@

<!-- toc -->

- [iOS Lifecycle Event Attributes](#ios-lifecycle-event-attributes)
- [Deprecated iOS Attributes](#deprecated-ios-attributes)

<!-- tocstop -->

## iOS Lifecycle Event Attributes
## Deprecated iOS Attributes

<!-- semconv registry.ios.lifecycle.events(omit_requirement_level) -->
<!-- semconv registry.ios.deprecated(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` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `ios.state` | string | Deprecated use the `device.app.lifecycle` event definition including `ios.state` as a payload field instead. [1] | `active` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Moved to a payload field of `device.app.lifecycle`. |

**[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.

34 changes: 0 additions & 34 deletions model/registry/android.yaml
Original file line number Diff line number Diff line change
@@ -13,37 +13,3 @@ 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: true
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
36 changes: 36 additions & 0 deletions model/registry/deprecated/android.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
groups:
- id: registry.android.deprecated
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: >
Deprecated use the `device.app.lifecycle` event definition including
`android.state` as a payload field instead.
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: true
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
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
groups:
- id: registry.ios.lifecycle.events
- id: registry.ios.deprecated
prefix: ios
type: attribute_group
brief: >
The iOS platform on which the iOS application is running.
attributes:
- id: state
stability: experimental
deprecated: "Moved to a payload field of `device.app.lifecycle`."
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.
Deprecated use the `device.app.lifecycle` event definition including
`ios.state` as a payload field instead.
type:
allow_custom_values: true
members:
Loading