From b74bfc517e2f5e80a7b5616d2fa35a47d274868f Mon Sep 17 00:00:00 2001 From: Nicolas Herment Date: Tue, 8 Apr 2025 14:40:36 +0200 Subject: [PATCH] docs: improve and update coralogix docs --- .../holmesgpt/toolsets/coralogix_logs.rst | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/configuration/holmesgpt/toolsets/coralogix_logs.rst b/docs/configuration/holmesgpt/toolsets/coralogix_logs.rst index ff0bc01c8..ffeceace7 100644 --- a/docs/configuration/holmesgpt/toolsets/coralogix_logs.rst +++ b/docs/configuration/holmesgpt/toolsets/coralogix_logs.rst @@ -15,8 +15,14 @@ to fetch incident logs, including the ability to precisely consult past logs. Prerequisites ^^^^^^^^^^^^^ -1. A `Coralogix API key `_ which is assigned the ``DataQuerying`` permission preset. -2. A base url corresponding to your `Coralogix domain `_. +1. A `Coralogix API key `_ which is assigned the ``DataQuerying`` permission preset +2. A `Coralogix domain `_. For example ``eu2.coralogix.com`` +3. Your team's `name or hostname `_. For example ``your-company-name`` + + +You can deduct the ``domain`` and ``team_hostname`` configuration fields by looking at the URL you use to access the Coralogix UI. + +For example if you access coralogix at ``https://my-team.app.eu2.coralogix.com/``` then the ``team_hostname`` is ``my-team``and the coralogix ``domain`` is ``eu2.coralogix.com``. Configuration ^^^^^^^^^^^^^ @@ -33,7 +39,8 @@ Configuration enabled: true config: api_key: - base_url: https://xxx.coralogix.xxx # Your Coralogix domain URL, without any path + domain: eu2.coralogix.com # Your Coralogix domain + team_hostname: my-team # Your team's hostname in coralogix, without the domain part labels: pod: "kubernetes.pod_name" namespace: "kubernetes.namespace_name" @@ -56,7 +63,8 @@ Configuration enabled: true config: api_key: - base_url: https://xxx.coralogix.xxx # Your Coralogix domain URL, without any path + domain: eu2.coralogix.com # Your Coralogix domain + team_hostname: my-team # Your team's hostname in coralogix labels: pod: "kubernetes.pod_name" namespace: "kubernetes.namespace_name"