Skip to content

DOCS-1826 - Documentation for Email Notification - #7108

Open
JV0812 wants to merge 1 commit into
mainfrom
DOCS-1826
Open

DOCS-1826 - Documentation for Email Notification#7108
JV0812 wants to merge 1 commit into
mainfrom
DOCS-1826

Conversation

@JV0812

@JV0812 JV0812 commented Sep 8, 2026

Copy link
Copy Markdown
Collaborator

Purpose of this pull request

This pull request documents the new automatic background search prompt and completion email notification (epic SUMO-280038):

  • Added a new Run a slow search in the background automatically section to docs/search/get-started-with-search/search-page/pin-a-search.md, covering the banner shown when a log search's elapsed time exceeds ~1 minute, the resulting pinned search and confirmation message, and the completion email notification with a results link, including two screenshots
  • Documented the feature's caveats: logs-only (not metrics), suppressed at the 10-pinned-search limit, and suppressed during Emulate log search
  • Fixed heading levels across the page (H4 → H2), since the page had no H2/H3 hierarchy and jumped straight to H4 under the H1 title
  • Added a Service release note (blog-service/2026-09-10-search.md) linking directly to the new section

Select the type of change

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

https://sumologic.atlassian.net/browse/DOCS-1826

…ification

Add a new section to Pin a Search covering the banner that suggests
running a slow log search in the background, the resulting pinned
search and confirmation message, and the completion email notification,
with screenshots. Fix heading levels (H4 to H2) across the page, and
add a Service release note for the feature.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@JV0812 JV0812 self-assigned this Sep 8, 2026
@cla-bot cla-bot Bot added the cla-signed Contributor approved, listed in .clabot file label Sep 8, 2026
id: pin-a-search
title: Pin a Search
description: You can pin a search so that it runs in the background independent of the browser session.
description: You can pin a search, or let Sumo Logic prompt you automatically, so it runs in the background independent of the browser session, and get an email notification when it completes.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JV0812 the feature uses the pinned search functionality, but is not associated with it
both are independent of each other.

@saurabh-goyal-sumo

Copy link
Copy Markdown

Also we should mention that

  1. if the pinned searches limit is exceeded ( > 10 ), "Run in background" banner will not appear.

  2. Incase of search emulation, "Run in background" banner will not appear.

kimsauce

This comment was marked as outdated.

kimsauce

This comment was marked as outdated.

@kimsauce kimsauce left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small PR, mostly clean. Three inline notes on pin-a-search.md.

The H4 to H2 change is correct. Every other doc in search-page/ uses ## for top-level sections, so this page was the odd one out.

DOCS-78 (#7068) is also reworking this area, so whoever rebases it will need to pull in this new section.

(These points overlap my earlier top-level comment; treat this review as the canonical version.)

id: pin-a-search
title: Pin a Search
description: You can pin a search so that it runs in the background independent of the browser session.
description: You can pin a search, or let Sumo Logic prompt you automatically, so it runs in the background independent of the browser session, and get an email notification when it completes.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This runs ~180 characters across three clauses, so it gets cut off in search results. Something shorter, like: "Pin a search so it runs in the background independent of the browser session, or let Sumo Logic prompt you automatically and email you when it completes."


If a log search's elapsed time exceeds about one minute, a banner appears above the search results with the message "This search is taking longer than expected" and a **Run in Background** link.<br/><img src={useBaseUrl('img/search/get-started-search/search-page/run-search-in-background-banner.png')} alt="Banner suggesting you run a slow search in the background" style={{border: '1px solid gray'}} width="800" />

Click **Run in Background** to pin the search, the same as [pinning a search manually](#pin-andunpin-a-search). A message confirms where you can find the search later.<br/><img src={useBaseUrl('img/search/get-started-search/search-page/background-search-pinned-message.png')} alt="Message confirming your background search is available as a pinned search" style={{border: '1px solid gray'}} width="800" />

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#pin-andunpin-a-search is missing a hyphen. The heading above generates #pin-and-unpin-a-search, so this link lands nowhere.


Once pinned, the search appears in your **Pinned searches** list, and when it completes, you receive an email notification with a link to the results, so you don't need to keep the **Search** page open while you wait.

**Limitations:**

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The limitations list higher up the page uses a plain Limitations: with no bold. Match that here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed Contributor approved, listed in .clabot file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants