open-telemetry
[semconv][infra] Support search over semconv attributes registry
URL
https://opentelemetry.io/docs/specs/semconv/attributes-registry/
Description
The attribute registry is huge, and it can be difficult to know which namespace to look in. Some form of search underneath the root page across all namespaces would be supremely useful!
Thanks for the feedback, @xeger! The semantic convention documentation is pulled in from the semconv repository, but I don't know that that rules out a search functionality on the website. I'll let our platform expert chime in. @chalin?
The site has search, but it is site-wide. We don't have in-page search at the moment.
Can you give examples of the types of terms that you'd search for?
@open-telemetry/specs-semconv-approvers PTAL! having a "search function" across all entries would be nice indeed, but we have to discuss how this may be implemented.
All: If you search for "thread", like this https://opentelemetry.io/search/?q=thread. The first result is from the registry:
Might this be good enough for now?
I could look into setting up offline search rooted in the registry page, but it'll be a while before I have the time. We'll need to decide on relative priorities.
The site has search, but it is site-wide. We don't have in-page search at the moment.
Can you give examples of the types of terms that you'd search for?
Yikes, I'm sorry; I missed the original query bout which terms I'd search for.
Typically I'm trying to see if the semconv already has a defined attribute or namespace for the concept I'm interested in, so I would be searching for tokens int he dot.separated.name of a hypothetical attribute, whose name I would be making guesses about.
Your suggestion to use site-wide search is marginally useful to me; thank you for the tip. It returns a lot of irrelevant results but it also returns paydirt.
For example, if I guess that there is an http.request namespace defined in the semconv, then:
https://opentelemetry.io/search/?q=http.request#gsc.tab=0&gsc.q=http.request&gsc.page=1
This yields a hit (after some skimming of various other pages talking about HTTP-related SDKs, plugins, configuration of daemons, and so on).
having a dedicated search for semantic conventions would indeed be helpful, a good starting point is the registry within semconv these days:
https://opentelemetry.io/docs/specs/semconv/registry/attributes/
It does give you a list of all available namespaces, so you could click into http and then look for request etc, but indeed we might want to have a way to search or see all of them