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

Consider changing property naming convention #2526

Closed
trask opened this issue Jan 14, 2021 · 6 comments · Fixed by #2792
Closed

Consider changing property naming convention #2526

trask opened this issue Jan 14, 2021 · 6 comments · Fixed by #2792
Labels
Feature Request Suggest an idea for this project

Comments

@trask
Copy link
Member

trask commented Jan 14, 2021

The Java instrumentation repo is using - instead of _ in property names, e.g. otel.java.disabled.resource-providers instead of otel.java.disabled.resource_providers.

Copying comment here from open-telemetry/opentelemetry-java-instrumentation#1414 (comment) in favor of kebab-case:

Spring Boot env var / system property mappings supports both camelCase and kebab-case, but recommends kebab-case:

Property Note
acme.my-project.person.first-name Kebab case, which is recommended for use in .properties and .yml files.

And also interestingly:

The prefix value for the annotation must be in kebab case (lowercase and separated by -, such as acme.my-project.person).

@trask trask added the Feature Request Suggest an idea for this project label Jan 14, 2021
@bogdandrutu
Copy link
Member

@jkwatson I think this needs to happen before 1.0 if we want to do it

@jkwatson
Copy link
Contributor

jkwatson commented Feb 9, 2021

this is all in the auto-instrumentation module, which is still tagged as -alpha so we can still address it after 1.0.0, I believe. Also... do we actually have anything with dashes or underscores at all right now? My quick search didn't uncover any.

@jkwatson
Copy link
Contributor

jkwatson commented Feb 9, 2021

oh...the only one I found was "otel.java.disabled.resource_providers" (and, yes, obviously this was what was being talked about).

@jkwatson
Copy link
Contributor

jkwatson commented Feb 9, 2021

And, this isn't in the autoconfigure module. 🤦 sorry for the brain fart.

@jkwatson
Copy link
Contributor

jkwatson commented Feb 9, 2021

I don't have much of an opinion on this one at all. Consistency with auto-instrumentation is probably the most important thing.

@jkwatson
Copy link
Contributor

jkwatson commented Feb 9, 2021

does the otel spec have any opinion (even implicit) in the naming of things like this?

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

Successfully merging a pull request may close this issue.

3 participants