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

Resources doc - reconsider use of service.name in example #1830

Closed
cartermp opened this issue Oct 8, 2022 · 5 comments · Fixed by #3018
Closed

Resources doc - reconsider use of service.name in example #1830

cartermp opened this issue Oct 8, 2022 · 5 comments · Fixed by #3018
Labels

Comments

@cartermp
Copy link
Contributor

cartermp commented Oct 8, 2022

See here: #1795 (comment)

It's more likely that someone setting a service name will do so with the OTEL_SERVICE_NAME attribute, or in code, than just as a key-value pair. I would propose that we just put another example there, or remove it.

@geekrypter
Copy link
Contributor

Hi @cartermp @svrnm, I would like to work on this issue! I am new to the Open Telemetry community and would like to start contributing!

@svrnm
Copy link
Member

svrnm commented Jul 7, 2023

Hi @cartermp @svrnm, I would like to work on this issue! I am new to the Open Telemetry community and would like to start contributing!

happy to hear that @geekrypter! If you think you know what needs to be done from the issue description, go ahead and raise a PR with us, we can help you from there. If you have any questions on the issue and what needs to be done upfront, just let us know, either here, in the slack channel (CNCF slack, #otel-comms) or in one of our meetings

@geekrypter
Copy link
Contributor

geekrypter commented Jul 7, 2023

Hi @svrnm,

Could you please clarify the following doubts:

  1. Just to make sure that I have understood the expected change, in the example block under Adding resources with environment variables section, should I remove the key value pair service.name=app.js from the attribute list?
  2. This issue seems to be there in resources.md file across other language documentation like .Net, PHP, etc. Is it expected to fix documentation for all the languages? If yes, do I have to raise a single PR or multiple PRs?

@svrnm
Copy link
Member

svrnm commented Jul 10, 2023

@geekrypter, thanks!

  1. Remove it and add a few words about OTEL_SERVICE_NAME to set it
  2. Raise one PR per language. Start with the language you feel comfortable with, we make this one good and then you can raise follow up PRs with the other languages.

@geekrypter
Copy link
Contributor

Thanks for the clarification @svrnm! Working on the issue.

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

Successfully merging a pull request may close this issue.

3 participants