intergral/observability-agent repository overview

The Observability Agent autoconfiguration and installer tool is a wrapper for Grafana Alloy⁠ that will automatically configure exporters to ship to the FusionReactor Cloud

⁠Usage

In Docker, you will not be prompted for any information. Therefore, you must specify any required configuration in the environment before running

⁠Environment Variables Example

docker run --env api_key=1234567890 --env mysql_connection_string=root:my-secret-pw@(mysql:3306)/ intergral/observability-agent:latest

⁠.Env File Example

docker run --env-file .env intergral/observability-agent:latest

⁠Compose Example

version: "3.2"

services:

  #database
  mysql:
    image: mysql:latest
    ports:
      - "3306:3306"
    environment:
      - MYSQL_ROOT_PASSWORD=my-secret-pw
  
  #agent
  agent:
    image: intergral/observability-agent:latest
    environment:
      - api_key=1234567890
      - mysql_connection_string=root:my-secret-pw@(mysql:3306)/
    ports:
      - 12345:12345

To access Grafana Alloy's UI⁠ on localhost:12345 you must expose ports 12345:12345 in your docker run command or docker compose file as shown above

⁠Configuration

Set the relevant environment variables for whichever services you have running, so they can be configured. We support the following environment variables for configuration:

⁠Ingest

To change the endpoints for metrics and logs, you can use these environment variables:

⁠Connection strings

⁠Log Exporter

⁠Open Telemetry

If you wish to enable Open Telemetry metrics and traces, the following environment variables must be set:

⁠Scraping from additional exporters

At present, there are some integrations we don't support out the box. Use of these integrations is via a scrape endpoint. To scrape these exporters, you can use the following environment variable to set a list of exporters and their corresponding endpoints to be scraped. The list must be wrapped in double quotes and each value must be separated by a comma and a space.

⁠Further Information

For further information on addressing docker networks, your host network and additional networking capabilities, see Docker networking features⁠

Read the docs⁠ for more information or contact FR support⁠.