> ## Documentation Index
> Fetch the complete documentation index at: https://docs.odigos.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Checkly

> Configuring the Checkly backend (Managed)

### Getting Started

<img src="https://d15jtxgb40qetw.cloudfront.net/checkly.svg" alt="checkly" className="not-prose h-20" />

{/*
  !! Do not remove this comment, this acts as a key indicator in `docs/sync-dest-doc.py` !!
  !! END CUSTOM EDIT !!
*/}

### Configuring Destination Fields

<Accordion title="Supported Signals:">
  ✅ Traces
  ❌ Metrics
  ❌ Logs
  ❌ Profiles
</Accordion>

* **CHECKLY\_ENDOINT** `string` : OTLP gRPC Endpoint. The format is `host:port`, host is required, port is optional and defaults to the default OTLP gRPC port `4317`.
  * This field is required
* **CHECKLY\_API\_KEY** `string` : API Key.
  * This field is required

<Warning>
  Odigos will only filter and export traces to Checkly if their `trace_state` includes the tag `checkly="true"`, which is added by a Checkly SDK.
</Warning>

### Adding Destination to Odigos

There are two primary methods for configuring destinations in Odigos:

##### **Using the UI**

<Steps>
  <Step>
    Use the [Odigos CLI](https://docs.odigos.io/cli/odigos_ui) to access the UI

    ```bash theme={null}
    odigos ui
    ```
  </Step>

  <Step>
    Click on `Add Destination`, select `Checkly` and follow the on-screen instructions
  </Step>
</Steps>

##### **Using Kubernetes manifests**

<Steps>
  <Step>
    Save the YAML below to a file (e.g. `checkly.yaml`)

    ```yaml theme={null}
    apiVersion: odigos.io/v1alpha1
    kind: Destination
    metadata:
      name: checkly-example
      namespace: odigos-system
    spec:
      data:
        CHECKLY_ENDOINT: <OTLP gRPC Endpoint>
      destinationName: checkly
      secretRef:
        name: checkly-secret
      signals:
      - TRACES
      type: checkly

    ---

    apiVersion: v1
    data:
      CHECKLY_API_KEY: <Base64 API Key>
    kind: Secret
    metadata:
      name: checkly-secret
      namespace: odigos-system
    type: Opaque
    ```
  </Step>

  <Step>
    Apply the YAML using `kubectl`

    ```bash theme={null}
    kubectl apply -f checkly.yaml
    ```
  </Step>
</Steps>