Skip to content

Add HolmesGPT NewRelic toolset docs #1832

Merged
aantn merged 3 commits intorobusta-dev:masterfrom
marin-h:chore/holmesgpt-newrelic-toolset-doc
Jul 14, 2025
Merged

Add HolmesGPT NewRelic toolset docs #1832
aantn merged 3 commits intorobusta-dev:masterfrom
marin-h:chore/holmesgpt-newrelic-toolset-doc

Conversation

@marin-h
Copy link
Copy Markdown
Contributor

@marin-h marin-h commented May 30, 2025

Addresses #1831
See the NewRelic toolset PR in Holmes repo.

Summary by CodeRabbit

  • Documentation
    • Added documentation for the New Relic toolset integration, including setup instructions, configuration details, and available capabilities.
    • Updated the list and visual grid of built-in toolsets to include New Relic, with a direct link to its documentation.

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented May 30, 2025

CLA assistant check
All committers have signed the CLA.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 30, 2025

Walkthrough

The documentation was updated to include a new entry for the New Relic toolset integration with HolmesGPT. This involved adding New Relic to the list and grid of built-in toolsets and creating a dedicated documentation page describing its configuration and capabilities.

Changes

File(s) Change Summary
docs/configuration/holmesgpt/builtin_toolsets.rst Added New Relic to the toctree and grid of built-in toolsets.
docs/configuration/holmesgpt/toolsets/newrelic.rst Created new documentation page detailing New Relic toolset configuration and capabilities.

Possibly related issues

Possibly related PRs

Suggested reviewers

  • arikalon1

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
docs/configuration/holmesgpt/builtin_toolsets.rst (1)

104-108: Use a custom icon for New Relic
Consider swapping the generic Octicon CPU icon for the official New Relic logo or a more representative icon (e.g., an SVG in /_static/icons) to improve visual distinction.

docs/configuration/holmesgpt/toolsets/newrelic.rst (2)

16-17: Use descriptive placeholders
Instead of ******, consider using a clearer placeholder like <YOUR_API_KEY> and <YOUR_ACCOUNT_ID> for copy-paste clarity.


40-49: Normalize list-table indentation
The YAML list-table above is indented with two spaces; here, the capabilities table uses three. Align both to two spaces for consistency and readability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1c69ea7 and 5930f1b.

📒 Files selected for processing (2)
  • docs/configuration/holmesgpt/builtin_toolsets.rst (2 hunks)
  • docs/configuration/holmesgpt/toolsets/newrelic.rst (1 hunks)
🔇 Additional comments (7)
docs/configuration/holmesgpt/builtin_toolsets.rst (2)

21-21: Add New Relic to toctree
The new entry is properly indented and preserves alphabetical order among the toolsets.


104-108: Add New Relic grid item
The grid-item-card follows the existing pattern and correctly links to toolsets/newrelic.

docs/configuration/holmesgpt/toolsets/newrelic.rst (5)

1-5: Heading and introduction
The primary heading and introductory text follow RST conventions and clearly state the toolset’s purpose.


9-18: YAML configuration snippet
The .. code-block:: yaml example is well-formatted and aligns with other toolset docs.


21-30: Configuration fields table
The list-table for nr_api_key and nr_account_id is structured correctly and matches existing toolset docs.


32-35: Includes for shared content
The .. include:: directives correctly pull in the standard configuration and capabilities snippets for consistency.


36-38: Capabilities section header
The “Capabilities” heading and its underline match RST conventions and are consistent with other toolset pages.

Copy link
Copy Markdown
Collaborator

@aantn aantn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM thanks!

@aantn aantn enabled auto-merge (squash) July 13, 2025 10:38
@aantn aantn merged commit a4369e5 into robusta-dev:master Jul 14, 2025
4 checks passed
stvnksslr pushed a commit to stvnksslr/robusta that referenced this pull request Jul 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants