holmesgpt 0.12.3__tar.gz → 0.12.4__tar.gz

holmesgpt-0.12.4/PKG-INFO

@@ -0,0 +1,258 @@
+Metadata-Version: 2.1
+Name: holmesgpt
+Version: 0.12.4
+Summary: 
+Author: Natan Yellin
+Author-email: natan@robusta.dev
+Requires-Python: >=3.10,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: aiohttp (>=3.10.2,<4.0.0)
+Requires-Dist: azure-core (>=1.34.0,<2.0.0)
+Requires-Dist: azure-identity (>=1.23.0,<2.0.0)
+Requires-Dist: azure-mgmt-alertsmanagement (>=1.0.0,<2.0.0)
+Requires-Dist: azure-mgmt-monitor (>=7.0.0b1,<8.0.0)
+Requires-Dist: azure-mgmt-resource (>=23.3.0,<24.0.0)
+Requires-Dist: azure-mgmt-sql (>=4.0.0b21,<5.0.0)
+Requires-Dist: azure-monitor-query (>=1.2.0,<2.0.0)
+Requires-Dist: backoff (>=2.2.1,<3.0.0)
+Requires-Dist: boto3 (>=1.34.145,<2.0.0)
+Requires-Dist: bs4 (>=0.0.2,<0.0.3)
+Requires-Dist: cachetools (>=5.5.0,<6.0.0)
+Requires-Dist: certifi (>=2024.7.4,<2025.0.0)
+Requires-Dist: colorlog (>=6.8.2,<7.0.0)
+Requires-Dist: confluent-kafka (>=2.6.1,<3.0.0)
+Requires-Dist: fastapi (>=0.116,<0.117)
+Requires-Dist: google-api-python-client (>=2.156.0,<3.0.0)
+Requires-Dist: humanize (>=4.9.0,<5.0.0)
+Requires-Dist: jinja2 (>=3.1.2,<4.0.0)
+Requires-Dist: kubernetes (>=32.0.1,<33.0.0)
+Requires-Dist: litellm (==1.74.7)
+Requires-Dist: markdown (>=3.6,<4.0)
+Requires-Dist: markdownify (>=1.1.0,<2.0.0)
+Requires-Dist: mcp (==v1.12.2)
+Requires-Dist: openai (>=1.6.1,<2.0.0)
+Requires-Dist: opensearch-py (>=2.8.0,<3.0.0)
+Requires-Dist: prompt-toolkit (>=3.0.51,<4.0.0)
+Requires-Dist: protobuf (>=6.31.1)
+Requires-Dist: pydantic (>=2.7,<3.0)
+Requires-Dist: pydantic-settings (>=2.1.0,<3.0.0)
+Requires-Dist: pydash (>=8.0.1,<9.0.0)
+Requires-Dist: pygments (>=2.18.0,<3.0.0)
+Requires-Dist: pyodbc (>=5.0.1,<6.0.0)
+Requires-Dist: pytest-shared-session-scope (>=0.4.0,<0.5.0)
+Requires-Dist: python-benedict (>=0.33.1,<0.34.0)
+Requires-Dist: python_multipart (>=0.0.18,<0.0.19)
+Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
+Requires-Dist: requests (>=2.32.4,<3.0.0)
+Requires-Dist: rich (>=13.7.1,<14.0.0)
+Requires-Dist: sentry-sdk[fastapi] (>=2.20.0,<3.0.0)
+Requires-Dist: setuptools (==70.0.0)
+Requires-Dist: slack-bolt (>=1.18.1,<2.0.0)
+Requires-Dist: starlette (==0.47.2)
+Requires-Dist: strenum (>=0.4.15,<0.5.0)
+Requires-Dist: supabase (>=2.5,<3.0)
+Requires-Dist: tenacity (>=9.1.2,<10.0.0)
+Requires-Dist: typer (>=0.15.4,<0.16.0)
+Requires-Dist: urllib3 (>=1.26.19,<2.0.0)
+Requires-Dist: uvicorn (>=0.30,<0.31)
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <h1 align="center">AI Agent for Cloud Troubleshooting and Alert Investigation</h1>
+
+HolmesGPT is an AI agent for investigating problems in your cloud, finding the root cause, and suggesting remediations. It has dozens of built-in integrations for cloud providers, observability tools, and on-call systems.
+
+HolmesGPT has been submitted to the CNCF as a sandbox project ([view status](https://github.com/cncf/sandbox/issues/392)). You can learn more about HolmesGPT's maintainers and adopters [here](./ADOPTERS.md).
+
+  <p align="center">
+    <a href="#how-it-works"><strong>How it Works</strong></a> |
+    <a href="#installation"><strong>Installation</strong></a> |
+    <a href="#supported-llm-providers"><strong>LLM Providers</strong></a> |
+    <a href="https://www.youtube.com/watch?v=TfQfx65LsDQ"><strong>YouTube Demo</strong></a> |
+    <a href="https://deepwiki.com/robusta-dev/holmesgpt"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
+  </p>
+</div>
+
+![HolmesGPT Investigation Demo](https://robusta-dev.github.io/holmesgpt/assets/HolmesInvestigation.gif)
+
+## How it Works
+
+HolmesGPT connects AI models with live observability data and organizational knowledge. It uses an **agentic loop** to analyze data from multiple sources and identify possible root causes.
+
+<img width="3114" alt="holmesgpt-architecture-diagram" src="https://github.com/user-attachments/assets/f659707e-1958-4add-9238-8565a5e3713a" />
+
+### 🔗 Data Sources
+
+HolmesGPT integrates with popular observability and cloud platforms. The following data sources ("toolsets") are built-in. [Add your own](#customizing-holmesgpt).
+
+| Data Source | Status | Notes |
+|-------------|--------|-------|
+| [<img src="images/integration_logos/argocd-icon.png" alt="ArgoCD" width="20" style="vertical-align: middle;"> **ArgoCD**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/argocd/) | ✅ | Get status, history and manifests and more of apps, projects and clusters |
+| [<img src="images/integration_logos/aws_rds_logo.png" alt="AWS RDS" width="20" style="vertical-align: middle;"> **AWS RDS**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/aws/) | ✅ | Fetch events, instances, slow query logs and more |
+| [<img src="images/integration_logos/confluence_logo.png" alt="Confluence" width="20" style="vertical-align: middle;"> **Confluence**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/confluence/) | ✅ | Private runbooks and documentation |
+| [<img src="images/integration_logos/coralogix-icon.png" alt="Coralogix Logs" width="20" style="vertical-align: middle;"> **Coralogix Logs**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/coralogix-logs/) | ✅ | Retrieve logs for any resource |
+| [<img src="images/integration_logos/date_time_icon.png" alt="Datetime" width="20" style="vertical-align: middle;"> **Datetime**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/datetime/) | ✅ | Date and time-related operations |
+| [<img src="images/integration_logos/docker_logo.png" alt="Docker" width="20" style="vertical-align: middle;"> **Docker**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/docker/) | ✅ | Get images, logs, events, history and more |
+| [<img src="images/integration_logos/github_logo.png" alt="GitHub" width="20" style="vertical-align: middle;"> **GitHub**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/github/) | 🟡 Beta | Remediate alerts by opening pull requests with fixes |
+| [<img src="images/integration_logos/datadog_logo.png" alt="DataDog" width="20" style="vertical-align: middle;"> **DataDog**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/datadog/) | 🟡 Beta | Fetches log data from datadog  |
+| [<img src="images/integration_logos/grafana_loki-icon.png" alt="Loki" width="20" style="vertical-align: middle;"> **Grafana Loki**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/grafanaloki/) | ✅ | Query logs for Kubernetes resources or any query |
+| [<img src="images/integration_logos/tempo_logo.png" alt="Tempo" width="20" style="vertical-align: middle;"> **Grafana Tempo**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/grafanatempo/) | ✅ | Fetch trace info, debug issues like high latency in application. |
+| [<img src="images/integration_logos/helm_logo.png" alt="Helm" width="20" style="vertical-align: middle;"> **Helm**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/helm/) | ✅ | Release status, chart metadata, and values |
+| [<img src="images/integration_logos/http-icon.png" alt="Internet" width="20" style="vertical-align: middle;"> **Internet**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/internet/) | ✅ | Public runbooks, community docs etc |
+| [<img src="images/integration_logos/kafka_logo.png" alt="Kafka" width="20" style="vertical-align: middle;"> **Kafka**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/kafka/) | ✅ | Fetch metadata, list consumers and topics or find lagging consumer groups |
+| [<img src="images/integration_logos/kubernetes-icon.png" alt="Kubernetes" width="20" style="vertical-align: middle;"> **Kubernetes**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/kubernetes/) | ✅ | Pod logs, K8s events, and resource status (kubectl describe) |
+| [<img src="images/integration_logos/newrelic_logo.png" alt="NewRelic" width="20" style="vertical-align: middle;"> **NewRelic**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/newrelic/) | 🟡 Beta | Investigate alerts, query tracing data |
+| [<img src="images/integration_logos/opensearchserverless-icon.png" alt="OpenSearch" width="20" style="vertical-align: middle;"> **OpenSearch**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/opensearch-status/) | ✅ | Query health, shard, and settings related info of one or more clusters|
+| [<img src="images/integration_logos/prometheus-icon.png" alt="Prometheus" width="20" style="vertical-align: middle;"> **Prometheus**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/prometheus/) | ✅ | Investigate alerts, query metrics and generate PromQL queries  |
+| [<img src="images/integration_logos/rabbit_mq_logo.png" alt="RabbitMQ" width="20" style="vertical-align: middle;"> **RabbitMQ**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/rabbitmq/) | ✅ | Info about partitions, memory/disk alerts to troubleshoot split-brain scenarios and more  |
+| [<img src="images/integration_logos/robusta_logo.png" alt="Robusta" width="20" style="vertical-align: middle;"> **Robusta**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/robusta/) | ✅ | Multi-cluster monitoring, historical change data, user-configured runbooks, PromQL graphs and more |
+| [<img src="images/integration_logos/slab_logo.png" alt="Slab" width="20" style="vertical-align: middle;"> **Slab**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/slab/) | ✅ | Team knowledge base and runbooks on demand |
+
+### 🚀 End-to-End Automation
+
+HolmesGPT can fetch alerts/tickets to investigate from external systems, then write the analysis back to the source or Slack.
+
+| Integration             | Status    | Notes |
+|-------------------------|-----------|-------|
+| Slack                   | 🟡 Beta   | [Demo.](https://www.loom.com/share/afcd81444b1a4adfaa0bbe01c37a4847) Tag HolmesGPT bot in any Slack message |
+| Prometheus/AlertManager | ✅        | Robusta SaaS or HolmesGPT CLI |
+| PagerDuty               | ✅        | HolmesGPT CLI only |
+| OpsGenie                | ✅        | HolmesGPT CLI only |
+| Jira                    | ✅        | HolmesGPT CLI only |
+| GitHub                  | ✅        | HolmesGPT CLI only |
+
+## Installation
+
+<a href="https://robusta-dev.github.io/holmesgpt/installation/cli-installation/">
+  <img src="images/integration_logos/all-installation-methods.png" alt="All Installation Methods" style="max-width:100%; height:auto;">
+</a>
+
+Read the [installation documentation](https://robusta-dev.github.io/holmesgpt/installation/cli-installation/) to learn how to install HolmesGPT.
+
+## Supported LLM Providers
+
+<a href="https://robusta-dev.github.io/holmesgpt/ai-providers/">
+  <img src="images/integration_logos/all-integration-providers.png" alt="All Integration Providers" style="max-width:100%; height:auto;">
+</a>
+
+Read the [LLM Providers documentation](https://robusta-dev.github.io/holmesgpt/ai-providers/) to learn how to set up your LLM API key.
+
+## Using HolmesGPT
+
+- In the Robusta SaaS: Go to [platform.robusta.dev](https://platform.robusta.dev/signup/?utm_source=github&utm_medium=holmesgpt-readme&utm_content=ways_to_use_holmesgpt_section) and use Holmes from your browser
+- With HolmesGPT CLI: [setup an LLM API key](https://robusta-dev.github.io/holmesgpt/ai-providers/) and ask Holmes a question 👇
+
+```bash
+holmes ask "what pods are unhealthy and why?"
+```
+
+You can also provide files as context:
+```bash
+holmes ask "summarize the key points in this document" -f ./mydocument.txt
+```
+
+You can also load the prompt from a file using the `--prompt-file` option:
+```bash
+holmes ask --prompt-file ~/long-prompt.txt
+
+Enter interactive mode to ask follow-up questions:
+```bash
+holmes ask "what pods are unhealthy and why?" --interactive
+# or
+holmes ask "what pods are unhealthy and why?" -i
+```
+
+Also supported:
+
+<details>
+<summary>HolmesGPT CLI: investigate Prometheus alerts</summary>
+
+Pull alerts from AlertManager and investigate them with HolmesGPT:
+
+```bash
+holmes investigate alertmanager --alertmanager-url http://localhost:9093
+# if on Mac OS and using the Holmes Docker image👇
+#  holmes investigate alertmanager --alertmanager-url http://docker.for.mac.localhost:9093
+```
+
+<b>To investigate alerts in your browser, sign up for a free trial of [Robusta SaaS](https://platform.robusta.dev/signup/?utm_source=github&utm_medium=holmesgpt-readme&utm_content=ways_to_use_holmesgpt_section). </b>
+
+
+<b>Optional:</b> port-forward to AlertManager before running the command mentioned above (if running Prometheus inside Kubernetes)
+
+```bash
+kubectl port-forward alertmanager-robusta-kube-prometheus-st-alertmanager-0 9093:9093 &
+```
+</details>
+
+<details>
+<summary>HolmesGPT CLI: investigate PagerDuty and OpsGenie alerts</summary>
+
+```bash
+holmes investigate opsgenie --opsgenie-api-key <OPSGENIE_API_KEY>
+holmes investigate pagerduty --pagerduty-api-key <PAGERDUTY_API_KEY>
+# to write the analysis back to the incident as a comment
+holmes investigate pagerduty --pagerduty-api-key <PAGERDUTY_API_KEY> --update
+```
+
+For more details, run `holmes investigate <source> --help`
+</details>
+
+## Customizing HolmesGPT
+
+HolmesGPT can investigate many issues out of the box, with no customization or training. Optionally, you can extend Holmes to improve results:
+
+**Custom Data Sources**: Add data sources (toolsets) to improve investigations
+   - If using Robusta SaaS: See [here](https://robusta-dev.github.io/holmesgpt/data-sources/custom-toolsets/)
+   - If using the CLI: Use `-t` flag with [custom toolset files](./examples/custom_toolset.yaml) or add to `~/.holmes/config.yaml`
+
+**Custom Runbooks**: Give HolmesGPT instructions for known alerts:
+   - If using Robusta SaaS: Use the Robusta UI to add runbooks
+   - If using the CLI: Use `-r` flag with [custom runbook files](./examples/custom_runbooks.yaml) or add to `~/.holmes/config.yaml`
+
+You can save common settings and API Keys in a config file to avoid passing them from the CLI each time:
+
+<details>
+<summary>Reading settings from a config file</summary>
+
+You can save common settings and API keys in config file for re-use. Place the config file in <code>~/.holmes/config.yaml`</code> or pass it using the <code> --config</code>
+
+You can view an example config file with all available settings [here](config.example.yaml).
+</details>
+
+## 🔐 Data Privacy
+
+By design, HolmesGPT has **read-only access** and respects RBAC permissions. It is safe to run in production environments.
+
+We do **not** train HolmesGPT on your data. Data sent to Robusta SaaS is private to your account.
+
+For extra privacy, [bring an API key](https://robusta-dev.github.io/holmesgpt/ai-providers/) for your own AI model.
+
+
+## Evals
+
+Because HolmesGPT relies on LLMs, it relies on [a suite of pytest based evaluations](https://robusta-dev.github.io/holmesgpt/development/evals/) to ensure the prompt and HolmesGPT's default set of tools work as expected with LLMs.
+
+- [Introduction to HolmesGPT's evals](https://robusta-dev.github.io/holmesgpt/development/evals/).
+- [Write your own evals](https://robusta-dev.github.io/holmesgpt/development/evals/writing/).
+- [Use Braintrust to view analyze results (optional)](https://robusta-dev.github.io/holmesgpt/development/evals/reporting/).
+
+
+## License
+Distributed under the MIT License. See [LICENSE.txt](https://github.com/robusta-dev/holmesgpt/blob/master/LICENSE.txt) for more information.
+<!-- Change License -->
+
+## Support
+
+If you have any questions, feel free to message us on [robustacommunity.slack.com](https://bit.ly/robusta-slack)
+
+## How to Contribute
+
+Please read our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines and instructions.
+
+For help, contact us on [Slack](https://bit.ly/robusta-slack) or ask [DeepWiki AI](https://deepwiki.com/robusta-dev/holmesgpt) your questions.
+
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/robusta-dev/holmesgpt)
+

holmesgpt-0.12.4/README.md

@@ -0,0 +1,196 @@
+<div align="center">
+  <h1 align="center">AI Agent for Cloud Troubleshooting and Alert Investigation</h1>
+
+HolmesGPT is an AI agent for investigating problems in your cloud, finding the root cause, and suggesting remediations. It has dozens of built-in integrations for cloud providers, observability tools, and on-call systems.
+
+HolmesGPT has been submitted to the CNCF as a sandbox project ([view status](https://github.com/cncf/sandbox/issues/392)). You can learn more about HolmesGPT's maintainers and adopters [here](./ADOPTERS.md).
+
+  <p align="center">
+    <a href="#how-it-works"><strong>How it Works</strong></a> |
+    <a href="#installation"><strong>Installation</strong></a> |
+    <a href="#supported-llm-providers"><strong>LLM Providers</strong></a> |
+    <a href="https://www.youtube.com/watch?v=TfQfx65LsDQ"><strong>YouTube Demo</strong></a> |
+    <a href="https://deepwiki.com/robusta-dev/holmesgpt"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
+  </p>
+</div>
+
+![HolmesGPT Investigation Demo](https://robusta-dev.github.io/holmesgpt/assets/HolmesInvestigation.gif)
+
+## How it Works
+
+HolmesGPT connects AI models with live observability data and organizational knowledge. It uses an **agentic loop** to analyze data from multiple sources and identify possible root causes.
+
+<img width="3114" alt="holmesgpt-architecture-diagram" src="https://github.com/user-attachments/assets/f659707e-1958-4add-9238-8565a5e3713a" />
+
+### 🔗 Data Sources
+
+HolmesGPT integrates with popular observability and cloud platforms. The following data sources ("toolsets") are built-in. [Add your own](#customizing-holmesgpt).
+
+| Data Source | Status | Notes |
+|-------------|--------|-------|
+| [<img src="images/integration_logos/argocd-icon.png" alt="ArgoCD" width="20" style="vertical-align: middle;"> **ArgoCD**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/argocd/) | ✅ | Get status, history and manifests and more of apps, projects and clusters |
+| [<img src="images/integration_logos/aws_rds_logo.png" alt="AWS RDS" width="20" style="vertical-align: middle;"> **AWS RDS**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/aws/) | ✅ | Fetch events, instances, slow query logs and more |
+| [<img src="images/integration_logos/confluence_logo.png" alt="Confluence" width="20" style="vertical-align: middle;"> **Confluence**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/confluence/) | ✅ | Private runbooks and documentation |
+| [<img src="images/integration_logos/coralogix-icon.png" alt="Coralogix Logs" width="20" style="vertical-align: middle;"> **Coralogix Logs**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/coralogix-logs/) | ✅ | Retrieve logs for any resource |
+| [<img src="images/integration_logos/date_time_icon.png" alt="Datetime" width="20" style="vertical-align: middle;"> **Datetime**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/datetime/) | ✅ | Date and time-related operations |
+| [<img src="images/integration_logos/docker_logo.png" alt="Docker" width="20" style="vertical-align: middle;"> **Docker**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/docker/) | ✅ | Get images, logs, events, history and more |
+| [<img src="images/integration_logos/github_logo.png" alt="GitHub" width="20" style="vertical-align: middle;"> **GitHub**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/github/) | 🟡 Beta | Remediate alerts by opening pull requests with fixes |
+| [<img src="images/integration_logos/datadog_logo.png" alt="DataDog" width="20" style="vertical-align: middle;"> **DataDog**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/datadog/) | 🟡 Beta | Fetches log data from datadog  |
+| [<img src="images/integration_logos/grafana_loki-icon.png" alt="Loki" width="20" style="vertical-align: middle;"> **Grafana Loki**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/grafanaloki/) | ✅ | Query logs for Kubernetes resources or any query |
+| [<img src="images/integration_logos/tempo_logo.png" alt="Tempo" width="20" style="vertical-align: middle;"> **Grafana Tempo**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/grafanatempo/) | ✅ | Fetch trace info, debug issues like high latency in application. |
+| [<img src="images/integration_logos/helm_logo.png" alt="Helm" width="20" style="vertical-align: middle;"> **Helm**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/helm/) | ✅ | Release status, chart metadata, and values |
+| [<img src="images/integration_logos/http-icon.png" alt="Internet" width="20" style="vertical-align: middle;"> **Internet**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/internet/) | ✅ | Public runbooks, community docs etc |
+| [<img src="images/integration_logos/kafka_logo.png" alt="Kafka" width="20" style="vertical-align: middle;"> **Kafka**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/kafka/) | ✅ | Fetch metadata, list consumers and topics or find lagging consumer groups |
+| [<img src="images/integration_logos/kubernetes-icon.png" alt="Kubernetes" width="20" style="vertical-align: middle;"> **Kubernetes**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/kubernetes/) | ✅ | Pod logs, K8s events, and resource status (kubectl describe) |
+| [<img src="images/integration_logos/newrelic_logo.png" alt="NewRelic" width="20" style="vertical-align: middle;"> **NewRelic**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/newrelic/) | 🟡 Beta | Investigate alerts, query tracing data |
+| [<img src="images/integration_logos/opensearchserverless-icon.png" alt="OpenSearch" width="20" style="vertical-align: middle;"> **OpenSearch**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/opensearch-status/) | ✅ | Query health, shard, and settings related info of one or more clusters|
+| [<img src="images/integration_logos/prometheus-icon.png" alt="Prometheus" width="20" style="vertical-align: middle;"> **Prometheus**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/prometheus/) | ✅ | Investigate alerts, query metrics and generate PromQL queries  |
+| [<img src="images/integration_logos/rabbit_mq_logo.png" alt="RabbitMQ" width="20" style="vertical-align: middle;"> **RabbitMQ**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/rabbitmq/) | ✅ | Info about partitions, memory/disk alerts to troubleshoot split-brain scenarios and more  |
+| [<img src="images/integration_logos/robusta_logo.png" alt="Robusta" width="20" style="vertical-align: middle;"> **Robusta**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/robusta/) | ✅ | Multi-cluster monitoring, historical change data, user-configured runbooks, PromQL graphs and more |
+| [<img src="images/integration_logos/slab_logo.png" alt="Slab" width="20" style="vertical-align: middle;"> **Slab**](https://robusta-dev.github.io/holmesgpt/data-sources/builtin-toolsets/slab/) | ✅ | Team knowledge base and runbooks on demand |
+
+### 🚀 End-to-End Automation
+
+HolmesGPT can fetch alerts/tickets to investigate from external systems, then write the analysis back to the source or Slack.
+
+| Integration             | Status    | Notes |
+|-------------------------|-----------|-------|
+| Slack                   | 🟡 Beta   | [Demo.](https://www.loom.com/share/afcd81444b1a4adfaa0bbe01c37a4847) Tag HolmesGPT bot in any Slack message |
+| Prometheus/AlertManager | ✅        | Robusta SaaS or HolmesGPT CLI |
+| PagerDuty               | ✅        | HolmesGPT CLI only |
+| OpsGenie                | ✅        | HolmesGPT CLI only |
+| Jira                    | ✅        | HolmesGPT CLI only |
+| GitHub                  | ✅        | HolmesGPT CLI only |
+
+## Installation
+
+<a href="https://robusta-dev.github.io/holmesgpt/installation/cli-installation/">
+  <img src="images/integration_logos/all-installation-methods.png" alt="All Installation Methods" style="max-width:100%; height:auto;">
+</a>
+
+Read the [installation documentation](https://robusta-dev.github.io/holmesgpt/installation/cli-installation/) to learn how to install HolmesGPT.
+
+## Supported LLM Providers
+
+<a href="https://robusta-dev.github.io/holmesgpt/ai-providers/">
+  <img src="images/integration_logos/all-integration-providers.png" alt="All Integration Providers" style="max-width:100%; height:auto;">
+</a>
+
+Read the [LLM Providers documentation](https://robusta-dev.github.io/holmesgpt/ai-providers/) to learn how to set up your LLM API key.
+
+## Using HolmesGPT
+
+- In the Robusta SaaS: Go to [platform.robusta.dev](https://platform.robusta.dev/signup/?utm_source=github&utm_medium=holmesgpt-readme&utm_content=ways_to_use_holmesgpt_section) and use Holmes from your browser
+- With HolmesGPT CLI: [setup an LLM API key](https://robusta-dev.github.io/holmesgpt/ai-providers/) and ask Holmes a question 👇
+
+```bash
+holmes ask "what pods are unhealthy and why?"
+```
+
+You can also provide files as context:
+```bash
+holmes ask "summarize the key points in this document" -f ./mydocument.txt
+```
+
+You can also load the prompt from a file using the `--prompt-file` option:
+```bash
+holmes ask --prompt-file ~/long-prompt.txt
+
+Enter interactive mode to ask follow-up questions:
+```bash
+holmes ask "what pods are unhealthy and why?" --interactive
+# or
+holmes ask "what pods are unhealthy and why?" -i
+```
+
+Also supported:
+
+<details>
+<summary>HolmesGPT CLI: investigate Prometheus alerts</summary>
+
+Pull alerts from AlertManager and investigate them with HolmesGPT:
+
+```bash
+holmes investigate alertmanager --alertmanager-url http://localhost:9093
+# if on Mac OS and using the Holmes Docker image👇
+#  holmes investigate alertmanager --alertmanager-url http://docker.for.mac.localhost:9093
+```
+
+<b>To investigate alerts in your browser, sign up for a free trial of [Robusta SaaS](https://platform.robusta.dev/signup/?utm_source=github&utm_medium=holmesgpt-readme&utm_content=ways_to_use_holmesgpt_section). </b>
+
+
+<b>Optional:</b> port-forward to AlertManager before running the command mentioned above (if running Prometheus inside Kubernetes)
+
+```bash
+kubectl port-forward alertmanager-robusta-kube-prometheus-st-alertmanager-0 9093:9093 &
+```
+</details>
+
+<details>
+<summary>HolmesGPT CLI: investigate PagerDuty and OpsGenie alerts</summary>
+
+```bash
+holmes investigate opsgenie --opsgenie-api-key <OPSGENIE_API_KEY>
+holmes investigate pagerduty --pagerduty-api-key <PAGERDUTY_API_KEY>
+# to write the analysis back to the incident as a comment
+holmes investigate pagerduty --pagerduty-api-key <PAGERDUTY_API_KEY> --update
+```
+
+For more details, run `holmes investigate <source> --help`
+</details>
+
+## Customizing HolmesGPT
+
+HolmesGPT can investigate many issues out of the box, with no customization or training. Optionally, you can extend Holmes to improve results:
+
+**Custom Data Sources**: Add data sources (toolsets) to improve investigations
+   - If using Robusta SaaS: See [here](https://robusta-dev.github.io/holmesgpt/data-sources/custom-toolsets/)
+   - If using the CLI: Use `-t` flag with [custom toolset files](./examples/custom_toolset.yaml) or add to `~/.holmes/config.yaml`
+
+**Custom Runbooks**: Give HolmesGPT instructions for known alerts:
+   - If using Robusta SaaS: Use the Robusta UI to add runbooks
+   - If using the CLI: Use `-r` flag with [custom runbook files](./examples/custom_runbooks.yaml) or add to `~/.holmes/config.yaml`
+
+You can save common settings and API Keys in a config file to avoid passing them from the CLI each time:
+
+<details>
+<summary>Reading settings from a config file</summary>
+
+You can save common settings and API keys in config file for re-use. Place the config file in <code>~/.holmes/config.yaml`</code> or pass it using the <code> --config</code>
+
+You can view an example config file with all available settings [here](config.example.yaml).
+</details>
+
+## 🔐 Data Privacy
+
+By design, HolmesGPT has **read-only access** and respects RBAC permissions. It is safe to run in production environments.
+
+We do **not** train HolmesGPT on your data. Data sent to Robusta SaaS is private to your account.
+
+For extra privacy, [bring an API key](https://robusta-dev.github.io/holmesgpt/ai-providers/) for your own AI model.
+
+
+## Evals
+
+Because HolmesGPT relies on LLMs, it relies on [a suite of pytest based evaluations](https://robusta-dev.github.io/holmesgpt/development/evals/) to ensure the prompt and HolmesGPT's default set of tools work as expected with LLMs.
+
+- [Introduction to HolmesGPT's evals](https://robusta-dev.github.io/holmesgpt/development/evals/).
+- [Write your own evals](https://robusta-dev.github.io/holmesgpt/development/evals/writing/).
+- [Use Braintrust to view analyze results (optional)](https://robusta-dev.github.io/holmesgpt/development/evals/reporting/).
+
+
+## License
+Distributed under the MIT License. See [LICENSE.txt](https://github.com/robusta-dev/holmesgpt/blob/master/LICENSE.txt) for more information.
+<!-- Change License -->
+
+## Support
+
+If you have any questions, feel free to message us on [robustacommunity.slack.com](https://bit.ly/robusta-slack)
+
+## How to Contribute
+
+Please read our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines and instructions.
+
+For help, contact us on [Slack](https://bit.ly/robusta-slack) or ask [DeepWiki AI](https://deepwiki.com/robusta-dev/holmesgpt) your questions.
+
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/robusta-dev/holmesgpt)

{holmesgpt-0.12.3 → holmesgpt-0.12.4}/holmes/__init__.py

@@ -1,5 +1,5 @@
 # This is patched by github actions during release
-__version__ = "0.12.3"
+__version__ = "0.12.4"
 
 # Re-export version functions from version module for backward compatibility
 from .version import (