OpenTelemetry

https://opentelemetry.io/docs
Admin
OpenTelemetry provides a vendor-neutral, open-source observability framework for cloud-native...
Tokens:3,773,324
Snippets:30,999
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Flask

Source: https://opentelemetry.io/docs/languages/python/getting-started

Install the Flask web framework, which is used by the example application.

```bash
pip install flask

```

--------------------------------

### Prepare virtual environment for Python logs example

Source: https://opentelemetry.io/docs/zero-code/python/logs-example

Creates a virtual environment and activates it before installing dependencies for the logs example.

```bash
mkdir python_logs_example
virtualenv python_logs_example
source python_logs_example/bin/activate

```

--------------------------------

### Install OpenTelemetry Collector with kubectl apply

Source: https://opentelemetry.io/docs/collector/install/kubernetes

Use this command to install the OpenTelemetry Collector as a DaemonSet and a single gateway instance. This example serves as a starting point; for production-ready customization, see OpenTelemetry Helm Charts.

```bash
kubectl apply -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-collector/v0.162.0/examples/k8s/otel-config.yaml

```

--------------------------------

### Run the example OpAMP server

Source: https://opentelemetry.io/docs/collector/management

Launches the example OpAMP server from the opamp-go repository. The output shows the server starting and running.

```bash
$ go run .
2025/04/20 15:10:35.307207 [MAIN] OpAMP Server starting...
2025/04/20 15:10:35.308201 [MAIN] OpAMP Server running...
```

--------------------------------

### Test case: hello function with span and attributes

Source: https://opentelemetry.io/docs/languages/erlang/testing

A modified version of the hello function from the Getting Started guide, used as the test case. It starts a span named "operation" and sets an attribute a_key.

```erlang
%% apps/otel_getting_started/src/otel_getting_started.erl
-module(otel_getting_started).

-export([hello/0]).

-include_lib("opentelemetry_api/include/otel_tracer.hrl").

hello() ->
    %% start an active span and run a local function
    ?with_span(<<"operation">>, #{}, fun nice_operation/1).

nice_operation(_SpanCtx) ->
    ?set_attributes([{a_key, <<"a value">>}]),
    world
```

```elixir
# lib/otel_getting_started.ex
defmodule OtelGettingStarted do
  require OpenTelemetry.Tracer, as: Tracer

  def hello do
    Tracer.with_span "operation" do
      Tracer.set_attributes([{:a_key, "a value"}])
      :world
    end
  end
end
```

--------------------------------

### Start the demo with Make

Source: https://opentelemetry.io/docs/demo/docker-deployment

Starts the full demo using the Make target 'make start'.

```bash
make start

```

--------------------------------

### Build all examples

Source: https://opentelemetry.io/docs/languages/java/examples

Build all the examples in the repository using the Gradle wrapper.

```bash
./gradlew assemble
```

--------------------------------

### Install Collector with kubectl apply

Source: https://opentelemetry.io/docs/collector/install/kubernetes/index.md

Use this command to install the OpenTelemetry Collector as a DaemonSet and a single gateway instance. The example configuration is fetched from the official repository and serves as a starting point; for production, consider the OpenTelemetry Helm Charts.

```sh
kubectl apply -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-collector/v0.162.0/examples/k8s/otel-config.yaml
```

--------------------------------

### Sample events output showing init-container startup

Source: https://opentelemetry.io/docs/platforms/kubernetes/operator/automatic/index.md

Example output from kubectl get events showing the init-container opentelemetry-auto-instrumentation being created and started. Missing these entries indicates an issue with auto-instrumentation.

```text
53s         Normal   Created             pod/py-otel-server-7f54bf4cbc-p8wmj    Created container opentelemetry-auto-instrumentation
53s         Normal   Started             pod/py-otel-server-7f54bf4cbc-p8wmj    Started container opentelemetry-auto-instrumentation
```

--------------------------------

### Create example directory and file

Source: https://opentelemetry.io/docs/zero-code/python/logs-example/index.md

Creates the example directory and an empty Python file named example.py.

```sh
mkdir python-logs-example
cd python-logs-example
touch example.py
```

--------------------------------

### OpenTelemetry Node.js SDK setup with span processor (JavaScript)

Source: https://opentelemetry.io/docs/languages/js/exporters/index.md

Configures the OpenTelemetry Node.js SDK with a SimpleSpanProcessor and auto-instrumentation. The example is shown in JavaScript and must be placed in a file named instrumentation.js. The SDK is started after configuration.

```JavaScript
/*instrumentation.js*/
const opentelemetry = require('@opentelemetry/sdk-node');
const {
  getNodeAutoInstrumentations,
} = require('@opentelemetry/auto-instrumentations-node');

const sdk = new NodeSDK({
  spanProcessors: [new SimpleSpanProcessor(exporter)],
  instrumentations: [getNodeAutoInstrumentations()],
});
sdk.start();
```

--------------------------------

### Start the demo with Docker Compose

Source: https://opentelemetry.io/docs/demo/docker-deployment/index.md

Starts the full demo using Docker Compose with explicit compose files. A bare `docker compose up` only loads `compose.yaml`, which starts the web store without Kafka or observability backends.

```shell
docker compose --env-file .env --env-file .env.override \
  -f compose.yaml -f compose.full.yaml \
  -f compose.observability.yaml -f compose.extras.yaml \
  up --force-recreate --remove-orphans --detach
```

--------------------------------

### OpenTelemetry Node.js SDK setup with span processor (TypeScript)

Source: https://opentelemetry.io/docs/languages/js/exporters/index.md

Configures the OpenTelemetry Node.js SDK with a SimpleSpanProcessor and auto-instrumentation. The example is shown in TypeScript and must be placed in a file named instrumentation.ts. The SDK is started after configuration.

```TypeScript
/*instrumentation.ts*/
import * as opentelemetry from '@opentelemetry/sdk-node';
import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';

const sdk = new NodeSDK({
  spanProcessors: [new SimpleSpanProcessor(exporter)],
  instrumentations: [getNodeAutoInstrumentations()],
});
sdk.start();
```

--------------------------------

### Initialize Go module for example connector

Source: https://opentelemetry.io/docs/collector/extend/custom-component/connector

Initializes a Go module for the example connector. Run this in the exampleconnector folder before creating the connector files.

```bash
go mod init github.com/gord02/exampleconnector

```

--------------------------------

### Start demo with profiling (make start-profiling / docker compose)

Source: https://opentelemetry.io/docs/demo/docker-deployment/index.md

Starts the demo with profiling enabled. The Make target is the recommended way; the Docker command shows the equivalent compose invocation. After startup, profiles are available at http://localhost:8080/profiles/.

```shell
make start-profiling
```

```shell
docker compose --env-file .env --env-file .env.override \
  -f compose.yaml -f compose.full.yaml \
  -f compose.observability.yaml -f compose.profiling.yaml \
  -f compose.extras.yaml \
  up --force-recreate --remove-orphans --detach
```

--------------------------------

### Install npm packages with safe setup

Source: https://opentelemetry.io/docs/contributing/development/index.md

Install npm packages using the lock-exact, script-suppressing setup that the devcontainer uses.

```sh
npm run install:safe
```

--------------------------------

### Start the demo with Make

Source: https://opentelemetry.io/docs/demo/docker-deployment/index.md

Starts the full demo using the Make target. This is the default mode that runs all services and observability backends.

```shell
make start
```

--------------------------------

### Install jurabek/otelkafka with go get

Source: https://opentelemetry.io/docs/languages/go/registry

Install the jurabek/otelkafka instrumentation for confluent-kafka-go.

```go
go get github.com/jurabek/otelkafka

```
Tokens:
Raw