Skip to content

Available Integrations

The Integrations page provides a list of available Observability agents, complete with steps on how to configure and deploy.

How to

  1. Log into Observability and select a project.
  2. Select Integrations from the menu.
  3. Click View Available Agents.
  4. Select a tool from the list.

  5. Complete any Prerequisites required for the tool.

    • Some tools have their own prerequisites. Details are included in this step.
    • Since Observability agents are Docker images, best practice is to plan your deployment location now and verify that Docker is available.

    For more information and an example, see Deploy an Observability Agent.

  6. In the New API Key section, create a service account API key for the agent.

    • An API key is required for API authentication, so the system can associate incoming events with the correct project, and for the agent heartbeat signal.
    • It's strongly recommended that each agent has its own, designated service account key.
    • Select Send events and Manage entities to ensure full functionality of the agent.
    • Transmit heartbeat is ON by default. This ensures agents deployed in your data estate send a heartbeat signal.

  7. Click Create Key and Continue.

    • The key you create is automatically populated in the deployment script builder.
    • You can manage this key from the API Keys page.

  8. Under Step 2: Configuration, fill in any remaining, required configuration variable values in the deployment script builder.

    • The Observability Integration Agents documentation provides variable details for each agent.
    • Copy and save the service account API key for future use. The system does not display key values in the UI.

  9. Click Continue.

  10. Under Step 3: Deploy, enter the agent's image tag and select your deployment location.

    • The image tag format is vx.x.x. For example, v2.5.1
    • The deployment location options are Docker, which you can use for local deployments, or Kubernetes, to deploy to an existing cluster.

  11. Click Download Script.

  12. Save the script to the computer, machine, or server where you want to deploy the agent.
  13. Open a command line terminal in your preferred deployment location and use the commands provided to run the deployment script.

Once deployed, open Observability and navigate to the project associated with the agent's service account key. You will be able to view incoming events, configure the components, and build journeys.

View Events and Runs

Components

Create Journeys