Resource Types

Odigos 

OdigosSpec 

OdigosStatus 

Odigos

Overview

Odigos will automatically apply instrumentation to your selected workloads to record observability signals from your services such as collecting traces, metrics, and logs without any code changes.

Configure the Odigos pipeline to optimize the performance and resource usage of the Odigos components.

Configuration

Configuring the Pipeline

Odigos makes it simple to add and configure destinations, allowing you to select the specific signals (`traces`,`metrics`,`logs`) that you want to send to each destination.

Telemetry Types

Custom Resources

Usage report

Benchmarks

There are tens if not hundreds of different observability destinations. Odigos's goal is to provide a seamless and easy way to ship observability data to any one of them.

Add Destinations

Adding New Observability Destination

Debugging Odigos

Architecture

Demo

Blog

VM Agent

Introduction

Installation

Building a pipeline

Generating Data

Viewing traces

Next Steps

To ensure optimal performance and compatibility when deploying Odigos, your environment must meet the following system requirements:

System Requirements

Upgrade

Uninstall

odigos

odigos cloud

odigos describe

odigos diagnose

odigos install

odigos pro

odigos profile

odigos ui

odigos uninstall

odigos upgrade

odigos version

odigos sources

odigos config

odigos.io/v1alpha1

eBPF

Automatic Instrumentation

Enrichment

Enrich with OpenTelemetry API

Native

eBPF-Based Instrumentation

For Odigos agents to run inside instrumented pod containers, certain files must be mounted into the container. In Kubernetes, these files are mounted under `/var/odigos` directory, with subdirectories for each agent. There are few mechanisms to achieve this, which are explained in this document.

Mount Method

Agent Mount Method

Sources are a Custom Resource that define which Kubernetes workloads should be auto-instrumented by Odigos.

Add a Source to enable telemetry collection for specific Kuberenetes workloads, or a whole namespace.

Add Sources

Remove a Source to disable telemetry collection for specific Kuberenetes workloads, or a whole namespace.

Remove Sources

If you selected a workload to auto-instrument and you don't see any data, use the checklist below to troubleshoot the issue.

Troubleshooting

Instrumentation Rules control how telemetry is recorded from your application. A rule can be applied to a set of Kubernetes workloads and instrumentation libraries.

The "Payload Collection" rule can be used to add span attributes by collecting payload data from various sources like HTTP requests, HTTP responses, database queries, and messaging systems.

Payload Collection

The "Code Attributes" rule can be used to add [semantic Code attributes](https://opentelemetry.io/docs/specs/semconv/attributes-registry/code/) to spans. Code attributes can help trace back an operation in a trace to the code that generated it.

Code Attributes

Actions are a way to modify the OpenTelemetry data recorded by Odigos Sources, before it is exported to your destinations.

You can define custom actions using OpenTelemetry Collector Processors in Odigos.

Customized

If you are experiencing issues with your actions and processors, use the checklist below to troubleshoot the issue.

Configuring the Alibaba Cloud backend (Managed)

Alibaba Cloud

Configuring the AppDynamics backend (Managed)

AppDynamics

Configuring the AWS CloudWatch backend (Managed)

AWS CloudWatch

AWS S3

Configuring the AWS X-Ray backend (Managed)

AWS X-Ray

Axiom

Configuring the Azure Blob Storage backend (Managed)

Azure Blob Storage

Configuring the Better Stack backend (Managed)

Better Stack

Configuring the Bonree ONE backend (Managed)

Bonree ONE

Configuring the Causely backend (Managed)

Causely

Configuring the Checkly backend (Managed)

Checkly

Configuring the Chronosphere backend (Managed)

Chronosphere

Configuring the Clickhouse backend (Self-Hosted)

Clickhouse

Configuring the Coralogix backend (Managed)

Coralogix

Dash0

Configuring the Datadog backend (Managed)

Datadog

Configuring the Dynatrace backend (Managed)

Dynatrace

Configuring the Elastic APM backend (Managed)

Elastic APM

Configuring the Elasticsearch backend (Self-Hosted)

Elasticsearch

Configuring the Gigapipe backend (Managed)

Gigapipe

Configuring the Google Cloud Monitoring backend (Managed)

Google Cloud Monitoring

Google Cloud Storage

Configuring the Grafana Cloud Loki backend (Managed)

Grafana Cloud Loki

Configuring the Grafana Cloud Prometheus backend (Managed)

Grafana Cloud Prometheus

Configuring the Grafana Cloud Tempo backend (Managed)

Grafana Cloud Tempo

Configuring the GreptimeDB backend (Managed)

GreptimeDB

Configuring the Groundcover inCloud backend (Managed)

Groundcover inCloud

Configuring the Honeycomb backend (Managed)

Honeycomb

Configuring the HyperDX backend (Managed)

HyperDX

Configuring the IBM Instana backend (Managed)

IBM Instana

Configuring the Jaeger backend (Self-Hosted)

Jaeger

Configuring the Kafka backend (Self-Hosted)

Kafka

Configuring the KloudMate backend (Managed)

KloudMate

Last9

Configuring the Lightstep backend (Managed)

Lightstep

Configuring the Logz.io backend (Managed)

Logz.io

Configuring the Loki backend (Self-Hosted)

Loki

Lumigo

Configuring the Middleware backend (Managed)

Middleware

Configuring the New Relic backend (Managed)

New Relic

Configuring the Observe backend (Managed)

Observe

Configuring the OneUptime backend (Managed)

OneUptime

Configuring the OpenObserve backend (Managed)

OpenObserve

Configuring the OpsVerse backend (Managed)

OpsVerse

Configuring the Oracle Cloud backend (Managed)

Oracle Cloud

Configuring the OTLP gRPC backend (Self-Hosted)

OTLP gRPC

Configuring the OTLP http backend (Self-Hosted)

OTLP http

Configuring the Prometheus backend (Self-Hosted)

Prometheus

Configuring the qryn backend (Self-Hosted)

qryn

Configuring the Quickwit backend (Self-Hosted)

Quickwit

Sentry

Configuring the Seq backend (Self-Hosted)

Configuring the SigNoz backend (Self-Hosted)

SigNoz

Splunk

Configuring the Sumo Logic backend (Managed)

Sumo Logic

Configuring the TelemetryHub backend (Managed)

TelemetryHub

Configuring the Tempo backend (Self-Hosted)

Tempo

Configuring the Tingyun 基调听云 backend (Managed)

Tingyun 基调听云

Configuring the Traceloop backend (Managed)

Traceloop

Configuring the Uptrace backend (Managed)

Uptrace

Configuring the VictoriaMetrics Cloud backend (Managed)

Field	Type	Description
`metadata`	`meta/v1.ObjectMeta`	No description provided. Refer to the Kubernetes API documentation for the fields of the `metadata` field.
`spec`	`OdigosSpec`	No description provided.
`status`	`OdigosStatus`	No description provided.

Field	Type	Description
`onPremToken`	`string`	(Optional) OnPremToken is an enterprise token for Odigos Enterprise.
`uiMode`	`common.UiMode`	(Optional) UIMode sets the UI mode to either “normal” or “readonly”. In “normal” mode the UI is fully interactive, allowing users to view and edit Odigos configuration and settings. In “readonly” mode, the UI can only be used to view current Odigos configuration and is not interactive. Default=normal
`telemetryEnabled`	`bool`	(Optional) TelemetryEnabled records general telemetry regarding Odigos usage. Default=false
`ignoredNamespaces`	`[]string`	(Optional) IgnoredNamespaces is a list of namespaces to not show in the Odigos UI.
`ignoredContainers`	`[]string`	(Optional) IgnoredContainers is a list of container names to exclude from instrumentation (useful for ignoring sidecars).
`profiles`	`[]common.ProfileName`	(Optional) Profiles is a list of preset profiles with a specific configuration.
`skipWebhookIssuerCreation`	`bool`	(Optional) SkipWebhookIssuerCreation skips creating the Issuer and Certificate for the Instrumentor pod webhook if cert-manager is installed. Default=false
`podSecurityPolicy`	`bool`	(Optional) PodSecurityPolicy allows Odigos pods to use a privileged pod security policy. Default=false
`imagePrefix`	`string`	(Optional) ImagePrefix is a prefix for all container images. This should only be used if you are pulling Odigos images from the non-default registry. Default: registry.odigos.io Default (OpenShift): registry.connect.redhat.com
`mountMethod`	`common.MountMethod`	(Optional) MountMethod optionally defines the mechanism for mounting Odigos files into instrumented pods. One of “k8s-virtual-device” (default) or “k8s-host-path”.
`openshiftEnabled`	`bool`	(Optional) OpenShiftEnabled configures selinux on OpenShift nodes. DEPRECATED: OpenShift clusters are auto-detected and this API field will be removed in a future release.

Getting Started

Instrumentations

Odigos Pipeline

Destinations

Concepts

Contibution Guidelines

Operator.odigos.io.v1alpha1

Resource Types

`Odigos`

`OdigosSpec`

`OdigosStatus`

Getting Started

Instrumentations

Odigos Pipeline

Destinations

Concepts

Contibution Guidelines

​Resource Types

​Odigos

​OdigosSpec

​OdigosStatus

Resource Types

`Odigos`

`OdigosSpec`

`OdigosStatus`