liveBook · Manning

OpenTelemetry API

As explained in Cloud Observability in Action

The OpenTelemetry API is the language-facing interface for creating and accessing OpenTelemetry telemetry instrumentation components.

The OpenTelemetry API is the language-facing interface used to create and access telemetry instrumentation components. It commonly appears alongside the SDK when instrumentation is enabled, whether manually or automatically. section 4.3.1

In an automatic-instrumentation workflow, the API participates in these practical steps:

  • Add dependencies that provide OpenTelemetry API and SDK capabilities. section 4.3.1
  • Configure instrumentation through environment variables or language-specific mechanisms. section 4.3.1
  • Provide at least a service name, with optional exporter and resource configuration. section 4.3.1

Java agent setup

A Java application can include the OpenTelemetry Java agent as a JAR using -javaagent; the agent dynamically instruments supported frameworks while the API and SDK supply instrumentation capabilities. section 4.3.1

How Cloud Observability in Action covers it

How deep it goes
Explains API and SDK dependencies within automatic-instrumentation setup, but does not descend into API interfaces or implementation internals.
Examples
Uses Java agents, JavaScript and Node SDKs, environment variables, and service-name configuration as concrete instrumentation examples.
What it assumes
Assumes a target application and some language-specific configuration mechanism, while presenting dependency and service-name setup explicitly.
What you can do after
Operate OpenTelemetry instrumentation by adding API and SDK dependencies and configuring service, exporter, and resource settings.
How it connects
Connects OpenTelemetry API with SDKs, auto-instrumentation, service names, exporters, resource configuration, and tracing.
Cover of Cloud Observability in Action
liveBookmanning.com
Read Cloud Observability in Action on liveBook Get the book at manning.com

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.