Skip to content

Coralogix

HolmesGPT can use Coralogix for logs/traces (DataPrime) and, separately, PromQL-style metrics. This page shows both setups.

Prerequisites

  1. A Coralogix API key with DataQuerying permissions
  2. A Coralogix domain (e.g., eu2.coralogix.com)
  3. (Optional) Your team's slug - only needed for generating clickable UI permalink URLs in tool output

You can find your domain and team_slug from the URL you use to access Coralogix. For example, if you access Coralogix at https://my-team.app.eu2.coralogix.com/ then team_slug is my-team and domain is eu2.coralogix.com.

Configuration

Configure both the Coralogix DataPrime toolset (for logs/traces) and the Prometheus metrics toolset (for metrics) using the same API key:

Add the following to ~/.holmes/config.yaml. Create the file if it doesn't exist:

toolsets:
  coralogix:
    enabled: true
    config:
      api_key: "<your Coralogix API key>"
      domain: "eu2.coralogix.com"
      # Optional: enables clickable UI permalink URLs in tool output
      team_slug: "your-company-name"

  prometheus/metrics:
    enabled: true
    config:
      additional_headers:
        Authorization: "Bearer <your Coralogix API key>"
      prometheus_url: "https://ng-api-http.eu2.coralogix.com/metrics"  # replace domain

When using the standalone Holmes Helm Chart, update your values.yaml:

toolsets:
  coralogix:
    enabled: true
    config:
      api_key: "<your Coralogix API key>"
      domain: "eu2.coralogix.com"
      # Optional: enables clickable UI permalink URLs in tool output
      team_slug: "your-company-name"

  prometheus/metrics:
    enabled: true
    config:
      additional_headers:
        Authorization: "Bearer <your Coralogix API key>"
      prometheus_url: "https://ng-api-http.eu2.coralogix.com/metrics"  # replace domain

Apply the configuration:

helm upgrade holmes holmes/holmes --values=values.yaml

When using the Robusta Helm Chart (which includes HolmesGPT), update your generated_values.yaml:

holmes:
  toolsets:
    coralogix:
      enabled: true
      config:
        api_key: "<your Coralogix API key>"
        domain: "eu2.coralogix.com"
        # Optional: enables clickable UI permalink URLs in tool output
        team_slug: "your-company-name"

    prometheus/metrics:
      enabled: true
      config:
        additional_headers:
          Authorization: "Bearer <your Coralogix API key>"
        prometheus_url: "https://ng-api-http.eu2.coralogix.com/metrics"  # replace domain

Apply the configuration:

helm upgrade robusta robusta/robusta --values=generated_values.yaml --set clusterName=<YOUR_CLUSTER_NAME>

Note: Both toolsets use the same API key. The team_slug field is optional - it's only used to generate clickable permalink URLs that open query results in the Coralogix UI (e.g., https://{team_slug}.{domain}/#/query-new/...).

By specifying details about your Coralogix metrics, logs, and traces, you can significantly speed up and improve investigations. This allows Holmes to work with your environment directly, rather than spending time discovering labels, mappings, and metric names on its own.

To configure this:

  1. Go to platform.robusta.dev
  2. Navigate to Settings → AI Assistant → AI Customization
  3. Add your labels and metric details
  4. Save your changes

Example Custom Instructions

Below is an example of how your custom instructions might look, based on the labels and metrics used in your environment:

# Coralogix details

For Coralogix, use the following label mappings for logs:
- pod: k8s.pod_name
- namespace: k8s.namespace_name
- service: k8s.service_name
- deployment: k8s.deployment_name

Custom Coralogix metrics:
- payments_failures: tracks payment processing failures
- api_latency_p95: 95th percentile API latency