Skip to content

Deploy an Observability Agent

To send events from your components to DataOps Observability, the Observability agents must be deployed in your data estate.

Note

The steps on how to configure and deploy an agent locally, in Kubernetes, or to Azure Container Instances are provided in every agent document.

Agents are Docker images

All Observability agents are available as Docker images. This allows each agent to exist as a distinct container that includes all the scripts and files necessary to operate. To learn more about Docker, continue with Docker's documentation .

To access the images themselves, you can go to DataKitchen's Docker Hub repository .

Where to deploy agents

Since Observability agents run as Docker containers, they can be deployed anywhere in your data estate that supports Docker. For example, you can deploy locally, to a container service, or to Kubernetes.

Local

You can run an agent's Docker image from your local workstation or personal machine.

This deployment location is best for short-term, experimentation, and non-production deployments. For example, if you want to practice a deployment or send a few events to experiment with the Observability UI.

Container

You can deploy an agent's Docker image to a container service such as Amazon ECS or Azure Container Instances.

This deployment location is good for long-term, production deployments in your organization's existing infrastructure.

Kubernetes

You can deploy an agent's Docker image to a Kubernetes cluster in your organization, like Amazon Elastic Kubernetes Service, Azure Kubernetes Service, Google Kubernetes Engine, or any other Kubernetes cluster.

This deployment location is good for long-term, production deployments. With this approach, you can set resource allocations and other configuration settings.

Example: Deploy locally

  1. Complete the prerequisites and configuration steps specific to the agent you want to deploy.

    • These details are found in every agent document under the Local deploy tab and in the UI from the Integrations page.
    • When you're done, you will have a deployment script specific to how you've configured the agent.
  2. Save the deployment script for use in the next steps.

  3. Open a Terminal window at your workstation.
  4. If you're using a Mac: also open Docker Desktop . This program needs to be open in the background during the next steps.

  5. Run the following commands to execute the script and deploy the agent. For example:

    chmod +x deploy-agent-<tool>.sh
    ./deploy-agent-<tool>.sh
    

    Replace <tool> with the name of the tool. You can find the name in the agent document under Local deploy > Deploy and in the UI from the Integrations page.

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