OpenTelemetry

OBI global configuration properties

Tue, 10 Mar 2026 17:25:37 -0700

OBI can be configured via environment variables or via a YAML configuration file passed either with the -config command-line argument or the OTEL_EBPF_CONFIG_PATH environment variable. Environment variables have priority over the properties in the configuration file. For example, in the following command line, the OTEL_EBPF_LOG_LEVEL option overrides any log_level settings inside config.yaml:

Config argument:

OTEL_EBPF_LOG_LEVEL=debug obi -config /path/to/config.yaml

Config environment variable:

OTEL_EBPF_LOG_LEVEL=debug OTEL_EBPF_CONFIG_PATH=/path/to/config.yaml obi

Refer to the example YAML configuration file for a configuration file template.

Configure OBI export modes

Fri, 27 Feb 2026 08:18:31 -0800

In Direct mode OBI pushes metrics and traces directly to a remote endpoint using the OpenTelemetry protocol (OTLP).

OBI can also expose a Prometheus HTTP endpoint ready to scrape, for example in pull mode.

To use Direct mode requires configuration with authentication credentials. Set the OTLP endpoint authentication credentials with these environment variables:

OTEL_EXPORTER_OTLP_ENDPOINT
OTEL_EXPORTER_OTLP_HEADERS

To run in Direct mode using the Prometheus scrape endpoint, see the configuration documentation.

Configure and run OBI

This tutorial assumes OBI and OTel Collector are running natively on the same host, so there is no need to secure the traffic nor provide authentication in the OTel Collector OTLP receiver.

Deploy OBI in Kubernetes

Tue, 24 Feb 2026 02:36:21 +0530

Nota

This document explains how to manually deploy OBI in Kubernetes, setting up all the required entities by yourself.

Configuring Kubernetes metadata decoration

OBI can decorate your traces with the following Kubernetes labels:

k8s.namespace.name
k8s.deployment.name
k8s.statefulset.name
k8s.replicaset.name
k8s.daemonset.name
k8s.node.name
k8s.pod.name
k8s.container.name
k8s.pod.uid
k8s.pod.start_time
k8s.cluster.name

To enable metadata decoration, you need to:

Quick start

Sat, 21 Feb 2026 17:26:02 -0500

The OpenTelemetry Collector receives traces, metrics, and logs, processes the telemetry, and exports it to a wide variety of observability backends using its components. For a conceptual overview of the Collector, see Collector.

You are going to learn to do the following in less than five minutes:

Set up and run the OpenTelemetry Collector.
Send telemetry and see it processed by the Collector.

Prerequisites

Make sure that your developer environment has the following. This page assumes that you’re using bash. Adapt configuration and commands as necessary for your preferred shell.

Run OBI as a Docker container

Thu, 19 Feb 2026 16:15:55 +0100

OBI can run a standalone Docker container that can instrument a process running in another container.

Find the latest image of OBI on Docker Hub with the following name:

otel/ebpf-instrument:main

The OBI container must be configured in following way:

run as a privileged container, or as a container with the SYS_ADMIN capability (but this last option might not work in some container environments)
Use the host PID namespace to allow accessing to the processes in other containers.

Image Signing and Verification

The OBI container image is signed using Cosign with ephemeral keys, authenticated via the OIDC (OpenID Connect) protocol in GitHub Actions. This ensures the authenticity and integrity of the container published by the OpenTelemetry project.

Getting started

Thu, 29 Jan 2026 05:41:57 -0500

Setup

Download opentelemetry-javaagent.jar from Releases of the opentelemetry-java-instrumentation repository and place the JAR in your preferred directory. The JAR file contains the agent and instrumentation libraries.

Add -javaagent:path/to/opentelemetry-javaagent.jar and other config to your JVM startup arguments and launch your app:

Directly on the startup command:

java -javaagent:path/to/opentelemetry-javaagent.jar -Dotel.service.name=your-service-name -jar myapp.jar

Via the JAVA_TOOL_OPTIONS and other environment variables:

export JAVA_TOOL_OPTIONS="-javaagent:path/to/opentelemetry-javaagent.jar"
export OTEL_SERVICE_NAME="your-service-name"
java -jar myapp.jar

Declarative configuration

Declarative configuration uses a YAML file instead of environment variables or system properties. This is useful when you have many configuration options to set, or if you want to use configuration options that are not available as environment variables or system properties.

Deploy OBI in Kubernetes with Helm

Mon, 26 Jan 2026 02:42:14 -0800

Nota

For more details about the diverse Helm configuration options, check out the OBI Helm chart documentation or browse the chart on Artifact Hub. For detailed configuration parameters, see the values.yaml file.

Contents:

Deploying OBI from helm
Configuring OBI
Configuring OBI metadata
Providing secrets to the Helm configuration

Deploying OBI from helm

First, you need to add the OpenTelemetry helm repository to Helm:

OBI Network Metrics configuration options

Sun, 18 Jan 2026 06:12:55 -0500

Network metrics are configured under the network property of the OBI Configuration YAML file or with a set of environment variables prefixed as OTEL_EBPF_NETWORK_.

Example YAML:

network:
 enable: true
 cidrs:
 - 10.10.0.0/24
 - 10.0.0.0/8
 - 10.30.0.0/16
attributes:
 kubernetes:
 enable: true
 select:
 obi_network_flow_bytes:
 include:
 - k8s.src.owner.name
 - k8s.src.namespace
 - k8s.dst.owner.name
 - k8s.dst.namespace
 - src.cidr
 - dst.cidr
otel_metrics_export:
 endpoint: http://localhost:4318

In addition to the network YAML section, OBI configuration requires an endpoint to export the network metrics (in the previous example, otel_metrics_export, but it also accepts a Prometheus endpoint).

Measure traffic between Cloud availability zones

Wed, 14 Jan 2026 07:44:34 -0500

Nota

This feature is currently only available in Kubernetes clusters.

Traffic between Cloud Availability Zones might incur additional costs. OBI is able to measure it either by adding src.zone and dst.zone attributes to regular network metrics, or by providing a separate obi.network.inter.zone.bytes (OTel) / obi_network_inter_zone_bytes_total (Prometheus) metric.

Add `src.zone` and `dst.zone` attributes to regular network metrics

Source and destination availability zone attributes are disabled by default in OBI. To enable it, explicitly add them to the list of included network attributes in the OBI YAML configuration:

Logs

Wed, 14 Jan 2026 07:54:47 -0300

Um log é um registro de texto com marcação de data e hora, que pode ser tanto estruturado (recomendado) quanto não estruturado, e com metadados opcionais. Dentre os sinais de telemetria, os logs têm uma história mais consolidada. A maioria das linguagens de programação possuem recursos nativos ou bibliotecas bem conhecidas e amplamente utilizadas para gerar logs.

Logs do OpenTelemetry

O OpenTelemetry fornece uma API e SDK de Logs para produzir registros de log, e SDKs de linguagem e pontes de log (logging bridges) para integrar com frameworks de logging existentes. Logs são qualquer coisa que você envie através de um Logging Provider, e eventos são um tipo especial de logs. Nem todos os logs são eventos, mas todos os eventos são logs. A API de Logs é pública e pode ser usada diretamente pelo código da aplicação ou indiretamente por meio de bibliotecas de logging e pontes existentes.

Getting Started

Thu, 08 Jan 2026 22:37:28 +0530

This page will walk you through the fastest way to get started monitoring your Kubernetes cluster using OpenTelemetry. It will focus on collecting metrics and logs for Kubernetes clusters, nodes, pods, and containers, as well as enabling the cluster to support services emitting OTLP data.

If you’re looking to see OpenTelemetry in action with Kubernetes, the best place to start is the OpenTelemetry Demo. The demo is intended to illustrate the implementation of OpenTelemetry, but it is not intended to be an example of how to monitor Kubernetes itself. Once you finish with this walkthrough, it can be a fun experiment to install the demo and see how all the monitoring responds to an active workload.

OBI network metrics quickstart

Tue, 16 Dec 2025 14:16:09 +0100

OBI can generate network metrics in any environment (physical host, virtual host, or container). It’s recommended to use a Kubernetes environment, as OBI is able to decorate each metric with the metadata of the source and destination Kubernetes entities.

The instructions in this quickstart guide focus on deploying directly to Kubernetes with the kubectl command line utility. This tutorial describes how to deploy OBI in Kubernetes from scratch. To use Helm, consult the Deploy OBI in Kubernetes with Helm documentation.

Pré-requisitos

Fri, 24 Oct 2025 10:43:45 -0300

Para contribuir com este repositório, você precisa estar familiarizado com as seguintes tecnologias e ferramentas:

git
GitHub
Markdown (CommonMark)
YAML

Para detalhes técnicos sobre como a documentação é construída e testada localmente, consulte a página de Desenvolvimento Local.

Assinatura do CNCF CLA

Todos os contribuidores do OpenTelemetry devem assinar o Contrato de Licença de Contribuidor (CLA) da Linux Foundation.

Os pull requests de contribuidores que não assinaram o CLA falharão nos testes automatizados. O nome e o e-mail que você fornecer devem corresponder aos encontrados no seu git config, e seu nome e e-mail do Git devem corresponder aos usados para assinar o CLA da CNCF.

Rastros

Mon, 20 Oct 2025 18:04:51 -0300

Os rastros nos fornecem uma visão geral do que acontece quando uma solicitação é feita para uma aplicação. Seja sua aplicação um monólito com um único banco de dados ou uma grande variedade de serviços, os rastros são essenciais para compreender o “caminho” completo que uma solicitação percorreu na sua aplicação.

Vamos explorar isso com três unidades de trabalho, representadas como Trechos:

Note

Os exemplos JSON a seguir não apresentam um formato específico, especialmente o OTLP/JSON, que é mais verboso.

Métricas

Mon, 20 Oct 2025 18:00:54 -0300

Uma métrica é uma medição de um serviço capturada em tempo de execução. O momento de captura dessa medição é conhecido como evento de métrica, que consiste não apenas na medição em si, mas também no momento em que ela foi capturada e os metadados associados.

Métricas de aplicação e de requisição são indicadores importantes de disponibilidade e desempenho. Métricas personalizadas podem fornecer insights sobre como os indicadores de disponibilidade impactam a experiência do usuário ou o negócio. Os dados coletados podem ser usados para alertar sobre uma interrupção ou desencadear decisões de escalonamento para aumentar automaticamente uma implantação em caso de alta demanda.

Vote e Comente em Issues do GitHub

Sat, 27 Sep 2025 09:51:52 +0200

No OpenTelemetry, sempre estamos procurando maneiras de facilitar que nossos usuários finais e membros da comunidade tenham suas vozes ouvidas. Sabemos que nem todos podem participar de reuniões de Grupo de Interesse Especial (SIG, Special Interest Group) ou participar de todas as discussões no Slack, mas sua contribuição é crucial para moldar a direção do projeto.

Como você pode ajudar

Você pode ajudar o OpenTelemetry de duas maneiras simples:

Migrating from OpenCensus

Tue, 27 May 2025 05:58:16 -0400

Bagagem

Mon, 19 May 2025 06:44:56 -0300

No OpenTelemetry, Bagagem é uma informação contextual que acompanha o contexto. Bagagem é uma estrutura de armazenamento chave-valor, que te permite propagar quaisquer dados junto com o contexto.

A Bagagem permite a transferência de dados entre serviços e processos, tornando-os acessíveis para serem adicionados a rastros, métricas ou logs ao longo desses serviços.

Exemplo

Bagagem é frequentemente usada em rastreamento para propagar dados adicionais entre serviços.

Por exemplo, imagine que você tem um clientId no início de uma requisição, mas deseja que esse ID esteja disponível em todos os trechos de um rastro, em algumas métricas de outro serviço, e em alguns logs ao longo do caminho. Como o rastro pode abranger vários serviços, você precisa de uma maneira de propagar esses dados sem copiar o clientId em diversos pontos do seu código.

Getting Started

Fri, 21 Mar 2025 16:06:24 -0400

This page will show you how to get started with OpenTelemetry .NET Automatic Instrumentation.

If you are looking for a way to manually instrument your application, check out this guide.

You will learn how you can instrument a simple .NET application automatically, in such a way that traces, metrics and logs are emitted to the console.

Prerequisites

Ensure that you have the following installed locally:

.NET SDK 6+

Example Application

The following example uses a basic Minimal API with ASP.NET Core application. If you are not using ASP.NET Core, that’s OK — you can still use OpenTelemetry .NET Automatic Instrumentation.

Migrating from OpenTracing

Fri, 21 Mar 2025 16:06:24 -0400

Backward compatibility with OpenTracing has been a priority for the OpenTelemetry project from the start. To ease migration, OpenTelemetry supports the use of both the OpenTelemetry and OpenTracing APIs in the same codebase. This allows OpenTracing instrumentation to be recorded using OpenTelemetry SDKs.

To accomplish this, each OpenTelemetry SDK provides an OpenTracing shim, which acts as a bridge between the OpenTracing API and the OpenTelemetry SDK. Note that OpenTracing shims are disabled by default.

OpenTelemetry

OBI global configuration properties

Configure OBI export modes

Configure and run OBI

Deploy OBI in Kubernetes

Configuring Kubernetes metadata decoration

Quick start

Prerequisites

Run OBI as a Docker container

Image Signing and Verification

Getting started

Setup

Declarative configuration

Deploy OBI in Kubernetes with Helm

Deploying OBI from helm

OBI Network Metrics configuration options

Measure traffic between Cloud availability zones

Add src.zone and dst.zone attributes to regular network metrics

Logs

Logs do OpenTelemetry

Getting Started

OBI network metrics quickstart

Pré-requisitos

Assinatura do CNCF CLA

Rastros

Métricas

Vote e Comente em Issues do GitHub

Como você pode ajudar

Migrating from OpenCensus

Bagagem

Exemplo

Getting Started

Prerequisites

Example Application

Migrating from OpenTracing

Add `src.zone` and `dst.zone` attributes to regular network metrics