Skip to content

Commit 4e2a9cf

Browse files
authored
doc: update coralogix documentation (#1792)
1 parent 214b023 commit 4e2a9cf

1 file changed

Lines changed: 50 additions & 12 deletions

File tree

docs/configuration/holmesgpt/toolsets/coralogix_logs.rst

Lines changed: 50 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,6 @@ Configuration
4141
api_key: <your coralogix API key>
4242
domain: eu2.coralogix.com # Your Coralogix domain
4343
team_hostname: my-team # Your team's hostname in coralogix, without the domain part
44-
labels:
45-
pod: "kubernetes.pod_name"
46-
namespace: "kubernetes.namespace_name"
47-
app: "kubernetes.labels.app"
4844
4945
kubernetes/logs:
5046
enabled: false # Disable HolmesGPT's default logging mechanism
@@ -65,19 +61,61 @@ Configuration
6561
api_key: <your coralogix API key>
6662
domain: eu2.coralogix.com # Your Coralogix domain
6763
team_hostname: my-team # Your team's hostname in coralogix
68-
labels:
69-
pod: "kubernetes.pod_name"
70-
namespace: "kubernetes.namespace_name"
71-
app: "kubernetes.labels.app"
7264
7365
kubernetes/logs:
7466
enabled: false # Disable HolmesGPT's default logging mechanism
7567
68+
Advanced Configuration
69+
^^^^^^^^^^^^^^^^^^^^^^
70+
71+
**Frequent logs and archive**
72+
73+
By default, holmes fetched the logs from the `Frequent search <https://coralogix.com/docs/user-guides/account-management/tco-optimizer/logs/#frequent-search-data-high-priority>`_
74+
tier and only fetch logs from the `Archive` tier if the frequent search returned no result.
75+
76+
This behaviour can be customised using the ``logs_retrieval_methodology`` configuration field:
77+
78+
.. code-block:: yaml
79+
80+
toolsets:
81+
coralogix/logs:
82+
enabled: true
83+
config:
84+
# Possible values are:
85+
# - FREQUENT_SEARCH_ONLY
86+
# - ARCHIVE_ONLY
87+
# - ARCHIVE_FALLBACK <- default value
88+
# - FREQUENT_SEARCH_FALLBACK
89+
# - BOTH_FREQUENT_SEARCH_AND_ARCHIVE
90+
logs_retrieval_methodology: ARCHIVE_FALLBACK # default value
91+
...
92+
93+
Here is a description of each possible log retrieval methodology:
94+
95+
- **FREQUENT_SEARCH_ONLY** Always fetch logs using a frequent search.
96+
- **ARCHIVE_ONLY** Always fetch logs using the archive.
97+
- **ARCHIVE_FALLBACK** Use a frequent search first. If there are no results, fallback to searching archived logs. **This is the default behaviour.**
98+
- **FREQUENT_SEARCH_FALLBACK** Search logs in the archive first. If there are no results, fallback to searching the frequent logs.
99+
- **BOTH_FREQUENT_SEARCH_AND_ARCHIVE** Always use both the frequent search and the archive to fetch logs. The result contains merged data which is deduplicated and sorted by timestamp.
76100

77101
**Search labels**
78102

79-
You can tweak the labels used by the toolset to identify kubernetes resources. This is only needed if your
80-
logs settings for ``pod``, ``namespace``, and ``app`` differ from the defaults in the example above.
103+
You can tweak the labels used by the toolset to identify kubernetes resources. This is **optional** and only needed if your
104+
logs settings for ``pod``, ``namespace``, ``application`` and ``subsystem`` differ from the defaults in the example below.
105+
106+
.. code-block:: yaml
107+
108+
toolsets:
109+
coralogix/logs:
110+
enabled: true
111+
config:
112+
labels: # OPTIONAL: tweak the filters used by HolmesGPT if your coralogix configuration is non standard
113+
namespace: "kubernetes.namespace_name"
114+
pod: "kubernetes.pod_name"
115+
application: "coralogix.metadata.applicationName"
116+
subsystem: "coralogix.metadata.subsystemName"
117+
...
118+
81119
82120
You can verify what labels to use by attempting to run a query in the coralogix ui:
83121

@@ -111,5 +149,5 @@ Capabilities
111149

112150
* - Tool Name
113151
- Description
114-
* - coralogix_fetch_logs
115-
- Retrieve logs from Coralogix
152+
* - fetch_coralogix_logs_for_resource
153+
- Retrieve logs using coralogix

0 commit comments

Comments
 (0)