liveBook · Manning

Semantic convention

As explained in Cloud Observability in Action

A semantic convention is a standardized name and meaning for telemetry attributes, events, and other observability data.

A semantic convention standardizes names and meanings for telemetry metadata, making signals easier to correlate. OpenTelemetry establishes these semantics up front rather than relying only on later relabeling. section 11.1 section 11.6

OpenTelemetry applies semantic conventions to several metadata classes:

  • Resource attributes identify the entity producing telemetry, such as a Kubernetes node, cluster, region, container, or pod. section 11.1.1
  • Signal attributes describe particular telemetry types, including HTTP and RPC spans, system and application metrics, log media, and event context. section 11.1.1
  • Consistent metadata lets backends connect traces, metrics, and logs, although support differs across correlation paths. section 11.1.1 section 11.6

A service in an EKS cluster

Suppose svc-wow runs in namespace boom on an EKS cluster named prod-42 in eu-west-1 and exposes HTTP metrics. Treating its pod as the signal source allows resource attributes to identify the surrounding cloud, cluster, and workload, while HTTP metric conventions describe the emitted signal. section 11.1.1

Table 11.1 Overview of signal correlations (view table figure)

From/To

Traces

Metrics

Logs

Traces

Related spans

Trace to representative metrics

Trace to log lines from services

Metrics

Metrics to representative spans

Related metrics

Metrics to logs from services

Logs

Logs to spans from services

Logs to relevant metrics

Related logs

Use the signal-correlation table to browse supported transitions among traces, metrics, and logs. section 11.1.1

How Cloud Observability in Action covers it

How deep it goes
Defines resource and signal metadata with concrete categories, but leaves log conventions experimental and correlation limitations unresolved.
Examples
Uses an EKS service scenario and cross-signal paths connecting traces, metrics, and logs.
What you can do after
Implement effective backend correlation with OpenTelemetry metadata and set expectations around volume, cardinality, sampling, and user experience.
How it connects
Connects OpenTelemetry with resource attributes, signal correlation, traces, metrics, logs, exemplars, and auto-instrumentation.

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Cloud Observability in Action. The section links point to the parts of the book it draws on.