You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/nrql/using-nrql/schedule-nrql-searches.mdx
+32-39Lines changed: 32 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,37 +44,35 @@ To use scheduled NRQL searches, you need:
44
44
Scheduled NRQL searches are built on New Relic's Workflow Automation infrastructure. Your organization needs appropriate permissions to create and manage workflows.
45
45
</Callout>
46
46
47
-
## Access scheduled searches [#access]
48
47
49
-
To access scheduled NRQL searches:
50
-
51
-
1. Go to **[one.newrelic.com](https://one.newrelic.com) > Administration**.
52
-
2. In the left navigation, select <DNT>**Scheduled searches**</DNT>.
53
-
54
-
When you first visit this page, you'll see an empty state with the option to **Schedule a search**.
48
+
1. .
49
+
2. In the left navigation, select <DNT>**Scheduled Searches**</DNT>.
55
50
56
51
## Schedule a new search [#create-schedule]
57
52
58
53
To schedule a new automated NRQL search:
59
54
60
55
<Steps>
61
56
<Step>
62
-
From the <DNT>**Scheduled searches**</DNT> page, click **Schedule a search** to open the configuration modal.
57
+
**Access scheduled searches**:
58
+
59
+
1. Go to **[one.newrelic.com](https://one.newrelic.com) > Administration > Scheduled Searches**.
60
+
2. To configure a new search, from the <DNT>**Scheduled Searches**</DNT> page, click **Schedule a search**.
63
61
</Step>
64
62
<Step>
65
63
**Configure your query**:
66
64
67
-
1.Draft your NRQL query using standard NRQL syntax.
65
+
1.On the configuration modal, draft your NRQL query using standard NRQL syntax.
68
66
2. Test your query to ensure it returns the expected results.
69
-
3.Continue to configure the notification settings.
67
+
3.To set up notification settings for the scheduled search, click **Continue**.
70
68
71
69
</Step>
72
70
<Step>
73
-
**Configure notification**:
71
+
**Set up notification**:
74
72
75
-
* Enter a **Name** for your scheduled search.
76
-
* Add an optional **Description** to help identify the search purpose.
77
-
* Set a [destination](/docs/alerts/get-notified/destinations/) to receive the query results. Currently, you can only send results to email destinations.
73
+
1. Enter a name for your scheduled search.
74
+
2. Add an optional description to help identify the search purpose.
75
+
3. Set a [destination](/docs/alerts/get-notified/destinations/) to receive the query results. Currently, you can only send results to email destinations.
78
76
79
77
<CollapserGroup>
80
78
<Collapser
@@ -88,33 +86,42 @@ From the <DNT>**Scheduled searches**</DNT> page, click **Schedule a search** to
88
86
id="new-destination"
89
87
title="Add a new destination"
90
88
>
91
-
To create a new destination:
89
+
Click <DNT>**+ Add destination**</DNT> and perform the following steps on the opened modal:
92
90
93
-
1. On the <DNT>**Add a destination**</DNT> page, search and add recipients by email ID or username.
94
-
2. Enter a unique name for the destination and save.
95
-
3. New email recipients receive a verification email and must verify before receiving notifications.
91
+
1. Click <DNT>**+ Add email**</DNT>, search recipients by email ID or username, and add them.
92
+
2. Enter a unique name for the destination and save.
93
+
94
+
The new destination is added to the list of available destinations in the notification setup modal. To edit the destination, select the <Iconname="fe-more-horizontal"/> menu. You can disable the destination when you edit it.
96
95
</Collapser>
97
96
</CollapserGroup>
98
97
99
-
* Enter a subject and message body for the email notification.
100
-
* From the <DNT>**Include**</DNT> dropdown, select a query result format you want to include in the email.
98
+
4. Enter a subject and message body for the email notification.
99
+
5. Select a query result format you want to include in the email.
100
+
6. To set a schedule for the email notifications, click **Continue**.
101
101
102
102
</Step>
103
103
<Step>
104
104
**Set a schedule**:
105
105
106
-
After configuring your email notification settings, continue to set a schedule for your search as follows:
106
+
Currently it supports only Cron expressions. Following are some common cron expression patterns for reference. Enter a cron expression and click <DNT>**Continue**</DNT>.
107
+
108
+
*`0 * * * *` - Every hour at the top of the hour
109
+
*`0 9 * * *` - Every day at 9:00 AM
110
+
*`0 9 * * 1` - Every Monday at 9:00 AM
111
+
*`0 0 1 * *` - First day of every month at midnight
112
+
*`*/15 * * * *` - Every 15 minutes
113
+
*`0 9 * * 1-5` - Every weekday at 9:00 AM
107
114
108
-
1. Choose a frequency for your search (e.g., hourly, daily, weekly, or [Cron expression](#cron-examples)).
115
+
{/*1. Choose a frequency for your search (e.g., hourly, daily, weekly, or [Cron expression](#cron-examples)).
109
116
2. Set the start time for your search with the time zone.
110
117
3. Define the **Start time** and **End time** for the search.
111
118
4. Choose one of the following conditions to send the notification:
112
119
* <DNT>**On every run**</DNT>: Receive a notification every time the search runs.
113
-
* <DNT>**On result count > 0**</DNT>: Receive a notification only when the search returns results.
120
+
* <DNT>**On result count > 0**</DNT>: Receive a notification only when the search returns results.*/}
114
121
</Step>
115
122
<Step>
116
-
**Reviewand confirm**:
117
-
After setting your schedule and notification preferences, continue to review your configuration. If you need to make further adjustments, switch back to the relevant step. After finalizing your configuration, click <DNT>**Schedule**</DNT> to create your automated search. The <DNT>**Scheduled searches**</DNT> page will display your new search in the list.
123
+
**Review, confirm, and schedule the search**:
124
+
Review your configuration. If you need to make further adjustments, switch back to the relevant step. After finalizing your configuration, click <DNT>**Schedule**</DNT> to create your automated search. The <DNT>**Scheduled searches**</DNT> page will display your new search in the list.
118
125
</Step>
119
126
</Steps>
120
127
@@ -126,20 +133,6 @@ The <DNT>**Scheduled searches**</DNT> page in the Administration UI displays all
126
133
***Delete a search**.
127
134
***Duplicate a search** and update it to create a new search.
128
135
129
-
## Cron expression examples [#cron-examples]
130
-
131
-
Here are some common cron expression patterns for scheduled searches:
132
-
133
-
*`0 * * * *` - Every hour at the top of the hour
134
-
*`0 9 * * *` - Every day at 9:00 AM
135
-
*`0 9 * * 1` - Every Monday at 9:00 AM
136
-
*`0 0 1 * *` - First day of every month at midnight
137
-
*`*/15 * * * *` - Every 15 minutes
138
-
*`0 9 * * 1-5` - Every weekday at 9:00 AM
139
-
140
-
<Calloutvariant="tip">
141
-
When using cron expressions, remember that all times are interpreted in the time zone you select during configuration.
0 commit comments