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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename configuration properties otel.instrumentation.* to match package naming convention #2444

Closed
trask opened this issue Mar 1, 2021 · 4 comments

Comments

@trask
Copy link
Member

trask commented Mar 1, 2021

The package naming in this repo is all good (don't want you to worry that I'm opening that can of worms 馃槃):

  • io.opentelemetry.javaagent - javaagent
  • io.opentelemetry.javaagent.instrumentation - javaagent instrumentation
  • io.opentelemetry.instrumentation - library instrumentation

Should we follow similar naming for configuration properties:

  • otel.javaagent.* - javaagent properties
  • otel.javaagent.instrumentation.* - javaagent instrumentation properties
  • otel.instrumentation.* - library instrumentation properties (if we even need any? e.g. library instrumentation could possibly be programmatic config only)

The things that would need to be renamed if we want to make this change are:

  • otel.instrumentation.default-enabled --> otel.javaagent.instrumentation.default-enabled
  • otel.instrumentation.[id].enabled --> otel.javaagent.instrumentation.[id].enabled
  • otel.instrumentation.[id].* --> otel.javaagent.instrumentation.[id].* (instrumentation-specific properties)
  • otel.instrumentation.db-statement-sanitizer.enabled --> otel.javaagent.db-statement-sanitizer.enabled (or maybe otel.javaagent.instrumentation.db-statement-sanitizer.enabled, but that looks like otel.javaagent.instrumentation.[id].enabled)
@anuraaga
Copy link
Contributor

anuraaga commented Mar 1, 2021

otel.instrumentation.* - library instrumentation properties (if we even need any? e.g. library instrumentation could possibly be programmatic config only)

Think long term we don't want any properties read in library instrumentation, programmatic makes sense. In which case the current names seem ok.

@mateuszrzeszutek
Copy link
Member

otel.instrumentation.db-statement-sanitizer.enabled --> otel.javaagent.db-statement-sanitizer.enabled (or maybe otel.javaagent.instrumentation.db-statement-sanitizer.enabled, but that looks like otel.javaagent.instrumentation.[id].enabled)

Hmm, don't we want to move all the sanitization classes to instrumentation-api?

Anyway, I think that I like the current names: you don't have to think if it's javaagent or library instrumentation, the naming is hierarchical and logical: otel > instrumentation > library > enabled

@trask
Copy link
Member Author

trask commented Mar 2, 2021

I think we have agreement now on the following:

  • otel.javaagent.* - javaagent properties
  • otel.instrumentation.common.* - common properties that are used across multiple instrumentations, e.g. otel.instrumentation.common.peer-service-mapping and otel.instrumentation.common.db-statement-sanitizer.enabled
  • otel.instrumentation.[id].* - instrumentation specific properties
  • library instrumentation will only support programmatic configuration (so no property names involved)

@trask
Copy link
Member Author

trask commented Mar 4, 2021

Closed by #2457 and #2486

@trask trask closed this as completed Mar 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants