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

docs(resource-detector-alibaba): add Semantic Conventions to alibaba README #2077

Closed
wants to merge 1 commit into from

Conversation

maryliag
Copy link
Contributor

@maryliag maryliag commented Apr 3, 2024

Which problem is this PR solving?

  • Add Semantic Conventions to Alibaba README

Short description of the changes

Copy link

codecov bot commented Apr 3, 2024

Codecov Report

Merging #2077 (9dba8c1) into main (dfb2dff) will decrease coverage by 0.34%.
Report is 32 commits behind head on main.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2077      +/-   ##
==========================================
- Coverage   90.97%   90.63%   -0.34%     
==========================================
  Files         146      146              
  Lines        7492     7488       -4     
  Branches     1502     1494       -8     
==========================================
- Hits         6816     6787      -29     
- Misses        676      701      +25     

see 8 files with indirect coverage changes

@maryliag maryliag changed the title add Semantic Conventions to alibaba README docs: add Semantic Conventions to alibaba README Apr 3, 2024
Add Semantic Conventions to Alibaba README

PArt Of open-telemetry#2025

Signed-off-by: maryliag <[email protected]>
@maryliag maryliag changed the title docs: add Semantic Conventions to alibaba README docs(resource-detector-alibaba): add Semantic Conventions to alibaba README Apr 3, 2024
Comment on lines +37 to +46
| Resource Attribute | Description | Notes |
|-------------------------|-----------------------------------------------------------------| ------------------------------------------ |
| cloud.account.id | Value of `owner-account-id` on Alibaba Cloud | Key: `SEMRESATTRS_CLOUD_ACCOUNT_ID` |
| cloud.availability_zone | Value of `zone-id` on Alibaba Cloud | Key: `SEMRESATTRS_CLOUD_AVAILABILITY_ZONE` |
| cloud.platform | In this context, it's always `alibaba_cloud_ecs` | Key: `SEMRESATTRS_CLOUD_PLATFORM` |
| cloud.provider | In this context, it's always `alibaba_cloud` | Key: `SEMRESATTRS_CLOUD_PROVIDER` |
| cloud.region | Value of `region-id` on Alibaba Cloud | Key: `SEMRESATTRS_CLOUD_REGION` |
| host.id | Value of `instance-id` on Alibaba Cloud | Key: `SEMRESATTRS_HOST_ID` |
| host.name | The hostname for the app, retrieve from the `hostname` endpoint | Key: `SEMRESATTRS_HOST_TYPE` |
| host.type | Value of `instance-type` on Alibaba Cloud | Key: `SEMRESATTRS_HOST_NAME` |
Copy link
Member

Choose a reason for hiding this comment

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

Based on comments over on #1778 we may decide not to move forward with this Notes section as it is extra to maintain.

@maryliag
Copy link
Contributor Author

maryliag commented Apr 9, 2024

sounds good, will close this

@maryliag maryliag closed this Apr 9, 2024
@maryliag maryliag deleted the doc-alibaba branch April 9, 2024 12:58
@JamieDanielson
Copy link
Member

Oh! I should note, I think your other section in here referencing the specific semantic convention version is okay to keep - just the Keys in the table are not needed. Want to re-open this or open a new PR for that @maryliag ? The original updates were on #2046 but that was before we started combining the two updates together, so it looks like we still want to mention the version in use in the README.

@maryliag
Copy link
Contributor Author

Ah okay, thanks @JamieDanielson , I created a new PR for it: #2130

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants