-
Notifications
You must be signed in to change notification settings - Fork 228
DOCS-780 - Real-time sched search deprecation #5215
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
Merged
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
deb61d4
Real-time sched search deprecation
kimsauce 569dddb
Remove mentions of RT SS
kimsauce 9761d93
Update docs/manage/manage-subscription/cloud-flex-legacy-accounts.md
kimsauce b444d37
Update create-real-time-alert.md
kimsauce 3d54b55
Merge branch 'main' into DOCS-780
kimsauce 1c7cb06
Merge branch 'main' into DOCS-780
kimsauce a147a67
added release note and redirect
kimsauce bb305a4
Update sidebars.ts
kimsauce d3761bf
Merge branch 'main' into DOCS-780
kimsauce 36bb75f
Update blog-service/2025-05-15-alerts.md
kimsauce 7ad2eae
Merge branch 'main' into DOCS-780
kimsauce 081d395
fixes
kimsauce 91cf640
Update docs/alerts/scheduled-searches/create-real-time-alert.md
kimsauce 8af107f
Merge branch 'main' into DOCS-780
kimsauce 9f6933b
Remove 15-min conversion
kimsauce 6dd1c2c
Update 12-31.md
kimsauce 64f05d1
Rename 2025-05-15-alerts.md to 2025-05-05-alerts.md
kimsauce 8b3a1b4
Merge branch 'main' into DOCS-780
kimsauce 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| title: Real-Time Scheduled Searches Deprecation (Alerts) | ||
| image: https://help.sumologic.com/img/sumo-square.png | ||
| keywords: | ||
| - alerts | ||
| - scheduled searches | ||
| - monitors | ||
| hide_table_of_contents: true | ||
| --- | ||
|
|
||
| The [previously announced](/release-notes-service/2024/12/31/#deprecation-notice---real-time-scheduled-searches) automatic conversion of Real-Time Scheduled Searches to 15-minute scheduled searches will not take place. | ||
|
|
||
| - Existing Real-Time Scheduled Searches will continue to operate as-is. | ||
| - Creating new Real-Time Scheduled Searches remains disabled (since May 29, 2024). | ||
| - For new real-time alerting use cases, we recommend using [Monitors](https://help.sumologic.com/docs/alerts/monitors/overview). | ||
|
|
||
| [Learn more](/docs/alerts/scheduled-searches/create-real-time-alert). |
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
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 |
|---|---|---|
| @@ -1,69 +1,47 @@ | ||
| --- | ||
| id: create-real-time-alert | ||
| title: Create a Scheduled Search Real-Time Alert | ||
| description: Real-time alerts notify you of error conditions right when they occur. | ||
| title: Deprecation of Real-Time Scheduled Searches | ||
| --- | ||
|
|
||
kimsauce marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| :::warning Solution Deprecated | ||
| The ability to create new real-time alert scheduled searches has been deprecated. While you can no longer create new real-time alerts, existing real-time alerts will continue to function as before. [Learn more](/docs/alerts/scheduled-searches/deprecation). | ||
| ::: | ||
|
|
||
| Real-time alerts are scheduled searches that run nearly continuously. This means that you're informed in real time when error conditions exist. | ||
|
|
||
| When an alert condition is satisfied, Sumo Logic triggers the selected alert type and examines ingested data in a rolling window using the time range you define. When a new result is found, you'll receive an email. | ||
|
|
||
| This document describes how to manage existing real-time alert scheduled searches. Although creating new real-time alerts is no longer supported, you can still view, edit, and delete existing ones. | ||
|
|
||
| ## When to use | ||
|
|
||
| Only use real-time schedules when you know your data is ingested within a few minutes of its creation. The [receipt time](/docs/search/get-started-with-search/build-search/use-receipt-time) should be within a few minutes of your log's [message time](/docs/search/get-started-with-search/search-basics/built-in-metadata). Learn about | ||
| troubleshooting timestamp discrepancies [here](/docs/send-data/collector-faq#troubleshooting-time-discrepancies). | ||
| <head> | ||
| <meta name="robots" content="noindex" /> | ||
| </head> | ||
|
|
||
| Real-time alerts are not duplicated, which means that if a specific raw log message has triggered an alert once already, that same log message will not trigger an alert a second time. | ||
|
|
||
| For example, if **Message X** caused an alert to be sent at **Time T**, and Sumo Logic detects **Message X** again at **Time T+1**, Sumo Logic does not send a second alert at **Time T+1**. But if Sumo Logic detects **Message Y** at **Time T+1**, a new alert is sent, because the root cause is different. | ||
|
|
||
| :::important | ||
| If the time zone of messages is set incorrectly, those logs won't be picked up by real-time alerts. | ||
| :::warning Deprecated Feature | ||
| As of May 29, 2024, creating new Real-Time Scheduled Searches has been disabled. Existing Real-Time Scheduled Searches will continue to function as-is. For new alerting needs, we recommend using [Monitors](/docs/alerts/monitors/overview). | ||
| ::: | ||
|
|
||
| Sumo Logic has deprecated Real-Time Scheduled Searches as part of our ongoing platform improvements. While existing searches continue to operate, [Monitors](/docs/alerts/monitors/overview) are the recommended solution for real-time and scheduled alerting going forward. | ||
|
|
||
| ## Limitations | ||
|
|
||
| * The time range of a real-time alerts must be between 5 and 15 minutes. | ||
| * Searching by receipt time is not supported. | ||
| * If your search query result is a subset of your previous run's result, a real-time alert will not trigger. It will trigger only when there are new results compared to the previous run. | ||
| * A maximum of 120 emails are sent per day from real-time alerts. | ||
| * Aggregate real-time scheduled searches evaluate the first 1,000 results per search. For example, if the scheduled search is supposed to return more than 1,000 results, reduce the scope of the search. | ||
| * Non-aggregate real-time scheduled searches evaluate the first 100 results per search. For example, if the scheduled search is supposed to return more than 100 results, either convert it to aggregate scheduled search or reduce the scope of the search. | ||
| * The [`_dataTier`](/docs/manage/partitions/data-tiers) search modifier is not supported in real-time alert searches. | ||
| ## Deprecation timeline | ||
|
|
||
| ### Operator limitations | ||
| | Date | Change | | ||
| |:-----|:-------| | ||
| | **May 29, 2024** | Creation of new Real-Time Scheduled Searches was disabled across all accounts. | | ||
| | **May 15, 2025** | Scheduled removal of real-time frequency was canceled. Existing Real-Time Scheduled Searches continue operating without change. | | ||
|
|
||
| * Some queries cannot be used in real-time alerts searches. Other operators can be used in real-time search, but in the search, they must be included after the first "group-by" phrase: | ||
| Real-Time Scheduled Searches are considered a legacy feature. Any edits or new creations must use Monitors instead. | ||
|
|
||
| | Not supported for real-time alerts | Must be added after a "group by" phrase | | ||
| | :-- | :-- | | ||
| | <ul><li>Count_frequent</li><li>Details</li><li>First, Last - instead use the withtime option, see [`most_recent` and `least_recent`](/docs/search/search-query-language/group-aggregate-operators/most-recent-least-recent).</li><li>LogReduce</li><li>Now()</li><li>Outlier will omit the first N (window size) data points in results because those data points are used in the training phase.</li><li>Join</li><li>Parse using</li><li>queryStartTime()</li><li>queryEndTime()</li><li>Save</li><li>Sessionize</li><li>Subquery</li><li>Threat Intel</li><li>Trace</li><li>Timeslice greater than 1 day</li><li>Transactionize</li></ul> | <ul><li>Accum</li><li>Backshift</li><li>Diff</li><li>Join</li><li>Limit</li><li>RollingStd</li><li>Smooth</li><li>Sort</li><li>Top</li><li>Total</li><li>Transaction By Flow</li><li>Compare With can be used when your query's aggregate operation is grouped by a [`timeslice`](/docs/search/search-query-language/search-operators/timeslice).</li></ul> | | ||
| ## Why is this happening? | ||
|
|
||
| * Real-time queries using [Time Compare](/docs/search/time-compare) need to have at least three timeslices within its time range. For example, if the time range is 10 minutes, your timeslices need to be no longer than 3 minutes so that there are at least three of them. | ||
| Monitors offer significant improvements over Real-Time Scheduled Searches, including: | ||
|
|
||
| ## Viewing existing real-time alerts | ||
| * [Multiple trigger conditions](/docs/alerts/monitors/create-monitor/#step-1-set-trigger-conditions) (Critical, Warning, Missing Data) | ||
| * [Alert grouping](/docs/alerts/monitors/alert-grouping/) | ||
| * [Playbook support](/docs/alerts/monitors/alert-response/#alert-details) | ||
| * [AI-driven alerting](/release-notes-service/2024/12/31/#march-12-2024-alerts) | ||
| * [Integration with the Alert Response page](/docs/alerts/monitors/alert-response/) | ||
|
|
||
| - Navigate to the **Alerts** section in your Sumo Logic dashboard. | ||
| - Use the search functionality to locate existing real-time alerts. | ||
| Monitors are the strategic focus for our future alerting development and enhancements. | ||
|
|
||
| ## Editing existing real-time alerts | ||
| ## What should I do? | ||
|
|
||
| - Click on the real-time alert you wish to edit. | ||
| - Make necessary changes to the alert parameters (such as conditions or notification settings). | ||
| - Save your changes to update the alert. | ||
| * For new real-time alerting needs, use Monitors. | ||
| * If you have existing Real-Time Scheduled Searches, they will continue functioning without changes for now. | ||
| * Edits to existing Real-Time Scheduled Searches are possible, but you cannot create new ones. | ||
|
|
||
| ## Deleting existing real-time alerts | ||
|
|
||
| - Select the real-time alert you want to delete. | ||
| - Click the **Delete** button and confirm the deletion. | ||
|
|
||
| ## Alternatives to real-time alerts | ||
| :::note Can I import a scheduled search into a monitor? | ||
| No. Because the JSON formatting of Scheduled Searches differs from monitors, you’ll need to manually recreate it as a Monitor from the Search UI for your real-time use cases. | ||
| ::: | ||
|
|
||
| Since the creation of new real-time alerts is deprecated, we recommend using monitors to achieve similar functionality. | ||
| If you have any questions, reach out to your account team or open a [Support ticket](https://support.sumologic.com/support/s/). | ||
This file was deleted.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.