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

Rework device events #1880

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

breedx-splk
Copy link
Contributor

@breedx-splk breedx-splk commented Feb 6, 2025

Also rolls back deprecation for required registry attributes.

Changes

Migrating device.app.lifecycle event from using body to using attributes for ios.state and android.state. This also requires reintroducing those attributes (which were previously deprecated).

Merge requirement checklist

model/device/events.yaml Outdated Show resolved Hide resolved
model/ios/registry.yaml Outdated Show resolved Hide resolved
model/android/registry.yaml Outdated Show resolved Hide resolved
model/device/events.yaml Outdated Show resolved Hide resolved
@github-actions github-actions bot added the enhancement New feature or request label Feb 6, 2025
@breedx-splk breedx-splk marked this pull request as ready for review February 6, 2025 19:00
@breedx-splk breedx-splk requested review from a team as code owners February 6, 2025 19:00
model/ios/registry.yaml Outdated Show resolved Hide resolved
brief: >
The iOS platform on which the iOS application is running.
The iOS platform on which the iOS application is running.
attributes:
- id: ios.state
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know it's been like this before, but ios.state naming does not seem quite right. It looks like it's a state of iOS and not the app. If we have some other state on ios like ios.wifi.state, it would be even more confusing to have ios.state without any additional qualifier.

Maybe we can do ios.app.state and andrioid.app.state ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's less confusing when it's simply scope to an event. 🙃

deprecated: "Moved to a payload field of `device.app.lifecycle`."
stability: development
brief: >
This attribute represents the state of the application.
note: >
The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate),
and from which the `OS terminology` column values are derived.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what are the OS terminology and OS identifiers things?

model/device/events.yaml Outdated Show resolved Hide resolved
model/device/events.yaml Outdated Show resolved Hide resolved
@@ -0,0 +1,8 @@
change_type: enhancement
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should mark it as breaking (breaking enhancement) since body fields will no longer be in the payload

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so what's the literal string that should go in here then?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Development

Successfully merging this pull request may close these issues.

3 participants