-
Notifications
You must be signed in to change notification settings - Fork 1
Updated documentation changes in infrastructure integrations and KloudMate Assistant #12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
vasavi-r
wants to merge
3
commits into
kloudmate:master
Choose a base branch
from
vasavi-r:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| --- | ||
| title: "Chat Modes" | ||
| description: "Understand the four chat modes available in KloudMate Assistant and when to use each one." | ||
| sidebar: | ||
| order: 3 | ||
| --- | ||
| Chat Modes let you choose how KloudMate Assistant should respond before you send a message. Each mode is optimized for a different type of task, whether you want a direct answer, a drafted configuration change, documentation help, or a deeper background investigation. | ||
|
|
||
| ## Opening the Mode Picker | ||
|
|
||
| To choose a chat mode, click the sparkle icon in the top-right corner of the Assistant interface. | ||
|
|
||
|  | ||
|
|
||
| Once the Assistant panel opens, use the mode selector in the chat input bar to switch between the available modes. | ||
|
|
||
| ## KloudMate Assistant | ||
|
|
||
| KloudMate Assistant is the default real-time assistant mode. Use it when you want fast answers, platform guidance, or operational help across logs, metrics, traces, alarms, and other KloudMate features. | ||
|
|
||
| This mode is best suited for: | ||
|
|
||
| - Understanding product behavior or workflows | ||
| - Asking questions about recent errors or issues | ||
| - Getting quick explanations without launching a background investigation | ||
|
|
||
| In this example, the Assistant searches the relevant logs and returns a direct explanation of the exporter failure, including the root cause pattern, affected component, signal type, service context, and a short investigation summary. | ||
|
|
||
|  | ||
|
|
||
| ## KloudMate Builder | ||
|
|
||
| KloudMate Builder is designed for drafting dashboards and alarms before you apply them. Use this mode when you want help creating or modifying alerting and dashboard configurations from natural-language instructions. | ||
|
|
||
| In this example, KloudMate Builder interprets the request as an alert creation task for frontend CPU usage and prepares a draft configuration based on that intent. | ||
|
|
||
|  | ||
|
|
||
| This helps users move from a natural-language request to a structured alarm draft without manually configuring every field from scratch. The Builder selects an appropriate metric, applies the relevant service filter, and translates the requested threshold into a reviewable alert definition that can be refined and saved. | ||
|
|
||
| ## KloudMate Docs | ||
|
|
||
| KloudMate Docs is optimized for documentation search and platform reference questions. Use this mode when you want answers grounded in the KloudMate documentation rather than a general operational conversation. | ||
|
|
||
| This mode is useful for: | ||
|
|
||
| - Getting started and onboarding questions | ||
| - Finding instrumentation instructions | ||
| - Looking up product concepts, alerting behavior, or setup guides | ||
|
|
||
| The Docs mode searches the indexed documentation and returns an answer based on the documented product behavior. | ||
|
|
||
|  | ||
|
|
||
| ## KloudMate Investigator | ||
|
|
||
| KloudMate Investigator is used for deeper, background investigations. Instead of replying with only a quick answer, it collects incident context and helps frame a broader RCA workflow. | ||
|
|
||
| This mode is appropriate when you need: | ||
|
|
||
| - Incident triage over a recent time window | ||
| - Correlation across logs, metrics, and traces | ||
| - A structured summary of findings for an active issue | ||
|
|
||
| In this example, the Investigator launches a background investigation, tracks its progress, and returns a completed report with overall health status, severity, top suspects, likely causes, affected resources, and recommended fixes. | ||
|
|
||
|  | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,20 +9,11 @@ KloudMate Assistant is an AI-driven observability assistant designed to simplify | |
|
|
||
| The assistant works across your entire observability stack, including metrics, logs, traces, profiles, and connected data sources. It interprets context, correlates signals, and surfaces actionable insights, reducing the need to manually switch between tools or deeply understand each underlying system. | ||
|
|
||
|
|
||
|
|
||
| ### What KloudMate Assistant Can Do | ||
|
|
||
| KloudMate Assistant supports three core modes of operation: | ||
|
|
||
| - **KloudMate Assistant:** Provides real-time guidance and answers across the KloudMate platform. Ask questions, explore your data, and get instant insights through a conversational interface. | ||
| - **KloudMate Dashboarding:** Drafts dashboards and alarms on your behalf. For example, you can say “Create a dashboard for Kubernetes” and the Assistant will generate a structured, ready-to-use dashboard. | ||
| - **KloudMate Investigator:** Collects an investigation brief and launches a background root cause analysis (RCA) workflow for serious incidents. The Investigator runs asynchronously and surfaces findings when complete. | ||
|
|
||
| ### Accessing KloudMate Assistant | ||
|
|
||
| To access KloudMate Assistant, click **KloudMate Assistant** in the left sidebar. This expands the section and reveals three sub-pages: | ||
| To access KloudMate Assistant, click **KloudMate Assistant** in the left sidebar. This expands the section and reveals the available sub-pages: | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is wrong, the assistant is accessible from top assistant icon |
||
|
|
||
| - **Investigations** | ||
| - **Usage** | ||
| - **Settings** | ||
| - [Investigations](./investigations/) | ||
| - [Chat Modes](./chat-modes/) | ||
| - [Settings](./settings/) | ||
| - [Usage](./usage/) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add some note on pricing. Docs agent is free