cncf / cncf/toc

[Initiative]: Observability Query Language Standardization Specification

Open
#1,770 4 comments 2 reactions 2 assignees Claimed by @manolama View on GitHub
needs-group needs-kind needs-triage
Dominant language
HTML
Stars
1.9k
Forks
724
Avg merge
6d 12h
Merged PRs (30d)
4

Description

### Name

Observability Query Language Standardization Specification

### Short description

Define a set of models, querying semantics and operators to analyze observability telemetry data.

### Responsible group

TAG Operational Resilience

### Does the initiative belong to a subproject?

No

### Subproject name

_No response_

### Primary contact

Chris Larsen

### Additional contacts

@alolita
@halcyondude
@vjsamuel

### Initiative description

[TAG OBS Query Standardization WG Charter](https://docs.google.com/document/d/1JRQ4hoLtvWl6NqBu_RN8T7tFaFY5jkzdzsB9H-V370A)

### Summary
With the success of CNCF’s OpenTelemetry, observability instrumentation and collection has been standardized across the industry. Adopters are able instrument metrics, logs, traces and profiles in their systems one time and experiment with various observability backends or vendors by simply reconfiguring OTel collectors.

Unfortunately, every backend and vendor provides a different way to query and process the data. A plethora of domain specific languages (DSLs) exists with different telemetry models, semantic definitions and analytical capabilities. While pointing OTel at a new vendor is simple, rewriting dashboards, alerts and queries is not.

The goal of this working group is to recommend a set of standard models and query semantics for observability data. Such an open standard would unlock simple migrations using automated tooling, vendor solutions on top of customer provided data lakes, integration with business data, lower operational burden for observability engineers and reduce the cognitive load of observability data consumers.

### Completed Work

1. Completed a set of DSL designer interviews, documented in [GitHub](https://github.com/cncf/tag-observability/tree/main/working-groups/query-standardization/dsls). Languages include PromQL, TraceQL, DataDog QL, NRQL, KX’s Q, PPL.
2. Recorded and [published](https://www.youtube.com/playlist?list=PLN9G8268O5igu4g7NrlsT2Kh1Ee3ooz08) presentations from DSL designers including PPL, KX Q, PromQL, NRQL, UQL, TraceQL, TScript, etc.
3. Documented a set of telemetry models in [GitHub](https://github.com/cncf/tag-observability/tree/main/working-groups/query-standardization/telemetry-models).
4. Documented a small set of observability use cases in [GitHub](https://github.com/cncf/tag-observability/tree/main/working-groups/query-standardization/use-cases).
5. [Query language features rubric](https://docs.google.com/document/d/1PirGybtP2XU3CL_MzELCxLLbH9bXTL0G-hp22TToP-Y/edit).
6. [Draft semantic specification](https://docs.google.com/document/d/1KIGkZowg4O9_GaRc8jn29QVpSDUtLlXwXLQY_y8tNXY).
7. Draft [context document](https://docs.google.com/document/d/1A_r7tpLVELIhF1g6xnkmF3RNkX5_XWrSkEU0gKXKIK0/edit?tab=t.0) surrounding the semantic specification.

### Milestones (target H2 `26)
Work that is currently underway via biweekly meetings with end users and representatives from hyperscalers and observability vendors reviewing the standards. ([videos](https://www.youtube.com/playlist?list=PLN9G8268O5igu4g7NrlsT2Kh1Ee3ooz08)):

1. Complete reviewing and commenting on the draft semantic specification.
2. Define and review standard observability specific operators

### Follow Up/Concurrent Initiatives
The following are initiatives building on the deliverable of this work:

1. Reference implementation of an observability query federation and proxy project
2. Standard syntax recommendation
3. Blog posts about the spec
4. Maintenance of the standard

### Resources

- CNCF Slack Channel: [#obs-query-standard-wg](https://cloud-native.slack.com/archives/C057ZDS60PP)
- CNCF Tag Observability [Github Repo](https://github.com/cncf/tag-observability/tree/main/working-groups/query-standardization)
- [CNCF Observability Query Standard WG Meeting Notes](https://docs.google.com/document/d/1pS6zhRXpP9HgqltW70595kRhC2idBo80MUMhHjKi5vM/edit?)
- [TAG OBS Query Standardization WG Charter](https://docs.google.com/document/d/1JRQ4hoLtvWl6NqBu_RN8T7tFaFY5jkzdzsB9H-V370A)
- [CNCF Observability Query Language Feature Rubric](https://docs.google.com/document/d/1PirGybtP2XU3CL_MzELCxLLbH9bXTL0G-hp22TToP-Y/edit)
- [CNCF DRAFT QLSWG Semantics Specification Context](https://docs.google.com/document/d/1A_r7tpLVELIhF1g6xnkmF3RNkX5_XWrSkEU0gKXKIK0/edit?tab=t.0
- [CNCF DRAFT QLSWG Semantics Specification](https://docs.google.com/document/d/1KIGkZowg4O9_GaRc8jn29QVpSDUtLlXwXLQY_y8tNXY)

### Deliverable(s) or exit criteria

1. The final deliverable is a published observability query language semantic specification for modeling and querying and analyzing data.
2. A Github repo with examples, context and interview results.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.