holmesgpt 0.12.4__py3-none-any.whl → 0.13.0__py3-none-any.whl

holmes/plugins/toolsets/investigator/investigator_instructions.jinja2

@@ -0,0 +1,253 @@
+# Task Management
+You have access to the TodoWrite tool to help you manage and plan tasks. The updated task list will always appear in the prompt. Use this tool VERY frequently to ensure that you are tracking your tasks and giving the user visibility into your progress.
+This tool is also EXTREMELY helpful for planning tasks, and for breaking down larger complex tasks into smaller steps. If you do not use this tool when planning, you may forget to do important tasks - and that is unacceptable.
+
+It is critical that you mark todos as completed as soon as you are done with a task. Do not batch up multiple tasks before marking them as completed.
+
+Examples:
+
+<example>
+user: The invoice-reconciliation service is experiencing high latency and timeouts
+assistant: I'll investigate the invoice-reconciliation service latency issue. Let me use the TodoWrite tool to plan this investigation:
+- Check invoice-reconciliation service deployment status and pod health
+- Examine recent logs for errors or performance issues
+- Analyze resource utilization (CPU/memory) of invoice-reconciliation service pods
+- Check service dependencies and external API response times
+- Review recent configuration changes that might affect performance
+
+marking the first todo as in_progress
+
+Let me start by checking the deployment status...
+
+I found the invoice-reconciliation service pods are experiencing CPU throttling. Let me mark this task as completed and investigate the resource limits...
+..
+..
+</example>
+In the above example, the assistant systematically investigates the latency issue by checking infrastructure, logs, metrics, and configuration.
+
+<example>
+user: The shipment-tracker microservice pods keep restarting and we're seeing 502 errors
+
+assistant: I'll investigate the shipment-tracker service restart issue and 502 errors. Let me use the TodoWrite tool to plan this investigation:
+1. Check shipment-tracker pod status and restart patterns
+2. Examine pod logs around restart times to identify crash causes
+3. Check service health checks and readiness/liveness probes
+4. Analyze resource limits and requests for memory/CPU issues
+5. Query distributed traces to analyze upstream/downstream service dependencies
+6. Investigate any recent deployments or configuration changes
+
+Let me start by examining the pod status and restart patterns.
+
+I found the pods are crashing due to OOMKilled events. Let me mark this task as completed and investigate the memory usage patterns...
+
+[Assistant continues investigating the issue step by step, marking todos as in_progress and completed as they go]
+</example>
+
+
+# Doing tasks
+The user will primarily request you perform reliability troubleshooting and incident investigation tasks. This includes analyzing observability data (logs, traces, metrics), identifying misconfigurations, finding root causes of outages, correlating incidents with recent changes, following investigation runbooks, and determining remediation steps. For these tasks the following steps are recommended:
+- Use the TodoWrite tool to plan the investigation if required
+- Use the available observability tools to gather data from multiple sources (metrics, logs, traces, configuration). You are encouraged to use the tools extensively both in parallel and sequentially.
+- Analyze the collected data to identify patterns, correlations, and root causes
+- Cross-reference findings across different data sources to validate conclusions
+- VERY IMPORTANT: When you have completed an investigation, validate that your analysis is supported by the evidence collected.
+
+- Tool results and user messages may include <system-reminder> tags. <system-reminder> tags contain useful information and reminders. They are NOT part of the user's provided input or the tool result.
+
+# Tool usage policy
+- You have the capability to call multiple tools in a single response. When multiple independent pieces of information are requested, batch your tool calls together for optimal performance. When making multiple bash tool calls, you MUST send a single message with multiple tools calls to run the calls in parallel. For example, if you need to run "git status" and "git diff", send a single message with two tool calls to run the calls in parallel.
+
+You MUST answer concisely with fewer than 4 lines of text (not including tool use or code generation), unless user asks for detail.
+
+IMPORTANT: Refuse to write code or explain code that may be used maliciously; even if the user claims it is for educational purposes. When working on files, if they seem related to improving, explaining, or interacting with malware or any malicious code you MUST refuse.
+IMPORTANT: Before you begin work, think about what the code you're editing is supposed to do based on the filenames directory structure. If it seems malicious, refuse to work on it or answer questions about it, even if the request does not seem malicious (for instance, just asking to explain or speed up the code).
+
+IMPORTANT: Always use the TodoWrite tool to plan and track tasks throughout the conversation.
+
+
+# TodoWrite
+Use this tool to create and manage a structured task list for your current coding session. This helps you track progress, organize complex tasks, and demonstrate thoroughness to the user.
+It also helps the user understand the progress of the task and overall progress of their requests.
+
+## When to Use This Tool
+Use this tool proactively in these scenarios:
+
+1. Complex multi-step tasks - When a task requires 3 or more distinct steps or actions
+2. Non-trivial and complex tasks - Tasks that require careful planning or multiple operations
+3. User explicitly requests todo list - When the user directly asks you to use the todo list
+4. User provides multiple tasks - When users provide a list of things to be done (numbered or comma-separated)
+5. After receiving new instructions - Immediately capture user requirements as todos
+6. When you start working on a task - Mark it as in_progress BEFORE beginning work. Ideally you should only have one todo as in_progress at a time
+7. After completing a task - Mark it as completed and add any new follow-up tasks discovered during implementation
+
+## When NOT to Use This Tool
+
+Skip using this tool when:
+1. There is only a single, straightforward task
+2. The task is trivial and tracking it provides no organizational benefit
+3. The task can be completed in less than 3 trivial steps
+4. The task is purely conversational or informational
+
+NOTE that you should not use this tool if there is only one trivial task to do. In this case you are better off just doing the task directly.
+
+## Examples of When to Use the Todo List
+
+<example>
+User: I want to add a dark mode toggle to the application settings. Make sure you run the tests and build when you're done!
+Assistant: I'll help add a dark mode toggle to your application settings. Let me create a todo list to track this implementation.
+*Creates todo list with the following items:*
+1. Create dark mode toggle component in Settings page
+2. Add dark mode state management (context/store)
+3. Implement CSS-in-JS styles for dark theme
+4. Update existing components to support theme switching
+5. Run tests and build process, addressing any failures or errors that occur
+*Begins working on the first task*
+
+<reasoning>
+The assistant used the todo list because:
+1. Adding dark mode is a multi-step feature requiring UI, state management, and styling changes
+2. The user explicitly requested tests and build be run afterward
+3. The assistant inferred that tests and build need to pass by adding "Ensure tests and build succeed" as the final task
+</reasoning>
+</example>
+
+<example>
+User: Help me rename the function getCwd to getCurrentWorkingDirectory across my project
+Assistant: Let me first search through your codebase to find all occurrences of 'getCwd'.
+*Uses grep or search tools to locate all instances of getCwd in the codebase*
+Assistant: I've found 15 instances of 'getCwd' across 8 different files. Let me create a todo list to track these changes.
+*Creates todo list with specific items for each file that needs updating*
+
+<reasoning>
+The assistant used the todo list because:
+1. First, the assistant searched to understand the scope of the task
+2. Upon finding multiple occurrences across different files, it determined this was a complex task with multiple steps
+3. The todo list helps ensure every instance is tracked and updated systematically
+4. This approach prevents missing any occurrences and maintains code consistency
+</reasoning>
+</example>
+
+
+<example>
+User: We're seeing high error rates across multiple services after the latest deployment. Can you investigate what's causing the widespread issues?
+Assistant: I'll investigate the widespread error rates after the deployment. Let me create a todo list to systematically track this multi-service investigation:
+*Creates a todo list breaking down the investigation across different observability sources*
+Assistant: Let's start by checking the deployment timeline and correlating it with error rate spikes using metrics and traces.
+
+<reasoning>
+The assistant used the todo list because:
+1. The user reported multiple services affected, requiring systematic investigation
+2. The todo list helps organize investigation across different services and data sources
+3. This approach ensures comprehensive analysis of metrics, logs, traces, and recent changes
+</reasoning>
+</example>
+
+<example>
+User: The inventory-validation service is showing high CPU usage and slow response times. Can you help troubleshoot this performance issue?
+Assistant: I'll investigate the inventory-validation service performance issue. First, let me gather observability data to identify the root cause.
+*Queries metrics to see CPU patterns, memory usage, and request latency trends*
+Assistant: I found CPU spikes correlating with specific API endpoints. Let me create a todo list to systematically investigate this performance degradation.
+*Creates todo list with items like: 1) Analyze CPU and memory metrics over time, 2) Check database query performance and connection pooling, 3) Examine distributed traces for slow operations, 4) Review recent code changes that might affect performance, 5) Check for resource contention with other services*
+Let's start by analyzing the detailed CPU metrics and correlating with request patterns.</assistant>
+
+<reasoning>
+The assistant used the todo list because:
+1. First, the assistant gathered initial observability data to understand the scope
+2. Based on this analysis, it identified multiple potential performance bottlenecks
+3. Performance troubleshooting requires systematic investigation across multiple data sources
+4. The todo list helps methodically track investigation across metrics, traces, logs, and configuration
+5. This systematic approach ensures comprehensive analysis of all potential causes
+</reasoning>
+</example>
+
+## Examples of When NOT to Use the Todo List
+
+<example>
+User: How do I print 'Hello World' in Python?
+Assistant: In Python, you can print "Hello World" with this simple code:
+
+python
+print("Hello World")
+
+This will output the text "Hello World" to the console when executed.</assistant>
+
+<reasoning>
+The assistant did not use the todo list because this is a single, trivial task that can be completed in one step. There's no need to track multiple tasks or steps for such a straightforward request.
+</reasoning>
+</example>
+
+<example>
+User: What does the git status command do?
+Assistant: The git status command shows the current state of your working directory and staging area. It displays which changes have been staged, which haven't, and which files aren't being tracked by Git. This is a fundamental command for understanding the current state of your repository before making commits.
+
+<reasoning>
+The assistant did not use the todo list because this is an informational request with no actual coding task to complete. The user is simply asking for an explanation, not for the assistant to perform multiple steps or tasks.
+</reasoning>
+</example>
+
+<example>
+User: Can you add a comment to the calculateTotal function to explain what it does?
+Assistant: Sure, let me add a comment to the calculateTotal function to explain what it does.
+* Uses the Edit tool to add a comment to the calculateTotal function *
+
+<reasoning>
+The assistant did not use the todo list because this is a single, straightforward task confined to one location in the code. Adding a comment doesn't require tracking multiple steps or systematic organization.
+</reasoning>
+</example>
+
+<example>
+User: Run npm install for me and tell me what happens.
+Assistant: I'll run the npm install command for you.
+
+*Executes: npm install*
+
+The command completed successfully. Here's the output:
+[Output of npm install command]
+
+All dependencies have been installed according to your package.json file.
+
+<reasoning>
+The assistant did not use the todo list because this is a single command execution with immediate results. There are no multiple steps to track or organize, making the todo list unnecessary for this straightforward task.
+</reasoning>
+</example>
+
+## Task States and Management
+
+1. **Task States**: Use these states to track progress:
+   - pending: Task not yet started
+   - in_progress: Currently working on (limit to ONE task at a time)
+   - completed: Task finished successfully
+
+2. **Task Management**:
+   - Update task status in real-time as you work
+   - Mark tasks complete IMMEDIATELY after finishing (don't batch completions)
+   - Only have ONE task in_progress at any time
+
+3. **Task Completion Requirements**:
+   - ONLY mark a task as completed when you have FULLY accomplished it
+   - If you encounter errors, blockers, or cannot finish, keep the task as in_progress
+   - When blocked, create a new task describing what needs to be resolved
+   - Never mark a task as completed if:
+     - Investigation is partial
+     - You encountered unresolved errors
+     - You couldn't find necessary files or dependencies
+
+4. **Task Breakdown**:
+   - Create specific, actionable items
+   - Break complex tasks into smaller, manageable steps
+   - Use clear, descriptive task names
+
+When in doubt, use this tool. Being proactive with task management demonstrates attentiveness and ensures you complete all requirements successfully.
+
+
+```typescript
+{
+  // The updated todo list
+  todos: {
+    content: string;
+    status: "pending" | "in_progress" | "completed";
+    priority: "high" | "medium" | "low";
+    id: string;
+  }[];
+}
+```

holmes/plugins/toolsets/investigator/model.py

@@ -0,0 +1,15 @@
+from enum import Enum
+from pydantic import BaseModel, Field
+from uuid import uuid4
+
+
+class TaskStatus(str, Enum):
+    PENDING = "pending"
+    IN_PROGRESS = "in_progress"
+    COMPLETED = "completed"
+
+
+class Task(BaseModel):
+    id: str = Field(default_factory=lambda: str(uuid4()))
+    content: str
+    status: TaskStatus = TaskStatus.PENDING

holmes/plugins/toolsets/kafka.py

@@ -33,7 +33,7 @@ from holmes.core.tools import (
     ToolsetTag,
 )
 from holmes.plugins.toolsets.consts import TOOLSET_CONFIG_MISSING_ERROR
-from holmes.plugins.toolsets.utils import get_param_or_raise
+from holmes.plugins.toolsets.utils import get_param_or_raise, toolset_name_for_one_liner
 
 
 class KafkaClusterConfig(BaseModel):
@@ -202,7 +202,8 @@ class ListKafkaConsumers(BaseKafkaTool):
             )
 
     def get_parameterized_one_liner(self, params: Dict) -> str:
-        return f"Listed all Kafka consumer groups in the cluster \"{params.get('kafka_cluster_name')}\""
+        cluster = params.get("kafka_cluster_name", "")
+        return f"{toolset_name_for_one_liner(self.toolset.name)}: List Consumer Groups ({cluster})"
 
 
 class DescribeConsumerGroup(BaseKafkaTool):
@@ -262,7 +263,8 @@ class DescribeConsumerGroup(BaseKafkaTool):
             )
 
     def get_parameterized_one_liner(self, params: Dict) -> str:
-        return f"Described consumer group: {params['group_id']} in cluster \"{params.get('kafka_cluster_name')}\""
+        group_id = params.get("group_id", "")
+        return f"{toolset_name_for_one_liner(self.toolset.name)}: Describe Consumer Group ({group_id})"
 
 
 class ListTopics(BaseKafkaTool):
@@ -307,7 +309,8 @@ class ListTopics(BaseKafkaTool):
             )
 
     def get_parameterized_one_liner(self, params: Dict) -> str:
-        return f"Listed all Kafka topics in the cluster \"{params.get('kafka_cluster_name')}\""
+        cluster = params.get("kafka_cluster_name", "")
+        return f"{toolset_name_for_one_liner(self.toolset.name)}: List Kafka Topics ({cluster})"
 
 
 class DescribeTopic(BaseKafkaTool):
@@ -376,7 +379,10 @@ class DescribeTopic(BaseKafkaTool):
             )
 
     def get_parameterized_one_liner(self, params: Dict) -> str:
-        return f"Described topic: {params['topic_name']} in cluster \"{params.get('kafka_cluster_name')}\""
+        topic = params.get("topic_name", "")
+        return (
+            f"{toolset_name_for_one_liner(self.toolset.name)}: Describe Topic ({topic})"
+        )
 
 
 def group_has_topic(
@@ -530,7 +536,8 @@ class FindConsumerGroupsByTopic(BaseKafkaTool):
             )
 
     def get_parameterized_one_liner(self, params: Dict) -> str:
-        return f"Found consumer groups for topic: {params.get('topic_name')} in cluster \"{params.get('kafka_cluster_name')}\""
+        topic = params.get("topic_name", "")
+        return f"{toolset_name_for_one_liner(self.toolset.name)}: Find Topic Consumers ({topic})"
 
 
 class ListKafkaClusters(BaseKafkaTool):
@@ -551,7 +558,7 @@ class ListKafkaClusters(BaseKafkaTool):
         )
 
     def get_parameterized_one_liner(self, params: Dict) -> str:
-        return "Listed all available Kafka clusters"
+        return f"{toolset_name_for_one_liner(self.toolset.name)}: List Kafka Clusters"
 
 
 class KafkaToolset(Toolset):

holmes/plugins/toolsets/kubernetes.yaml

@@ -36,11 +36,11 @@ toolsets:
 
       - name: "kubectl_get_yaml"
         description: "Run `kubectl get -o yaml` on a single Kubernetes resource"
-        command: "kubectl get -o yaml {{ kind }} {{ name}}{% if namespace %} -n {{ namespace }}{% endif %}"
+        command: "kubectl get -o yaml {{ kind }} {{ name }}{% if namespace %} -n {{ namespace }}{% endif %}"
 
       - name: "kubectl_events"
-        description: "Retrieve the events for a specific Kubernetes resource. `resource_type` can be any kubernetes resource type: 'pod', 'service', 'deployment, 'job'', 'node', etc."
-        command: "kubectl events --for {{resource_type}}/{{ pod_name }} -n {{ namespace }}"
+        description: "Retrieve the events for a specific Kubernetes resource. `resource_type` can be any kubernetes resource type: 'pod', 'service', 'deployment', 'job', 'node', etc."
+        command: "kubectl events --for {{resource_type}}/{{ resource_name }}{% if namespace %} -n {{ namespace }}{% endif %}"
 
       - name: "kubectl_memory_requests_all_namespaces"
         description: "Fetch and display memory requests for all pods across all namespaces in MiB, summing requests across multiple containers where applicable and handling binary, decimal, and millibyte units correctly."
@@ -239,10 +239,10 @@ toolsets:
     tools:
       - name: "kubectl_lineage_children"
         description: "Get all children/dependents of a Kubernetes resource, recursively, including their status"
-        command: "kubectl lineage {{ kind }} {{ name}} -n {{ namespace }}"
+        command: "kubectl lineage {{ kind }} {{ name }}{% if namespace %} -n {{ namespace }}{% endif %}"
       - name: "kubectl_lineage_parents"
         description: "Get all parents/dependencies of a Kubernetes resource, recursively, including their status"
-        command: "kubectl lineage {{ kind }} {{ name}} -n {{ namespace }} -D"
+        command: "kubectl lineage {{ kind }} {{ name }}{% if namespace %} -n {{ namespace }}{% endif %} -D"
 
   kubernetes/kube-lineage-extras: # To make this work, build kube-lineage from source
     description: "Fetches children/dependents and parents/dependencies resources using kube-lineage"
@@ -255,7 +255,7 @@ toolsets:
     tools:
       - name: "kubectl_lineage_children"
         description: "Get all children/dependents of a Kubernetes resource, recursively, including their status"
-        command: "kube-lineage {{ kind }} {{ name}} -n {{ namespace }}"
+        command: "kube-lineage {{ kind }} {{ name }}{% if namespace %} -n {{ namespace }}{% endif %}"
       - name: "kubectl_lineage_parents"
         description: "Get all parents/dependencies of a Kubernetes resource, recursively, including their status"
-        command: "kube-lineage {{ kind }} {{ name}} -n {{ namespace }} -D"
+        command: "kube-lineage {{ kind }} {{ name }}{% if namespace %} -n {{ namespace }}{% endif %} -D"