Create `app.installation.id` attribute #1897

bencehornak · 2025-02-10T11:26:32Z

Warning

This PR must be merged together with #1951 as they are highly related, dear maintainers, please add them to the same milestone.

Changes

Added app.installation.id (the first attribute in the installation namespace), which is a unique identifier representing the installation of an application on a specific device. Its definition is more-or-less identical to the old definition of device.id, which has always identified app installations and not devices.

In #1951 I am changing the definition of device.id, so that it actually identifies the device.

For more context see #1874.

Merge requirement checklist

CONTRIBUTING.md guidelines followed.
Change log entry added, according to the guidelines in When to add a changelog entry.
- If your PR does not need a change log, start the PR title with [chore]
schema-next.yaml updated with changes to existing conventions.

joaopgrassi

I think this changes makes sense given the discussion in the issue. But I think it would be better if the changes related to device would be in a separate PR. Then you can include the changelog for it as a breaking change, since it is now Opt-In.

LikeTheSalad

Thanks! I like the idea of using a name that better describes what we were doing with device.id. I've just added some questions on specific details, but I'm on board with the change.

docs/attributes-registry/installation.md

bencehornak · 2025-02-10T16:41:03Z

I think this changes makes sense given the discussion in the issue. But I think it would be better if the changes related to device would be in a separate PR. Then you can include the changelog for it as a breaking change, since it is now Opt-In.

@joaopgrassi Thanks for your feedback! My reasoning for adding two changes to a single PR was that I see the two changes as a single transaction. If, say, the device.id changes are merged first, then the SDK users won't have any recommended fields to identify different installations until the 2nd PR with the installation.id changes are merged. If we do it other way around, for a short period of time there will be significant overlaps between the definitions of device.id and installation.id, so that would also not be ideal.

So right now I don't know, how to put the two changes in topological order given their circular dependency, but if you help me figure this out, I'm happy to split this PR into two.

model/device/registry.yaml

model/installation/registry.yaml

schema-next.yaml

model/device/registry.yaml

joaopgrassi · 2025-02-11T08:13:26Z

I think this changes makes sense given the discussion in the issue. But I think it would be better if the changes related to device would be in a separate PR. Then you can include the changelog for it as a breaking change, since it is now Opt-In.

@joaopgrassi Thanks for your feedback! My reasoning for adding two changes to a single PR was that I see the two changes as a single transaction. If, say, the device.id changes are merged first, then the SDK users won't have any recommended fields to identify different installations until the 2nd PR with the installation.id changes are merged. If we do it other way around, for a short period of time there will be significant overlaps between the definitions of device.id and installation.id, so that would also not be ideal.

So right now I don't know, how to put the two changes in topological order given their circular dependency, but if you help me figure this out, I'm happy to split this PR into two.

Yes, I understand. We have been asked by users though that such bundling breaking changes with other changes such as this makes it harder for them to track breaking changes, which is also understandable. so, we have been trying recently to better identify/label breaking changes PRs to help in such cases.

I think we could still make it work to merge both of them separately. You will need approvals in both anyway and once both are good we just merge them together in the same release. We can for example, add the PRs into the same milestone.

…tion-id

bencehornak · 2025-02-17T07:09:50Z

@joaopgrassi alright, I'll restrict this PR to the new definition of device.id, and will add the new attribute to a separate PR.

…tion-id

bencehornak · 2025-02-27T20:30:12Z

Sorry folks for the delay, now I'm back from holiday!

@joaopgrassi I have extracted the changes to device.id to #1951 as you requested, this PR only contains the addition of the app.installation.id attribute.

@lmolkova, @LikeTheSalad, @bidetofevil I believe that I have addressed all of your remarks, I would appreciate your feedback on the new additions.

LikeTheSalad

Thank you! 🙏

bencehornak · 2025-03-11T08:13:47Z

@joaopgrassi @lmolkova, the two PRs (this and #1951) are ready for your review, could you take a look, if you get a chance?

trask · 2025-03-12T20:49:07Z

cc @open-telemetry/semconv-mobile-approvers

trask · 2025-03-18T19:41:35Z

it would be great if we can get approvals from the iOS and browser perspectives as well (if this attribute is applicable there)

docs/attributes-registry/app.md

joaopgrassi

I don't immediately see a problem with introducing this new top-level area app. Let's get more eyes and approvals from other maintainers here.

model/app/registry.yaml

model/app/resources.yaml

Co-authored-by: jason plumb <[email protected]> Co-authored-by: Joao Grassi <[email protected]>

- Add the new metric API package structure prototyped in https://github.com/MrAlias/semconv-go Prototypes of new metric API use: - MrAlias/opentelemetry-go-contrib#6136 - MrAlias/opentelemetry-go-contrib#6135 - MrAlias/opentelemetry-go-contrib#6134 - Generate `semconv/v1.32.0` - Drop the `kestrel` metric namespace as this is a Java specific technology ## [`v1.32.0` semantic convention release notes](https://github.com/open-telemetry/semantic-conventions/releases/tag/v1.32.0): <div data-pjax="true" data-test-selector="body-content" data-view-component="true" class="markdown-body my-3"><p>📣 This release is the second release candidate for the Database Semantic Conventions, with <strong>db conventions stability planned to be declared in the subsequent release</strong>.</p> <h3>🛑 Breaking changes 🛑</h3> <ul> <li><code>device</code>: Change the definition of <code>device.id</code> and make it opt-in. (<a href="open-telemetry/semantic-conventions#1874" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1874/hovercard">#1874</a>, <a href="open-telemetry/semantic-conventions#1951" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1951/hovercard">#1951</a>)</li> <li><code>feature_flag</code>: Rename <code>evaluation</code> to <code>result</code> for feature flag evaluation result attributes (<a href="open-telemetry/semantic-conventions#1989" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1989/hovercard">#1989</a>)</li> </ul> <h3>🚀 New components 🚀</h3> <ul> <li><code>app</code>: Create <code>app.installation.id</code> attribute (<a href="open-telemetry/semantic-conventions#1874" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1874/hovercard">#1874</a>, <a href="open-telemetry/semantic-conventions#1897" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1897/hovercard">#1897</a>)</li> <li><code>cpython</code>: Add CPython runtime garbage collector metrics (<a href="open-telemetry/semantic-conventions#1930" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1930/hovercard">#1930</a>)</li> </ul> <h3>💡 Enhancements 💡</h3> <ul> <li><code>vcs</code>: Add owner and provider name to VCS attribute registry (<a href="open-telemetry/semantic-conventions#1452" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1452/hovercard">#1452</a>)</li> <li><code>vcs</code>: Remove fallback value for VCS provider name attribute (<a href="open-telemetry/semantic-conventions#2020" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/2020/hovercard">#2020</a>)</li> <li><code>db</code>: Truncate <code>db.query.summary</code> to 255 characters if parsed from the query (<a href="open-telemetry/semantic-conventions#1978" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1978/hovercard">#1978</a>)</li> <li><code>db</code>: Normalize spaces in <code>db.operation.name</code> (if any) (<a href="open-telemetry/semantic-conventions#2028" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/2028/hovercard">#2028</a>)</li> <li><code>db</code>: <code>db.operation.parameter.<key></code> should not be captured for batch operations (<a href="open-telemetry/semantic-conventions#2026" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/2026/hovercard">#2026</a>)</li> <li><code>db</code>: Add <code>db.stored_procedure.name</code> (<a href="open-telemetry/semantic-conventions#1491" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1491/hovercard">#1491</a>)</li> <li><code>gcp</code>: Adds GCP AppHub labels for resource. (<a href="open-telemetry/semantic-conventions#2006" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/2006/hovercard">#2006</a>)</li> <li><code>error</code>: Add <code>error.message</code> property for human-readable error message on events. (<a href="open-telemetry/semantic-conventions#1992" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1992/hovercard">#1992</a>)</li> <li><code>profile</code>: Extend the list of known frame types with a value for Go and Rust (<a href="open-telemetry/semantic-conventions#2003" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/2003/hovercard">#2003</a>)</li> <li><code>otel</code>: Adds SDK self-monitoring metrics for log processing (<a href="open-telemetry/semantic-conventions#1921" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1921/hovercard">#1921</a>)</li> </ul>

Create installation.id, redefine device.id

5176337

bencehornak requested review from a team as code owners February 10, 2025 11:26

bencehornak added 2 commits February 10, 2025 12:29

Add entry to schema-next

1997457

Add changelog entry

606df0e

github-actions bot added the enhancement New feature or request label Feb 10, 2025

joaopgrassi reviewed Feb 10, 2025

View reviewed changes

LikeTheSalad reviewed Feb 10, 2025

View reviewed changes

docs/attributes-registry/installation.md Outdated Show resolved Hide resolved

docs/attributes-registry/installation.md Outdated Show resolved Hide resolved

docs/attributes-registry/installation.md Outdated Show resolved Hide resolved

bencehornak commented Feb 10, 2025

View reviewed changes

docs/attributes-registry/installation.md Outdated Show resolved Hide resolved

Update GH templates

30f369b

lmolkova reviewed Feb 10, 2025

View reviewed changes

bencehornak added 8 commits February 16, 2025 17:56

Improve language, remove same vendor comment

01cb310

Relax MUST to SHOULD

be11f06

Improve language

bdb3175

Remove PII notice from installation.id

9aa23c7

Revert schema-next.yaml change

1661c60

Explicitly point out PII information

be512a1

Change reference to absolute one

6e57e18

Merge remote-tracking branch 'origin/main' into device-id-vs-installa…

962777a

…tion-id

bencehornak added 7 commits February 27, 2025 20:37

Add note about alternative installation.id implementations

0ac6308

Revert prefix idea

7bf94ad

Rename attribute to app.installation.id

922bbfa

Merge remote-tracking branch 'origin/main' into device-id-vs-installa…

9389e2c

…tion-id

Move device.id changes to a separate PR

b1ca8d5

Rename directory in CODEOWNERS too

34207c3

Make adjustments based on @bidetofevil's comment

fd2e226

LikeTheSalad approved these changes Mar 5, 2025

View reviewed changes

Merge branch 'main' into device-id-vs-installation-id

374884c

trask moved this from In Review to Needs More Approval in Semantic Conventions Triage Mar 12, 2025

MSNev approved these changes Mar 18, 2025

View reviewed changes

bidetofevil reviewed Mar 18, 2025

View reviewed changes

docs/attributes-registry/app.md Show resolved Hide resolved

docs/attributes-registry/app.md Outdated Show resolved Hide resolved

docs/attributes-registry/app.md Show resolved Hide resolved

docs/attributes-registry/app.md Show resolved Hide resolved

bryce-b self-requested a review March 20, 2025 16:40

bryce-b approved these changes Mar 20, 2025

View reviewed changes

breedx-splk and others added 4 commits March 21, 2025 16:29

Merge branch 'main' into device-id-vs-installation-id

edd83f8

Add note about app upgrades

0d2f2b3

Add note about multiple OTel SDKs in an app

79c88d5

Change sentence to introduce Android examples

c93b2d6

joaopgrassi approved these changes Mar 24, 2025

View reviewed changes

model/app/registry.yaml Outdated Show resolved Hide resolved

model/app/registry.yaml Outdated Show resolved Hide resolved

bidetofevil approved these changes Mar 24, 2025

View reviewed changes

lmolkova added this to the 1.32.0 milestone Mar 25, 2025

lmolkova approved these changes Mar 25, 2025

View reviewed changes

model/app/registry.yaml Outdated Show resolved Hide resolved

model/app/resources.yaml Outdated Show resolved Hide resolved

lmolkova moved this from Needs More Approval to Ready to be Merged in Semantic Conventions Triage Mar 25, 2025

bencehornak and others added 4 commits March 25, 2025 09:56

Improve language

5792fcd

Improve description of app attributes

c5c583b

Merge branch 'main' into device-id-vs-installation-id

06320f0

Merge branch 'main' into device-id-vs-installation-id

325a7c2

trask merged commit e5ff726 into open-telemetry:main Mar 25, 2025
15 checks passed

dyladan pushed a commit to dyladan/semantic-conventions that referenced this pull request Mar 28, 2025

Create app.installation.id attribute (open-telemetry#1897)

17d6a23

Co-authored-by: jason plumb <[email protected]> Co-authored-by: Joao Grassi <[email protected]>

bencehornak mentioned this pull request Apr 3, 2025

Implement app.installation.id resource attribute open-telemetry/opentelemetry-android#922

Open

bencehornak deleted the device-id-vs-installation-id branch April 3, 2025 09:41

MrAlias mentioned this pull request May 15, 2025

Add semconv/v1.32.0 open-telemetry/opentelemetry-go#6782

Merged

Create app.installation.id attribute #1897

Create app.installation.id attribute #1897

Uh oh!

Conversation

bencehornak commented Feb 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Merge requirement checklist

Uh oh!

joaopgrassi left a comment

Choose a reason for hiding this comment

Uh oh!

LikeTheSalad left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bencehornak commented Feb 10, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joaopgrassi commented Feb 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bencehornak commented Feb 17, 2025

Uh oh!

bencehornak commented Feb 27, 2025

Uh oh!

LikeTheSalad left a comment

Choose a reason for hiding this comment

Uh oh!

bencehornak commented Mar 11, 2025

Uh oh!

trask commented Mar 12, 2025

Uh oh!

trask commented Mar 18, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joaopgrassi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Create `app.installation.id` attribute #1897

Create `app.installation.id` attribute #1897

bencehornak commented Feb 10, 2025 •

edited

Loading

joaopgrassi commented Feb 11, 2025 •

edited

Loading