ROB-1267: update docs for logging toolsets due to unified logging refactor#1823
Conversation
WalkthroughThe documentation for HolmesGPT toolsets was reorganized and clarified, splitting the OpenSearch toolset into separate logs and status components, and introducing a new guide for disabling the default logging toolset. Several toolset documentation files were updated for clarity, capability consolidation, and consistent formatting, with new files added for OpenSearch logs and disabling default logging. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HolmesGPT
participant OpenSearch
participant Kubernetes
User->>HolmesGPT: Request pod logs
alt OpenSearch logs toolset enabled
HolmesGPT->>OpenSearch: Query logs (using configured labels and auth)
OpenSearch-->>HolmesGPT: Return pod logs
else Default Kubernetes logs toolset enabled
HolmesGPT->>Kubernetes: Fetch pod logs via API
Kubernetes-->>HolmesGPT: Return pod logs
end
HolmesGPT-->>User: Display pod logs
sequenceDiagram
participant Admin
participant HolmesGPT
Admin->>HolmesGPT: Disable default logging toolset (via config)
HolmesGPT-->>Admin: Acknowledges configuration
Admin->>HolmesGPT: Enable alternative log toolset (e.g., OpenSearch, Coralogix)
HolmesGPT-->>Admin: Uses specified log source for future requests
Possibly related PRs
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (9)
docs/configuration/holmesgpt/toolsets/opensearch_status.rst (1)
1-2: Correct brand name capitalization.The title uses “Opensearch” but the official product name is OpenSearch. Update to:
OpenSearch status =================to maintain consistency with other documentation (e.g., in builtin_toolsets.rst).
docs/configuration/holmesgpt/toolsets/_toolsets_that_provide_logging.inc.rst (1)
3-3: Capitalize Kubernetes in description.For proper noun consistency, update this line to:
-* :ref:`kubernetes/logs <toolset_kubernetes_logs>`: Access logs directly through kubernetes. **This is the default toolset.** +* :ref:`kubernetes/logs <toolset_kubernetes_logs>`: Access logs directly through Kubernetes. **This is the default toolset.**docs/configuration/holmesgpt/toolsets/kubernetes.rst (1)
93-94: Capitalize Kubernetes in capability description.Update to:
-* - fetch_pod_logs -* - Fetches logs from a kubernetes pod +* - fetch_pod_logs + - Fetches logs from a Kubernetes podfor proper noun consistency.
docs/configuration/holmesgpt/toolsets/_disable_default_logging_toolset.inc.rst (3)
2-3: Clarify title to specify logging.Change the section title from:
Disabling the default toolset *****************************to:
Disabling the default logging toolset *************************************to more clearly reflect the scope.
5-6: Correct terminology: “data source.”Replace “datasource” with “data source” in the first paragraph:
- The default HolmesGPT logging tool **must** be disabled if you use a different datasource for logs. + The default HolmesGPT logging tool **must** be disabled if you use a different data source for logs.
23-25: Use inline literal for file path.In reStructuredText, file paths are typically shown as inline literals. Update to:
- Add the following to **~/.holmes/config.yaml**, creating the file if it doesn't exist: + Add the following to ``~/.holmes/config.yaml``, creating the file if it doesn't exist:docs/configuration/holmesgpt/toolsets/grafanaloki.rst (1)
6-6: Grammar: use “pod logs” instead of “pods logs”.
The sentence currently reads “fetch pods logs”; it should be singular “pod logs” for clarity.
Proposed diff:- By enabling this toolset, HolmesGPT will fetch pods logs from `Loki <https://grafana.com/oss/loki/>`_. + By enabling this toolset, HolmesGPT will fetch pod logs from `Loki <https://grafana.com/oss/loki/>`_.docs/configuration/holmesgpt/toolsets/coralogix_logs.rst (1)
6-6: Grammar: use “pod logs” instead of “pods logs”.
The description should read “fetch pod logs” for grammatical accuracy.
Proposed diff:- By enabling this toolset, HolmesGPT will fetch pods logs from `Coralogix <https://coralogix.com/>`_. + By enabling this toolset, HolmesGPT will fetch pod logs from `Coralogix <https://coralogix.com/>`_.docs/configuration/holmesgpt/toolsets/opensearch_logs.rst (1)
3-10: Normalize product name to “OpenSearch”.
The title and description use “Opensearch” but the official branding is “OpenSearch”. For consistency, update both occurrences:- Opensearch logs + OpenSearch logs ... - HolmesGPT will fetch pod logs from `Opensearch <https://opensearch.org/>`_. + HolmesGPT will fetch pod logs from `OpenSearch <https://opensearch.org/>`_.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
docs/images/opensearch_toolset_labels_example.pngis excluded by!**/*.png
📒 Files selected for processing (9)
docs/configuration/holmesgpt/builtin_toolsets.rst(2 hunks)docs/configuration/holmesgpt/toolsets/_disable_default_logging_toolset.inc.rst(1 hunks)docs/configuration/holmesgpt/toolsets/_toolsets_that_provide_logging.inc.rst(1 hunks)docs/configuration/holmesgpt/toolsets/coralogix_logs.rst(6 hunks)docs/configuration/holmesgpt/toolsets/grafanaloki.rst(10 hunks)docs/configuration/holmesgpt/toolsets/grafanatempo.rst(0 hunks)docs/configuration/holmesgpt/toolsets/kubernetes.rst(1 hunks)docs/configuration/holmesgpt/toolsets/opensearch_logs.rst(1 hunks)docs/configuration/holmesgpt/toolsets/opensearch_status.rst(1 hunks)
💤 Files with no reviewable changes (1)
- docs/configuration/holmesgpt/toolsets/grafanatempo.rst
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: run_tests
- GitHub Check: run_tests
- GitHub Check: Deploy docs
- GitHub Check: Deploy docs
🔇 Additional comments (23)
docs/configuration/holmesgpt/toolsets/_toolsets_that_provide_logging.inc.rst (1)
6-6: Approve new OpenSearch logs entry.The addition of
opensearch/logscorrectly surfaces the new toolset and clearly describes log access via OpenSearch.docs/configuration/holmesgpt/builtin_toolsets.rst (3)
21-22: Builtin toctree updated with new OpenSearch toolsets.Including
toolsets/opensearch_logsandtoolsets/opensearch_statusin the toctree accurately reflects the split of the original OpenSearch toolset.
103-106: Add grid-item card for OpenSearch logs.The new “OpenSearch logs” card is correctly configured with
:link:and:link-type: doc, matching the other toolset entries.
108-110: Add grid-item card for OpenSearch status.The new “OpenSearch status” card is configured consistently and maintains visual parity with existing cards.
docs/configuration/holmesgpt/toolsets/_disable_default_logging_toolset.inc.rst (4)
9-9: Approve md-tab-set usage.Leveraging
.. md-tab-set::to separate Robusta Helm Chart and Holmes CLI instructions is appropriate for readability.
11-18: Approve Robusta Helm Chart tab.The YAML snippet for disabling
kubernetes/logsin the Robusta Helm Chart is clear, correctly indented, and includes the common configuration include.
21-21: Approve include of configuration snippet.Including
_toolset_configuration.inc.rstunder the Robusta tab ensures users see the full configuration context.
27-31: Approve Holmes CLI tab code-block.The YAML snippet correctly demonstrates how to disable
kubernetes/logsin the Holmes CLI config.docs/configuration/holmesgpt/toolsets/grafanaloki.rst (5)
100-102: Consistent disable instruction for Robusta Helm Chart.
Disabling the default Kubernetes logs toolset is correctly marked as “MUST be disabled” to avoid conflicts.
120-122: Consistent disable instruction for Holmes CLI.
The inline example correctly disables the defaultkubernetes/logstoolset with the required “MUST be disabled” comment.
148-150: Consistent disable instruction for direct connection.
The direct-connection example also properly disableskubernetes/logs, maintaining consistency.
227-227: Standardize disabling instructions via include.
Including_disable_default_logging_toolset.inc.rstensures the same guidance is reused across all log toolset docs.
238-241: Unified capability naming.
Replacing multiple Loki-specific capabilities with a singlefetch_pod_logsentry aligns with the consolidated logging interface.docs/configuration/holmesgpt/toolsets/coralogix_logs.rst (5)
9-9: Capability consolidation approved.
Removing the slash in “kubernetes pod logs” improves readability and matches other toolset docs.
45-47: Disable default toolset in Robusta Helm Chart.
The inline YAML correctly disables the default Kubernetes logs toolset with the “MUST be disabled” comment.
65-67: Disable default toolset in Holmes CLI.
The example in~/.holmes/config.yamlproperly disableskubernetes/logs.
128-128: Reuse centralized disable instructions.
Including_disable_default_logging_toolset.inc.rststandardizes the instructions across all toolsets.
142-143: Unified capability naming.
Switching to a singlefetch_pod_logscapability aligns with the unified logging refactor.docs/configuration/holmesgpt/toolsets/opensearch_logs.rst (5)
38-40: Disable default Kubernetes logs.
The Robusta Helm Chart example correctly disables the defaultkubernetes/logstoolset to prevent conflicts.
63-65: Disable default Kubernetes logs in Holmes CLI.
The CLI example properly setskubernetes/logs.enabled: falsewith the mandatory disable comment.
66-71: “Configuring index_pattern and labels” section added.
This optional configuration guidance succinctly explains how to customize the index pattern and label mappings.
119-119: Centralize disable instructions.
Including_disable_default_logging_toolset.inc.rsthere aligns with other toolset docs and ensures uniform guidance.
131-135: Unified capability naming.
The new table correctly lists the singlefetch_pod_logscapability, matching the refactored logging interface.
2 participants
Summary by CodeRabbit