Add support for custom attributes and serviceVersion attribute from resource object to include in telemetry items.

[treyjones-ms]

This PR introduces the inclusion of both the serviceVersion schema attribute and any custom attributes added to an OpenTelemetry resource that is associated with any telemetry to the TelemetryItem data properties.

NOTE: I tried adding them to the AdditionalProperties dictionary present in the base class of MonitorDomain so that all telemetry types inheriting from it would get it, but it still didn't show up in app insights (need someone to help me understand why). So, instead I had to cast to the derived type of each type of telemetry and write it into the Properties dictionary. That made them show up.

I also assigned the serviceVersion to both AiCloudRoleVer and AiApplicationVer (I only noticed a "Application Version" in app insights show up and not a "Role Version"). These will default to "Unknown" if not specified.

I have not created or updated any unit tests or integration tests to specifically test out custom attributes on resources, but did make sure existing ones were adjusted to still run and pass (updated expected tag counts for two new version fields). I did not run the integration tests.

This is in response to issue #35487.

UPDATE 05/05/2023: I have verified that integration tests pass as well.

[github-actions]

Thank you for your contribution @treyjones-ms! We will review the pull request and get back to you soon.

[treyjones-ms]

@microsoft-github-policy-service agree company="Microsoft" Thomas L. "Trey" Jones - CISSP, CEH Sr Security Software Eng Microsoft Personnel Portal Team Mission Engineering Foundations - Mission Apps and Engineering Systems ***@***.******@***.***> [Microsoft Logo] From: microsoft-github-policy-service[bot] ***@***.***> Sent: Thursday, May 4, 2023 9:42 PM To: Azure/azure-sdk-for-net ***@***.***> Cc: Trey Jones ***@***.***>; Mention ***@***.***> Subject: Re: [Azure/azure-sdk-for-net] Add support for custom attributes and serviceVersion attribute from resource object to include in telemetry items. (PR #36027) @treyjones-ms<https://github.com/treyjones-ms> please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information. @microsoft-github-policy-service agree [company="{your company}"] Options: * (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer. @microsoft-github-policy-service agree * (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term "You" includes me and my employer. @microsoft-github-policy-service agree company="Microsoft" Contributor License Agreement Contribution License Agreement This Contribution License Agreement ("Agreement") is agreed to by the party signing below ("You"), and conveys certain license rights to Microsoft Corporation and its affiliates ("Microsoft") for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below. 1. Definitions. "Code" means the computer software code, whether in human-readable or machine-executable form, that is delivered by You to Microsoft under this Agreement. "Project" means any of the projects owned or managed by Microsoft and offered under a license approved by the Open Source Initiative (www.opensource.org<http://www.opensource.org/>). "Submit" is the act of uploading, submitting, transmitting, or distributing code or other content to any Project, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving that Project, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Submission." "Submission" means the Code and any other copyrightable material Submitted by You, including any associated comments and documentation. 2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any Project. This Agreement covers any and all Submissions that You, now or in the future (except as described in Section 4 below), Submit to any Project. 3. Originality of Work. You represent that each of Your Submissions is entirely Your original work. Should You wish to Submit materials that are not Your original work, You may Submit them separately to the Project if You (a) retain all copyright and license information that was in the materials as You received them, (b) in the description accompanying Your Submission, include the phrase "Submission containing materials of a third party:" followed by the names of the third party and any licenses or other restrictions of which You are aware, and (c) follow any other instructions in the Project's written guidelines concerning Submissions. 4. Your Employer. References to "employer" in this Agreement include Your employer or anyone else for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your Submission is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Submission before signing this Agreement. In that case, the term "You" in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Submissions. 5. Licenses. * Copyright License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third parties. * Patent License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under Your patent claims that are necessarily infringed by the Submission or the combination of the Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and import or otherwise dispose of the Submission alone or with the Project. * Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are granted by implication, exhaustion, estoppel or otherwise. 1. Representations and Warranties. You represent that You are legally entitled to grant the above licenses. You represent that each of Your Submissions is entirely Your original work (except as You may have disclosed under Section 3). You represent that You have secured permission from Your employer to make the Submission in cases where Your Submission is made in the course of Your work for Your employer or Your employer has intellectual property rights in Your Submission by contract or applicable law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You have the necessary authority to bind the listed employer to the obligations contained in this Agreement. You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. 2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which You later become aware that would make Your representations in this Agreement inaccurate in any respect. 3. Information about Submissions. You agree that contributions to Projects and information about contributions may be maintained indefinitely and disclosed publicly, including Your name and other information that You submit with Your Submission. 4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County, Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens. 5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft. - Reply to this email directly, view it on GitHub<#36027 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/A7SHTLU3VMTDLSWBOU2AASTXERSHPANCNFSM6AAAAAAXWRXFFY>. You are receiving this because you were mentioned.Message ID: ***@***.******@***.***>>

[cijothomas]

Please add a more detailed description of the change. Its not clear if this is applicable to all signals (logs, metrics and traces).

If this change is taking every resource attribute and attaching them to logs, traces and metrics, then this should be designed first. Resource could contain potentially high cardinality items, and attaching them to Metric properties can exhaust the metric time series limit.

I suggest to have an issue first, where the detailed design is described.

[treyjones-ms]

Will add the clarification as it applies to all three. It's my understanding that by design, the resource object in OpenTelemetry is expected to be associated with any type of telemetry emitted (it represents the source of the telemetry and is a place to capture things identifying the service, its environment, version, namespace, etc.). If someone can clarify if it is expected on metrics or not, that would be great. It's very easy to back that out. Can you clarify what you mean by "high cardinality items"? Right now, I think the implementation is only expecting strings (which may be an incorrect assumption).

[treyjones-ms]

Here's the OpenTelemetry documentation for resources: https://opentelemetry.io/docs/instrumentation/net/resources/. Based on some of the information there, it could be used for logs, traces, or metrics.

[treyjones-ms]

From their glossary:

Resource
Captures information about the entity for which telemetry is recorded. For example, a process producing telemetry that is running in a container on Kubernetes has a pod name, it is in a namespace and possibly is part of a deployment which also has a name. All three of these attributes can be included in the Resource and applied to any data source.

[cijothomas]

I understand Resource in OpenTelemetry is applicable to all signals. My question is about applying it specifically for Azure Monitor. It should be an opt-in feature and/or should be flexible enough for users to pick which resource attributes they want attached to their telemetry, instead of attaching everything by default. (For Metrics, it could eat up cardinality, and for all signals, it adds up ingestion-size and can increase Azure bill for users)

There should be a design first on how AzureMonitor want to model Resources (attach to all telemetry or store in one place, and refer to it from other telemetry, how to opt-in/out, how to customize etc.)

[treyjones-ms]

I understand Resource in OpenTelemetry is applicable to all signals. My question is about applying it specifically for Azure Monitor. It should be an opt-in feature and/or should be flexible enough for users to pick which resource attributes they want attached to their telemetry, instead of attaching everything by default. (For Metrics, it could eat up cardinality, and for all signals, it adds up ingestion-size and can increase Azure bill for users)

There should be a design first on how AzureMonitor want to model Resources (attach to all telemetry or store in one place, and refer to it from other telemetry, how to opt-in/out, how to customize etc.)

Can you elaborate on the "store in one place and refer to it from other telemetry". How does that work with the ingestion on App Insights and get displayed when looking at transactions in the portal? Also, curious how this defers from other exporters (OTLP, Geneva, etc.).

[cijothomas]

#36063 This PR just got merged. I am not sure if it'll have the details on "how", but I expect backend/UI to understand resources via the mechanism from that PR.

[rajkumar-rangaraj]

@treyjones-ms #36063 has an updated description, could you please check and let us know if you have any questions.

[treyjones-ms]

@rajkumar-rangaraj - I put a comment on your PR (even though it's already merged). I'm guessing my PR might be OBE at this point, but confirm after reviewing my comment.

[rajkumar-rangaraj]

Other PR address the part of the issue that you're attempting to cover. Instead of duplicating the resource attributes in every trace and log, having a common storage of resource with a join would be beneficial.

[cijothomas]

See https://github.com/Azure/azure-sdk-for-net/pull/36027/files#r1186226609

[treyjones-ms]

I agree service version should probably be there all the time (which my PR does already). I’m about to push an update to the PR which adds an option flag to turn on/off the custom attributes for each telemetry type.

Sent from my iPhone On May 5, 2023, at 5:32 PM, Liudmila Molkova ***@***.***> wrote:  @lmolkova commented on this pull request.

________________________________ In sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/CHANGELOG.md<#36027 (comment)>:

@@ -4,6 +4,9 @@

### Features Added +* Added service version and custom attributes specified on the resource object to the published telemetry. @cijothomas<https://github.com/cijothomas> would it be ok to just add service.version as there is a specific AppInisghts property for it? It sounds arbitrary resource attributes should not be added because it's not yet clear how it should be done - is it correct? — Reply to this email directly, view it on GitHub<#36027 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/A7SHTLT5W5CUSWHHQCJPWFDXEV5WXANCNFSM6AAAAAAXWRXFFY>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[cijothomas]

See #36063

[github-actions]

Hi @treyjones-ms. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

[github-actions]

Hi @treyjones-ms. Thank you for your contribution. Since there hasn't been recent engagement, we're going to close this out. Feel free to respond with a comment containing /reopen if you'd like to continue working on these changes. Please be sure to use the command to reopen or remove the no-recent-activity label; otherwise, this is likely to be closed again with the next cleanup pass.