semantic-conventions
semantic-conventions copied to clipboard
Add semantic convention of influxDB
Changes
Please provide a brief description of the changes here. Add semantic convention of influxDB. Relative to https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/10850
Merge requirement checklist
- [x] CONTRIBUTING.md guidelines followed.
- [x] Change log entry added, according to the guidelines in When to add a changelog entry.
- If your PR does not need a change log, start the PR title with
[chore]
- If your PR does not need a change log, start the PR title with
- [x] schema-next.yaml updated with changes to existing conventions.
@steverao do you envision adding any specifics about InfluxDB? Like custom attributes, metrics, some non-obvious mapping for common attributes?
If the goal is to add a constant for db.system, then it can be done without adding influxdb.md or the yaml section for it.
Curious what you think and what's your motivation to add things beyond system constant.
Thanks!
@steverao do you envision adding any specifics about InfluxDB? Like custom attributes, metrics, some non-obvious mapping for common attributes?
At present, besides db.system, I also added some information about new database framework of InfluxDB, such as attributes and examples in https://github.com/open-telemetry/semantic-conventions/pull/949/files#diff-b0b92e2b139407d14dd05fec354af626034d748c5ced214a074e1e2389cffc2c
@steverao it does not look like influxDB needs any customization on top of generic attributes and descriptions we have for common DB attributes/spans. Am I correct?
There is no requirement to add a semconv file for each DB and I'd prefer if we just added a constant system name unless we have something custom.
This PR was marked stale due to lack of activity. It will be closed in 7 days.
it does not look like influxDB needs any customization on top of generic attributes and descriptions we have for common DB attributes/spans. Am I correct?
Yes, for the plugin, it don't contain special customization.
There is no requirement to add a semconv file for each DB.
At first, I saw other database plugins provide relevant YAML document, so I added it for InfluxDB. For this situation, don' you recommend to add its unique YAML document? In the document, I added some explanations for its attributes. I think it will be better if we conserve it. If you think it's not necessary. I can delete it later.
@steverao
Thanks for the context! We have ~50 different DB systems and only ~10 have a dedicated yaml/md. The criteria to add a yaml and md file if there are any custom attributes or some behavior that's different than one described in the common docs.
It seems that InfluxDB usage of common attributes is very well aligned with common definitions (database name is used in db.namespace and command name in the db.operation.name), so it should be enough just to add db.system constant.
It seems that InfluxDB usage of common attributes is very well aligned with common definitions (database name is used in db.namespace and command name in the db.operation.name), so it should be enough just to add db.system constant.
Thank you for your explanation! I deleted other contents except db.system constant in InfluxDB YAML document now. Please help me to review whether there are any other problems again?
It seems there is unstable URL in other document which caused the CI running failed!