​
Getting Started

Where to find the data

  • Each Odigos destination send collected telemetry to a single environment in Honeycomb.
  • The collected telemetry will go into HoneyComb datasets based on the service.name resource attribute. odigos will set it by default to the k8s workload (deployment) name (or as set in source configuration).

Login to Honeycomb
Go to the 🔗 website and login/create your honeycomb account. You can start with the Free plan to test sending traces, logs and metrics without needing to provide a credit card.

Select Environment
Honeycomb uses environments to partition and organize data.

Common environments includes staging, production, development, integration, or you might want to include the cluster/unit name to group and isolate telemetry that is unrelated.

Each Odigos Honeycomb destination always sends the data to a single environment, based on the “API Key” it is configured with. Before creating your API Key, make sure to select in ui the environment you want your odigos collected telemetry to show up in.

Obtaining Honeycomb API Key

From the top left corner click on the ENVIRONMENT, and click the Settings configuration gear icon to go to the settings page.

From the Settings page, click on the API Keys tab, make sure you are on “Ingest” sub-tab and click on the Create Ingest API Key blue button on the right.

Give your API Key a name (include “odigos” in the name to identify it easily later on), make sure the checkbox for “Can create services/datasets” is checked, and click the Create button on the modal bottom right.

Copy the ingest key to keyboard and paste it in your Honeycomb Odigos destination configuration (ui or kubernetes manifest).

​
Configuring Destination Fields

  • HONEYCOMB_API_KEY string : API Key.
    • This field is required
  • HONEYCOMB_ENDPOINT string : Endpoint. Choose one of the endpoints in the dropdown (api.honeycomb.io is the US instance, api.eu1.honeycomb.io is EU instance)
    • This field is required

​
Adding Destination to Odigos

There are two primary methods for configuring destinations in Odigos:

Using the UI
1

Use the Odigos CLI to access the UI

odigos ui
2

Click on Add Destination, select Honeycomb and follow the on-screen instructions

Using Kubernetes manifests
1

Save the YAML below to a file (e.g. honeycomb.yaml)

apiVersion: odigos.io/v1alpha1
kind: Destination
metadata:
  name: honeycomb-example
  namespace: odigos-system
spec:
  data:
    HONEYCOMB_ENDPOINT: '<Endpoint (options: [api.honeycomb.io, api.eu1.honeycomb.io])>'
  destinationName: honeycomb
  secretRef:
    name: honeycomb-secret
  signals:
  - TRACES
  - METRICS
  - LOGS
  type: honeycomb

---

apiVersion: v1
data:
  HONEYCOMB_API_KEY: <Base64 API Key>
kind: Secret
metadata:
  name: honeycomb-secret
  namespace: odigos-system
type: Opaque
2

Apply the YAML using kubectl

kubectl apply -f honeycomb.yaml

​
Getting Started

Where to find the data

  • Each Odigos destination send collected telemetry to a single environment in Honeycomb.
  • The collected telemetry will go into HoneyComb datasets based on the service.name resource attribute. odigos will set it by default to the k8s workload (deployment) name (or as set in source configuration).

Login to Honeycomb
Go to the 🔗 website and login/create your honeycomb account. You can start with the Free plan to test sending traces, logs and metrics without needing to provide a credit card.

Select Environment
Honeycomb uses environments to partition and organize data.

Common environments includes staging, production, development, integration, or you might want to include the cluster/unit name to group and isolate telemetry that is unrelated.

Each Odigos Honeycomb destination always sends the data to a single environment, based on the “API Key” it is configured with. Before creating your API Key, make sure to select in ui the environment you want your odigos collected telemetry to show up in.

Obtaining Honeycomb API Key

From the top left corner click on the ENVIRONMENT, and click the Settings configuration gear icon to go to the settings page.

From the Settings page, click on the API Keys tab, make sure you are on “Ingest” sub-tab and click on the Create Ingest API Key blue button on the right.

Give your API Key a name (include “odigos” in the name to identify it easily later on), make sure the checkbox for “Can create services/datasets” is checked, and click the Create button on the modal bottom right.

Copy the ingest key to keyboard and paste it in your Honeycomb Odigos destination configuration (ui or kubernetes manifest).

​
Configuring Destination Fields

  • HONEYCOMB_API_KEY string : API Key.
    • This field is required
  • HONEYCOMB_ENDPOINT string : Endpoint. Choose one of the endpoints in the dropdown (api.honeycomb.io is the US instance, api.eu1.honeycomb.io is EU instance)
    • This field is required

​
Adding Destination to Odigos

There are two primary methods for configuring destinations in Odigos:

Using the UI
1

Use the Odigos CLI to access the UI

odigos ui
2

Click on Add Destination, select Honeycomb and follow the on-screen instructions

Using Kubernetes manifests
1

Save the YAML below to a file (e.g. honeycomb.yaml)

apiVersion: odigos.io/v1alpha1
kind: Destination
metadata:
  name: honeycomb-example
  namespace: odigos-system
spec:
  data:
    HONEYCOMB_ENDPOINT: '<Endpoint (options: [api.honeycomb.io, api.eu1.honeycomb.io])>'
  destinationName: honeycomb
  secretRef:
    name: honeycomb-secret
  signals:
  - TRACES
  - METRICS
  - LOGS
  type: honeycomb

---

apiVersion: v1
data:
  HONEYCOMB_API_KEY: <Base64 API Key>
kind: Secret
metadata:
  name: honeycomb-secret
  namespace: odigos-system
type: Opaque
2

Apply the YAML using kubectl

kubectl apply -f honeycomb.yaml