-
Notifications
You must be signed in to change notification settings - Fork 246
DOCS-1724 - Document Monitor Creation Agent in Mobot #6871
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
JV0812
wants to merge
3
commits into
main
Choose a base branch
from
DOCS-1724-monitor-creation-agent
base: main
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,12 @@ | ||
| --- | ||
| title: Create Monitors with Mobot (Search) | ||
| image: https://assets-www.sumologic.com/company-logos/_800x418_crop_center-center_82_none/SumoLogic_Preview_600x600.jpg?mtime=1617040082 | ||
| keywords: | ||
| - mobot | ||
| - monitor | ||
| - dojo ai | ||
| - agent | ||
| hide_table_of_contents: true | ||
| --- | ||
|
|
||
| We're excited to introduce the **Monitor Creation Agent** in Mobot, which lets you create and update logs monitors from plain-language prompts instead of filling out the monitor form. Describe the monitor you want, review the suggested configuration, and confirm to create it. [Learn more](/docs/alerts/monitors/create-monitor-with-mobot). |
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,111 @@ | ||
| --- | ||
| id: create-monitor-with-mobot | ||
| title: Create Monitors with Mobot | ||
| sidebar_label: Create Monitors with Mobot | ||
| description: Use the Monitor Creation Agent in Mobot to create and update logs monitors from plain-language prompts, without filling out the monitor form manually. | ||
| keywords: | ||
| - mobot | ||
| - monitor | ||
| - dojo ai | ||
| - agent | ||
| - monitor creation agent | ||
| --- | ||
|
|
||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| The **Monitor Creation Agent** lets you create monitors from plain-language prompts in [Mobot](/docs/search/mobot), Sumo Logic's conversational AI assistant. Describe the monitor you want in everyday language, and the agent validates your query, suggests a complete configuration, and creates the monitor after you confirm. You can also update a monitor within the same conversation. | ||
|
|
||
| The agent supports logs monitors only, not metrics or SLO (Service Level Objective) monitors, and can create static, anomaly, and outlier detection types. From a single prompt, it populates the monitor name, description, query, trigger conditions, recovery conditions, and notifications, and you can accept or adjust each suggestion before the monitor is created. | ||
|
|
||
| ## Which monitor types does the agent support? | ||
|
|
||
| The Monitor Creation Agent supports logs monitors only. | ||
|
|
||
| | Monitor type | Supported | | ||
| | :-- | :-- | | ||
| | Logs | Yes | | ||
| | Metrics | No | | ||
| | SLO | No | | ||
|
|
||
| For logs monitors, the agent can create the following detection types: | ||
|
|
||
| - **Static**. Trigger when results cross a threshold you define. | ||
| - **Anomaly**. Trigger on deviations from a machine learning baseline. | ||
| - **Outlier**. Trigger when values fall outside the expected range for your logs. | ||
|
|
||
| ## What the agent can configure | ||
|
|
||
| From your prompt, the agent suggests values for the following, and you can accept each suggestion or provide your own: | ||
|
|
||
| - **Name** and **description**. | ||
| - **Query** (validated before the configuration is suggested). | ||
| - **Trigger conditions and thresholds**. | ||
| - **Recovery conditions**. | ||
| - **Notifications** through email or a connection. | ||
|
|
||
| ## How to create a monitor with Mobot | ||
|
|
||
| 1. Open [Mobot](/docs/search/mobot) and select the **Monitor Creation Agent**.<br/>{/* TODO: add screenshot of Monitor Creation Agent selected in Mobot */} | ||
| 1. Describe the monitor you want in plain language. For example:<br/>`Alert me when the payment-service query has more than 20 errors in a 5-minute window.` | ||
| 1. The agent validates your query and suggests a configuration, including name, description, monitor type, query, trigger, recovery, and notifications.<br/>{/* TODO: add screenshot of the suggested configuration card */} | ||
| 1. Review each suggestion. To change a value, tell the agent what you want. For example, ask it to rename the monitor or adjust the trigger threshold. | ||
| 1. (Optional) Add a notification. You can be notified by email or through a connection, such as Slack. | ||
| - If your organization has one connection, the agent adds it automatically. | ||
| - If your organization has more than one connection, the agent lists them and asks which to use. | ||
| 1. When the configuration looks right, the agent shows a confirmation card. Confirm to create the monitor.<br/>{/* TODO: add screenshot of the confirmation card */} | ||
| 1. The agent creates the monitor and returns its ID along with the configured conditions. Mobot also displays a chip for the new monitor. Click the chip to open the created monitor. | ||
|
|
||
| The new monitor appears on the **Monitors** tab, the same as a monitor created through the form. | ||
|
|
||
| ## How to update a monitor in a conversation | ||
|
|
||
| You can update a monitor you created earlier in the same conversation. Tell the agent what to change, and it shows a confirmation card summarizing the update before applying it. | ||
|
|
||
| The agent can only update the following fields: | ||
|
|
||
| - Name | ||
| - Description | ||
| - Query | ||
| - Trigger conditions | ||
| - Notifications | ||
| - Query time range | ||
|
|
||
| For example, ask the agent to change the trigger threshold from 20 to 15 and the time window to 7 minutes. The agent confirms that the threshold will change from 20 to 15 and the window will change to 7 minutes, and applies the update after you confirm. | ||
|
|
||
| :::note | ||
| The agent cannot disable or delete a monitor. To disable or delete a monitor, use the **Monitors** tab. | ||
| ::: | ||
|
|
||
| ## Example prompts | ||
|
|
||
| - `Alert me when the payment-service query has more than 20 errors in a 5-minute window.` | ||
| - `Create a monitor that notifies me by email when login failures exceed 100 in 10 minutes.` | ||
| - `Notify my Slack channel when 5xx responses spike above the normal range.` | ||
|
|
||
| ## Frequently asked questions | ||
|
|
||
| ### Can the Monitor Creation Agent create metrics or SLO monitors? | ||
|
|
||
| No. The agent creates logs monitors only. Use the monitor form to create metrics or SLO monitors. | ||
|
|
||
| ### What detection types can the agent create? | ||
|
|
||
| The agent can create static, anomaly, and outlier detection types for logs monitors. | ||
|
|
||
| ### Can you edit a monitor after the agent creates it? | ||
|
|
||
| Yes. You can update a monitor within the same conversation, or edit it later from the **Monitors** tab like any other monitor. | ||
|
|
||
| ### Does the agent validate your query before creating the monitor? | ||
|
|
||
| Yes. The agent validates your query first, and then suggests the rest of the configuration, including name, description, trigger, recovery, and notifications. | ||
|
|
||
| ### How does the agent set up notifications? | ||
|
|
||
| You can be notified by email or through a connection, such as Slack. If your organization has one connection, the agent adds it automatically. If you have more than one, the agent lists them and asks which to use. | ||
|
|
||
| ## Related resources | ||
|
|
||
| - [Mobot](/docs/search/mobot) | ||
| - [Create a New Monitor](/docs/alerts/monitors/create-monitor) | ||
| - [AI and Machine Learning with Sumo Logic](/docs/get-started/ai-machine-learning) | ||
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
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.