Comments (6)
To be clear: service.telemetry.metrics.level
is also not standard YAML notation. There is no standard to refer to nested keys in a YAML document as far as I am aware.
from opentelemetry.io.
The main downside of dot notation I see (which is the reason we use ::
for referring to nested keys) is that OpenTelemetry semantic conventions use dots for namespacing and we occasionally use semantic conventions as the name of configuration settings.
To put a concrete example, take the following dockerstats receiver configuration from its README:
receivers:
docker_stats:
metrics:
container.cpu.percent:
enabled: false
container.cpu.utilization:
enabled: true
This configuration disables the container.cpu.percent
metric and enables the container.cpu.utilization
metric. How do you refer to the setting that does this? Using ::
, you have receivers::docker_stats::metrics::container.cpu.percent
, but if you use dots it becomes ambiguous (receivers.docker_stats.metrics.container.cpu.percent
) and one doesn't know where to split for nesting
from opentelemetry.io.
The main downside of dot notation I see (which is the reason we use :: for referring to nested keys) is that OpenTelemetry semantic conventions use dots for namespacing and we occasionally use semantic conventions as the name of configuration settings.
That's a great reason and we should put it that way in the doc, what do you think @tiffany76 ?
from opentelemetry.io.
@open-telemetry/collector-approvers @open-telemetry/collector-maintainers please take a look
from opentelemetry.io.
I'd rather use the dot notation, which is more Pythonesque and hence closer to Python? Although depending on the language one might recognize ::
as a namespace notation. Slashes are another option.
See https://github.com/wwkimball/yamlpath/wiki/Segments-of-a-YAML-Path
from opentelemetry.io.
Sounds good to me, @svrnm, @mx-psi . I will make the addition today. Thanks!
from opentelemetry.io.
Related Issues (20)
- Failed to execute npm run seq HOT 14
- [CI] i18n GH action check doesn't always work
- fix supported python version for Python SDK in main page HOT 6
- Contributing guidelines should be consolidated in one place
- Spec status "Experimental" renamed to "Development": Adjust shortcodes and language statuses
- Document new version of Health Check extension
- New Blog Post: Humans of OTel - KubeCon EU HOT 2
- New Blog Post: Getting Started Survey HOT 2
- [i18n] Ensure that fallback pages have `en` lang attribute
- Page internal search shows external results HOT 4
- [i18n][design] Interpret absolute paths as locale specific
- Create blog post for KubeCon China
- Update blog policy for posts including other CNCF projects
- New Blog Post: Tips for Troubleshooting the Target Allocator HOT 2
- Documentation update: add troubleshooting tips for OpenTelemetry Operator's Target Allocator HOT 1
- Misleading link to collector from SDK examples HOT 4
- Documentation update: add troubleshooting tips for OpenTelemetry Operator's Auto-instrumentation capability
- Create documentation for running the OTel Demo on GitHub Codespaces HOT 16
- chinese character "軽装" should be "計装" HOT 2
- Documentation issue in: Building a custom collector HOT 7
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from opentelemetry.io.