Skip to content

Commit c20ae01

Browse files
authored
Create new article (#5830)
1 parent ef7f8f8 commit c20ae01

File tree

9 files changed

+70
-63
lines changed

9 files changed

+70
-63
lines changed

cid-redirects.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
"/01Start-Here/Library/Library_Filters": "/docs/get-started/library",
6060
"/01Start-Here/Library/Library-Keyboard-Shortcuts": "/docs/get-started/keyboard-shortcuts",
6161
"/01Start-Here/Library/Move-Content-Personal-Folder": "/docs/get-started/library",
62-
"/01Start-Here/Library/Pinned-Searches": "/docs/get-started/library",
62+
"/01Start-Here/Library/Pinned-Searches": "/docs/search/get-started-with-search/search-page/pin-a-search",
6363
"/01Start-Here/Library/Recent-Searches": "/docs/get-started/library",
6464
"/01Start-Here/Library/Search-the-Library": "/docs/get-started/library",
6565
"/01Start-Here/Library/Share-a-Saved-Search-from-the-Library": "/docs/get-started/library",
@@ -376,7 +376,7 @@
376376
"/05Search/Library/Export-and-Import-Content-in-the-Library": "/docs/get-started/library",
377377
"/05Search/Library/Favorites": "/docs/get-started/library",
378378
"/Search/Library/Library_Keyboard_Shortcuts": "/docs/get-started/keyboard-shortcuts",
379-
"/05Search/Library/Pinned-Searches": "/docs/get-started/library",
379+
"/05Search/Library/Pinned-Searches": "/docs/search/get-started-with-search/search-page/pin-a-search",
380380
"/05Search/Library/Share-a-Saved-Search-from-the-Library": "/docs/get-started/library",
381381
"/03Send-Data/Sources/03Use-JSON-to-Configure-Sources/Local-Configuration-File-Management/View-or-Download-Source-JSON-Configuration": "/docs/send-data/use-json-configure-sources/local-configuration-file-management/view-download-source-json-configuration",
382382
"/05Search/Anomaly-Detection/Anomalies-Page/Drill-Down-into-Events": "/docs/dashboards/drill-down-to-discover-root-causes",

docs/get-started/library.md

Lines changed: 2 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -179,63 +179,9 @@ The Home page lists all currently running searches and any searches performed ov
179179

180180
### Pinned searches
181181

182-
The **Pinned Search** feature allows you to start a search, then pin it, so it will continue running in the background independent of the browser session. Then, you can close the Search tab or log out and find your results later in the library on the [Recent](#recent-searches) tab in a folder named Pinned Searches.
182+
The *pinned search* feature allows you to start a search, then "pin" it, so it will continue running in the background independent of the browser session. Then, you can close the **Search** page or log out and find your results later.
183183

184-
Once pinned, a search will run in the background for up to 24 hours. If it has not finished by then, it will be paused. There is no notification when your search is paused, but you can just restart the search to continue the query. Search results are available for three days.
185-
186-
There is a limit of ten pinned searches per user. Also, queries that use the [save operator](/docs/search/search-query-language/search-operators/save) cannot be pinned.
187-
188-
A search must be started in order for the pin button to show up in the Search tab. Once a search is pinned, you can easily unpin it, or remove it from the Pinned Searches tab. In the Pinned Searches folder, you can view the **Name****Status****Elapsed Time**, and monitor the **Progress** of each search.
189-
190-
There is a known issue that may cause Pinned Searches to be lost when Sumo Logic performs an upgrade. For information on Scheduled Maintenance for your deployment, see [Sumo Logic Status](http://status.sumologic.com)
191-
192-
#### Pin and unpin a search
193-
194-
1. Enter a query in the search box and click **Start**.
195-
1. Click the three-dot kebab icon and click **Pin** from the provided options. <br/> <img src={useBaseUrl('img/get-started/library/pin-search-option.png')} alt="pin-search-option.png" width="325"/>
196-
1. A message displays that tells you where you can find it later in the library. The Pinned Search is named by default with the name of the search tab. <br/>![pinmessage.png](/img/get-started/library/pinmessage.png)
197-
1. To change the name of the pinned search, double-click the **Search** tab to activate the name field and enter a new name.
198-
1. To preserve the pinned search, follow the steps in Save a pinned search.
199-
1. To unpin the search, click **Unpin** in the menu bar. <br/><img src={useBaseUrl('img/get-started/library/unpin-search-option.png')} alt="pin-search-option.png" width="300"/>
200-
201-
#### Save a pinned search
202-
203-
When you save a pinned search, it appears in your personal folder in the left navigation bar.
204-
205-
1. Click the name of the search to open it in the **Search** tab.
206-
1. In the **Search** tab, click the three-vertical dot icon and click **Save As** from the provided options. The Save Item dialog appears.
207-
1. Enter a unique **Name** in the text field. In our example below, we entered Invoke Frequency.
208-
1. Optionally, enter a **Description**.
209-
1. Click **Save**. <br/>![Save_As_Search_dialog.png](/img/get-started/library/Save_As_Search_dialog.png)
210-
211-
The search is saved to your **Personal** folder.
212-
213-
#### Manage pinned searches
214-
215-
This section shows you how to open previously pinned searches, rename a pinned search, and remove a search from the pinned search list,
216-
217-
To open a previously pinned search:
218-
219-
1. In the **Pinned Searches** tab, click the name of the search.
220-
1. The search query and any existing results are displayed in the **Search** tab.
221-
1. To run a new instance of the search, change the Time Range Expression, and click **Start**.
222-
223-
To rename a pinned search:
224-
225-
1. In the **Pinned Searches** tab, click the name of the search.
226-
1. The search query and any existing results are displayed in the **Search** tab.
227-
1. Double-click the **Search** tab to reactivate the name field.
228-
1. Enter a new name and press **Enter**.
229-
230-
To remove a search from the pinned search List:
231-
232-
1. Hover over the search, then click the three-dot kebab menu icon to the right of the name.
233-
1. Click **Unpin**.
234-
1. In the **Confirm** dialog, click **OK**.
235-
236-
The search is removed from the list of Pinned Searches.
237-
238-
Removing an instance of a Saved Search from the list in the Pinned Searches tab does not delete the Saved Search from your Personal folder.
184+
For more information, see [Pin a Search](/docs/search/get-started-with-search/search-page/pin-a-search).
239185

240186
### Share a saved search from the library
241187

docs/get-started/sumo-logic-ui-classic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ To pin a search, do the following:
195195
1. A message appears telling you the location of your pinned search in the Library. The Pinned Search takes the name of the Search tab by default.<br/> ![pinmessage.png](/img/get-started/ui/pinmessage.png)
196196
1. To change the name of a Pinned Search, double-click the Search tab and enter a new name in the name field.
197197

198-
For information on how to manage pinned searches, see the [Pinned Searches](/docs/get-started/library#pinned-searches) page.
198+
For information on how to manage pinned searches, see [Pin a Search](/docs/search/get-started-with-search/search-page/pin-a-search).
199199

200200
### Manage your personal account preferences
201201

docs/get-started/sumo-logic-ui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ You must start a search for the **Pin** option to appear. To pin a search, do t
192192
193193
Once a search is pinned, it cannot be unpinned, but you can remove it from the **Pinned Searches** tab. You can pin up to 10 searches at a time. Queries that use the [`save` operator](/docs/search/search-query-language/search-operators/save) cannot be pinned.
194194
195-
For more information, see [Pinned Searches](/docs/get-started/library/#pinned-searches).
195+
For more information, see [Pin a Search](/docs/search/get-started-with-search/search-page/pin-a-search).
196196
197197
198198
## Administrator tasks

docs/search/get-started-with-search/build-search/best-practices-search.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Sumo provides two index-based search optimization features: partitions and sched
9191

9292
## Use Search Parameters
9393

94-
If your search contains filtering criteria that could change each time the search is executed, take advantage of [Search Templates](search-templates.md). Search templates make it easier for less expert users to obtain search results, and also reduces the risk that such users will run expensive searches.
94+
If your search contains filtering criteria that could change each time the search is executed, take advantage of [Search Templates](search-templates.md). Search templates make it easier for less expert users to obtain search results, and also reduces the risk that such users will run expensive searches.
9595

9696
## Aggregate before a lookup
9797

@@ -135,4 +135,4 @@ _sourceCategory=Apache/Access and GET
135135

136136
## Pin searches with long time ranges
137137

138-
A query with a longer time range can run past the default time window for Sumo Logic. To protect against an interruption in a query with a significant time range, [pin it](/docs/get-started/library#pinned-searches). A pinned search can run in the background for up to 24 hours.
138+
A query with a longer time range can run past the default time window for Sumo Logic. To protect against an interruption in a query with a significant time range, [pin it](/docs/search/get-started-with-search/search-page/pin-a-search). A pinned search can run in the background for up to 24 hours.

docs/search/get-started-with-search/search-page/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ You can [run a saved search](../search-basics/save-search.md), [pause, or stop
2020
| D | Click the gear icon to open the Search Config menu that has the options to use the [receipt time](../build-search/use-receipt-time.md) and [Auto Parse Mode](../build-search/dynamic-parsing.md). |
2121
| E | [Share a link](../search-basics/share-link-to-search.md) for the currently running search. |
2222
| F | [Save or schedule](../search-basics/save-search.md) a search. |
23-
| G | Click the three-dot kebab icon to open a menu with the following options:<ul><li>Select between Basic or Advanced search mode.</li><li>Link to [search cheat sheets](/docs/search/search-cheat-sheets).</li><li>Edit the search, if it has already been saved.</li><li>[Save or schedule](../search-basics/save-search.md) a search.</li><li>[Share a link](../search-basics/share-link-to-search.md) for the currently running search.</li><li>Info provides detailed information about the search.</li><li>[Pin](/docs/get-started/library#search-the-library) the search to run in the background independent of the browser session.</li><li>[Favorite](add-saved-search-to-favorites.md) a saved search.</li><li>[Add a new monitor](/docs/alerts/monitors) based on the existing query in the search text box.</li><li>Use [Live Tail](/docs/search/live-tail) to see a real-time live feed of log events.</li></ul>The menu options are dynamically provided so depending on if you have run or saved the search or conducted aggregation some options will be grayed out and unclickable. |
23+
| G | Click the three-dot kebab icon to open a menu with the following options:<ul><li>Select between Basic or Advanced search mode.</li><li>Link to [search cheat sheets](/docs/search/search-cheat-sheets).</li><li>Edit the search, if it has already been saved.</li><li>[Save or schedule](../search-basics/save-search.md) a search.</li><li>[Share a link](../search-basics/share-link-to-search.md) for the currently running search.</li><li>Info provides detailed information about the search.</li><li>[Pin](/docs/search/get-started-with-search/search-page/pin-a-search) the search to run in the background independent of the browser session.</li><li>[Favorite](add-saved-search-to-favorites.md) a saved search.</li><li>[Add a new monitor](/docs/alerts/monitors) based on the existing query in the search text box.</li><li>Use [Live Tail](/docs/search/live-tail) to see a real-time live feed of log events.</li></ul>The menu options are dynamically provided so depending on if you have run or saved the search or conducted aggregation some options will be grayed out and unclickable. |
2424
| H | [Histogram](navigate-through-search-results.md) of the messages. |
2525
| I | Search Details such as session, status, elapsed time, results, raw count, search expression, and [load](search-load-indicator.md). When searching an [Infrequent Partition](/docs/manage/partitions/data-tiers) the estimated and actual amount of data scanned is displayed. |
2626
| J | Search results as messages. |
@@ -58,6 +58,12 @@ In this section, we'll introduce the following concepts:
5858
<p>You can mark a saved search as a favorite so it appears in your Library.</p>
5959
</div>
6060
</div>
61+
<div className="box smallbox card">
62+
<div className="container">
63+
<a href="/docs/search/get-started-with-search/search-page/pin-a-search"><img src={useBaseUrl('img/icons/search.png')} alt="icon" width="40"/><h4>Pin a Search</h4></a>
64+
<p>You can pin a search so that it runs in the background independent of the browser session.</p>
65+
</div>
66+
</div>
6167
<div className="box smallbox card">
6268
<div className="container">
6369
<a href="/docs/search/get-started-with-search/search-page/change-time-range-in-histogram"><img src={useBaseUrl('img/icons/search.png')} alt="icon" width="40"/><h4>Change the Time Range in the Histogram</h4></a>
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
id: pin-a-search
3+
title: Pin a Search
4+
description: You can pin a search so that it runs in the background independent of the browser session.
5+
---
6+
7+
import useBaseUrl from '@docusaurus/useBaseUrl';
8+
9+
The *pinned search* feature allows you to start a search, then "pin" it, so it will continue running in the background independent of the browser session. Then, you can close the **Search** page or log out and find your results later. To see your pinned searches:
10+
* [**New UI**](/docs/get-started/sumo-logic-ui/). In the main Sumo Logic menu, select **Logs > Pinned searches**.
11+
* [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Recent > Pinned Searches**.
12+
13+
Once pinned, a search will run in the background for up to 24 hours. If it has not finished by then, it will be paused. There is no notification when your search is paused, but you can just restart the search to continue the query. Search results are available for three days. Once a search is pinned, you can easily unpin it, or remove it from the **Pinned searches** list.
14+
15+
Limitations:
16+
* There is a limit of ten pinned searches per user.
17+
* Queries that use the [save operator](/docs/search/search-query-language/search-operators/save) cannot be pinned.
18+
* There is a known issue that may cause pinned searches to be lost when Sumo Logic performs an upgrade. For information on scheduled maintenance for your deployment, see [Sumo Logic status](http://status.sumologic.com)
19+
20+
#### Pin and unpin a search
21+
22+
1. Enter a query in the search box and click **Start Search**.
23+
1. Click the three-dot kebab icon and click **Pin** from the provided options. <br/> <img src={useBaseUrl('img/get-started/library/pin-search-option.png')} alt="Pin menu option" style={{border: '1px solid gray'}} width="250"/>
24+
1. A message displays that tells you where you can find the pinned search later. The pinned search is named by default with the name of the search. <br/><img src={useBaseUrl('img/get-started/library/pinmessage.png')} alt="Pinned search message" style={{border: '1px solid gray'}} width="400" />
25+
1. To change the name of the pinned search, double-click the **Search** tab to activate the name field and enter a new name.
26+
1. To preserve the pinned search, follow the steps in [Save a pinned search](#save-a-pinned-search).
27+
1. To unpin the search, click **Unpin** in the menu bar. The search is removed from the **Pinned searches** list. (Removing an instance of a saved search from the **Pinned searches** list does not delete the saved search from your **Personal** folder.)<br/><img src={useBaseUrl('img/get-started/library/unpin-search-option.png')} alt="Unpin menu option" style={{border: '1px solid gray'}} width="200"/>
28+
29+
#### Save a pinned search
30+
31+
When you save a pinned search, it appears in your **Pinned searches** list.
32+
33+
1. Click the name of the search to open it in the **Search** tab.
34+
1. In the **Search** tab, click the three-vertical dot icon and click **Save As** from the provided options. The **Save Item** dialog appears.
35+
1. Enter a unique **Name** in the text field. In our example below, we entered "Invoke Frequency".
36+
1. Optionally, enter a **Description**.
37+
1. Click **Save**. <br/><img src={useBaseUrl('img/get-started/library/Save_As_Search_dialog.png')} alt="Save a search" style={{border: '1px solid gray'}} width="400" />
38+
39+
The search is saved to your **Personal** folder.
40+
41+
#### Manage pinned searches
42+
43+
To open a previously pinned search:
44+
45+
1. In the **Pinned searches** list, click the name of the search.
46+
1. The search query and any existing results are displayed in the **Search** tab.
47+
1. To run a new instance of the search, change the time range expression and click **Start Search**.
48+
49+
To rename a pinned search:
50+
51+
1. In the **Pinned searches** list, click the name of the search.
52+
1. The search query and any existing results are displayed in the **Search** tab.
53+
1. Double-click the **Search** tab to reactivate the name field.
54+
1. Enter a new name and press **Enter**.

sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1354,6 +1354,7 @@ module.exports = {
13541354
link: {type: 'doc', id: 'search/get-started-with-search/search-page/index'},
13551355
items: [
13561356
'search/get-started-with-search/search-page/add-saved-search-to-favorites',
1357+
'search/get-started-with-search/search-page/pin-a-search',
13571358
'search/get-started-with-search/search-page/change-time-range-in-histogram',
13581359
{
13591360
type: 'category',
10.8 KB
Loading

0 commit comments

Comments
 (0)