# OpenTelemetry Collector

import { Tabs, TabsContent, TabsList, TabsTrigger } from "zudoku/ui/Tabs"

{/* vale off */}
{/* THIS FILE WAS AUTOGENERATED FROM THE PUBLIC EXAMPLE REPOSITORY. DO NOT EDIT THIS FILE DIRECTLY. */}


This example uses [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/), a vendor-agnostic
implementation of how to receive, process and export telemetry data.
OpenTelemetry Collector works with Unikraft / Unikraft Cloud to process telemetry data.

To run this example, follow these steps:

1. Install the CLI.
   Use the [unikraft CLI](/cli/unikraft) or the legacy [kraft CLI](https://unikraft.org/docs/cli/install).
   You need a [BuildKit](https://github.com/moby/buildkit) builder. The easiest way to get one is via [Docker](https://docs.docker.com/engine/install/).
   Alternatively, you can also directly set up and use BuildKit, see the [quick start](https://github.com/moby/buildkit#quick-start).

:::note
The unikraft CLI is the current standard, while kraft is the legacy version.
Choose one of the CLIs below and only run the commands associated with it for the rest of this guide.
:::

2. Clone the [`examples` repository](https://github.com/unikraft-cloud/examples) and `cd` into the `examples/opentelemetry-collector/` directory:

```bash
git clone https://github.com/unikraft-cloud/examples
cd examples/opentelemetry-collector/
```

Make sure to log into Unikraft Cloud and pick a [metro](/platform/metros) close to you.
This guide uses `fra` (Frankfurt, 🇩🇪):

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft login
```

```bash title="kraft"
# Set Unikraft Cloud access token
export UKC_TOKEN=token
# Set metro to Frankfurt, DE
export UKC_METRO=fra
```

</CodeTabs>

When done, invoke the following command to deploy this app on Unikraft Cloud:

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft build . --output <my-org>/opentelemetry-collector:latest
unikraft run --metro fra -m 1536M --image <my-org>/opentelemetry-collector:latest
```

```bash title="kraft"
kraft cloud deploy -M 1536Mi .
```

</CodeTabs>

The output shows the instance details:

<CodeTabs syncKey="cli">

```ansi title="unikraft"
metro:        fra
name:         opentelemetry-collector-bvtnh
uuid:         40e8b154-b3b6-4312-ae69-2cdb794b15e4
state:        starting
image:        <my-org>/opentelemetry-collector
resources:
  memory:     1536MiB
  vcpus:      1
networks:
- uuid:       e74ba590-cbec-404b-d076-16aca1b52404
  private-ip: 10.0.3.3
  mac:        12:b0:aa:f7:b9:26
timestamps:
  created:    just now
```

```ansi title="kraft"
[●] Deployed successfully!
 │
 ├───────── name: opentelemetry-collector-bvtnh
 ├───────── uuid: 40e8b154-b3b6-4312-ae69-2cdb794b15e4
 ├──────── metro: https://api.fra.unikraft.cloud/v1
 ├──────── state: starting
 ├──────── image: oci://unikraft.io/<my-org>/opentelemetry-collector@sha256:64f73ea5fe208f54e5212f57979f24bebcf36276495462c52b380d15dd539ced
 ├─────── memory: 1536 MiB
 ├─ private fqdn: opentelemetry-collector-bvtnh.internal
 └─── private ip: 10.0.3.3
```

</CodeTabs>

In this case, the instance name is `opentelemetry-collector-bvtnh`.
They're different for each run.

Note that the instance doesn't export a service.
The default configuration can receive telemetry data from other instances by specifying the private IP or internal DNS as destination.
Use port 4317 for gRPC and port 4318 for HTTP.
The only configured exporter is the debug exporter.
Feel free to change and redeploy!

You can list information about the instance by running:

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft instances list
```

```bash title="kraft"
kraft cloud instance list
```

</CodeTabs>

<CodeTabs syncKey="cli">

```ansi title="unikraft"
METRO  NAME                           STATE    IMAGE                   ARGS  MEMORY   VCPUS  FQDN  CREATED
fra    opentelemetry-collector-bvtnh  running  <my-org>/opentelemetry        1536MiB  1            2 minutes ago
```

```ansi title="kraft"
NAME                           FQDN  STATE    STATUS        IMAGE                                        MEMORY    VCPUS  ARGS  BOOT TIME
opentelemetry-collector-bvtnh        running  since 11mins  oci://unikraft.io/<my-org>/opentelemetry...  1536 MiB  1            177.62 ms
```

</CodeTabs>

When done, you can remove the instance:

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft instances delete opentelemetry-collector-bvtnh
```

```bash title="kraft"
kraft cloud instance remove opentelemetry-collector-bvtnh
```

</CodeTabs>

## Customize your app

To customize the OpenTelemetry Collector app, update `Kraftfile` or, more likely, the `rootfs/etc/otel/config.yaml` files:

You can update the `rootfs/etc/otel/config.yaml` file as detailed in the [documentation](https://opentelemetry.io/docs/collector/configuration/).
Such as adding another export, apart from the debug exporter.

## Learn more

Use the `--help` option for detailed information on using Unikraft Cloud:

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft --help
```

```bash title="kraft"
kraft cloud --help
```

</CodeTabs>

Or visit the [CLI Reference](/cli/unikraft) or the [legacy CLI Reference](/cli/kraft/overview).
{/* vale on */}