Skip to content

ROB-1038 improve and update coralogix docs #1779

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RoiGlinik merged 1 commit into from
Apr 10, 2025
Merged

ROB-1038 improve and update coralogix docs #1779

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions docs/configuration/holmesgpt/toolsets/coralogix_logs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,14 @@ to fetch incident logs, including the ability to precisely consult past logs.
Prerequisites
^^^^^^^^^^^^^

1. A `Coralogix API key <https://coralogix.com/docs/developer-portal/apis/data-query/direct-archive-query-http-api/#api-key>`_ which is assigned the ``DataQuerying`` permission preset.
2. A base url corresponding to your `Coralogix domain <https://coralogix.com/docs/user-guides/account-management/account-settings/coralogix-domain/>`_.
1. A `Coralogix API key <https://coralogix.com/docs/developer-portal/apis/data-query/direct-archive-query-http-api/#api-key>`_ which is assigned the ``DataQuerying`` permission preset
2. A `Coralogix domain <https://coralogix.com/docs/user-guides/account-management/account-settings/coralogix-domain/>`_. For example ``eu2.coralogix.com``
3. Your team's `name or hostname <https://coralogix.com/docs/user-guides/account-management/organization-management/create-an-organization/#teams-in-coralogix>`_. 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
^^^^^^^^^^^^^
Expand All @@ -33,7 +39,8 @@ Configuration
enabled: true
config:
api_key: <your coralogix 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"
Expand All @@ -56,7 +63,8 @@ Configuration
enabled: true
config:
api_key: <your coralogix 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"
Expand Down
Loading