Skip to content

Commit f83da5a

Browse files
committed
Images in manage
1 parent 58ce3cb commit f83da5a

File tree

19 files changed

+79
-94
lines changed

19 files changed

+79
-94
lines changed

docs/manage/content-sharing/changing-alerts.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -21,32 +21,18 @@ If you're using a search template with your saved search, you cannot modify the
2121
To edit an alert:
2222

2323
1. Go to the Sumo Logic library by clicking the folder icon in the main Sumo Logic menu: <img src={useBaseUrl('img/reuse/library-icon.png')} alt="Library icon" style={{border: '1px solid gray'}} width="30" />
24-
2524
1. Click in the search area to display a list of library object types, and choose **Scheduled Searches**
26-
27-
1. Select the edit icon in the library for the scheduled search you'd like to edit. 
28-
29-
![EditAlert.png](/img/content-sharing/EditAlert.png)
30-
31-
1. Click **Edit this search's schedule**.
32-
33-
![edit-search-schedule](/img/content-sharing/edit-search-schedule.png)
34-
35-
1. Modify the frequency, time range, and alert type as needed.
36-
37-
![EditAlert3.png](/img/content-sharing/EditAlert3.png)
38-
25+
1. Select the edit icon in the library for the scheduled search you'd like to edit.<br/><img src={useBaseUrl('img/content-sharing/EditAlert.png')} alt="Select the edit icon in the library" style={{border: '1px solid gray'}} width="800" />
26+
1. Click **Edit this search's schedule**.<br/><img src={useBaseUrl('img/content-sharing/edit-search-schedule.png')} alt="Edit search schedule" style={{border: '1px solid gray'}} width="600" />
27+
1. Modify the frequency, time range, and alert type as needed.<br/><img src={useBaseUrl('img/content-sharing/EditAlert3.png')} alt="Modify the alert" style={{border: '1px solid gray'}} width="600" />
3928
1. Click **Update** to save your changes.
4029

4130
## Cancel alerts on a shared search
4231

4332
If you have Edit permissions on the shared search, you can stop recipients from receiving alerts by setting the run frequency to **Never**. We recommend doing this when a search is no longer relevant rather than deleting the search so that it can be available to you later if you need it. Deleting the shared search is possible, if you have Manage permissions, but does not allow you the ability to restore a scheduled search later if you need it.
4433

4534
1. Navigate to the scheduled search you want to edit, as described above in [Edit an alert](#edit-an-alert).
46-
1. Select the edit icon in the library for the scheduled search.
47-
48-
![EditAlert.png](/img/content-sharing/EditAlert.png)
49-
35+
1. Select the edit icon in the library for the scheduled search.<br/><img src={useBaseUrl('img/content-sharing/EditAlert.png')} alt="Select the edit icon in the library" style={{border: '1px solid gray'}} width="800" />
5036
1. In the **Edit Search** dialog, click **Edit this search's schedule**.
5137
1. From the **Run Frequency** menu, choose **Never** to cancel the scheduled search.
5238
1. Click **Update** to save your changes.

docs/manage/content-sharing/index.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,8 @@ To find content in the library that has been shared with you, click the clock i
4141

4242
To share content from the left navigation bar or the library:
4343

44-
1. Click the details icon ![details](/img/content-sharing/details.png) for the content you want to share.
45-
1. Select **Share** from the dropdown menu.
46-
47-
<img src={useBaseUrl('img/content-sharing/share-search.png')} alt="Share search" width="150"/>
44+
1. Click the details icon <img src={useBaseUrl('img/content-sharing/details.png')} alt="Details icon" style={{border: '1px solid gray'}} width="20" /> for the content you want to share.
45+
1. Select **Share** from the dropdown menu.<br/><img src={useBaseUrl('img/content-sharing/share-search.png')} alt="Share search" width="150"/>
4846

4947
:::note
5048
* The **Share** option appears on the dropdown menu only if you have permissions to grant access. See [Available permission levels](#available-permission-levels).

docs/manage/data-archiving/archive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ Click on a table row to view the Source details. This includes:
184184
* **Description**
185185
* **AWS S3 bucket**
186186
* All **Ingestion jobs** that are and have been created on the Source.
187-
* Each ingestion job shows the name, time window, and volume of data processed by the job. Click the icon ![open in search icon.png](/img/archive/open-search-icon.png) to the right of the job name to start a Search against the data that was ingested by the job.
187+
* Each ingestion job shows the name, time window, and volume of data processed by the job. Click the icon <img src={useBaseUrl('img/archive/open-search-icon.png')} alt="Open in search icon" width="30" /> to the right of the job name to start a Search against the data that was ingested by the job.
188188
* Hover your mouse over the information icon to view who created the job and when.<br/><img src={useBaseUrl('img/archive/archive-details-pane.png')} alt="Archive details pane" width="325"/>
189189

190190
## Create an ingestion job

docs/manage/field-extractions/create-field-extraction-rule.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ title: Create a Field Extraction Rule
44
description: Field Extraction Rules (FER) tell Sumo Logic which fields to parse out automatically.
55
---
66

7+
import useBaseUrl from '@docusaurus/useBaseUrl';
78
import Iframe from 'react-iframe';
89
import FerLimit from '../../reuse/fer-limitations.md';
910

@@ -47,7 +48,7 @@ To create a Field Extraction Rule:
4748

4849
1. [**New UI**](/docs/get-started/sumo-logic-ui). To access the Field Extraction Rules page, in the main Sumo Logic menu select **Data Management**, and then under **Logs** select **Field Extraction Rules**. You can also click the **Go To...** menu at the top of the screen and select **Field Extraction Rules**. <br/>[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Field Extraction Rules**.
4950
1. Click the **+ Add** button on the top right of the table.
50-
1. The **Add Field Extraction Rule** form will appear:<br/> ![Create Field extraction rule with dynamic parsing.png](/img/field-extraction-rules/create-fer.png)
51+
1. The **Add Field Extraction Rule** form will appear:<br/><img src={useBaseUrl('img/field-extraction-rules/create-fer.png')} alt="Create Field extraction rule with dynamic parsing" style={{border: '1px solid gray'}} width="400" />
5152
1. Enter the following options:
5253
* **Rule Name**. Type a name that makes it easy to identify the rule.
5354
* **Applied At**. There are two types available, Ingest Time and Run Time. The main differences are Run Time only supports JSON data and the time that Sumo parses the fields. The following is an overview of the differences:

docs/manage/field-extractions/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The Field Extraction Rules page displays the following information: 
3333

3434
When hovering over a row in the table there are icons that appear on the far right for editing, disabling and deleting the rule.
3535

36-
* **Status** shows a checkmark in a green circle ![check in green circle.png](/img/reuse/green-check-circle.png) to indicate if the Rule is actively being applied or an exclamation mark in a red circle ![exclamation in red circle.png](/img/reuse/exclamation-red-circle.png) to indicate if the Rule is disabled.
36+
* **Status** shows a checkmark in a green circle <img src={useBaseUrl('img/reuse/green-check-circle.png')} alt="Check in green circle" width="20" /> to indicate if the Rule is actively being applied or an exclamation mark in a red circle <img src={useBaseUrl('img/reuse/exclamation-red-circle.png')} alt="Exclamation in red circl" width="20" /> to indicate if the Rule is disabled.
3737
* **Rule Name**
3838
* **Applied At** indicates when the field extraction process occurs, either at Ingest or Run time.
3939
* **Scope** 

docs/manage/fields.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -86,13 +86,13 @@ Fields can be assigned to a Collector and Source using the **Fields** input ta
8686

8787
1. Click **Save**.
8888

89-
![edit collector fields name.png](/img/fields/edit-collector-fields-name.png)
89+
<img src={useBaseUrl('img/fields/edit-collector-fields-name.png')} alt="Edit collector fields name" style={{border: '1px solid gray'}} width="600" />
9090

9191
In the above example, we have created a new field called `cluster` and set the value to `k8s.dev`. With this configuration, any logs sent to this Collector will now have this key-value pair associated with it.
9292

9393
With this association, you can search for `cluster=k8s.dev` to return your logs.
9494

95-
![collector field search results.png](/img/fields/collector-field-search-results.png)
95+
<img src={useBaseUrl('img/fields/collector-field-search-results.png')} alt="Collector field search results" style={{border: '1px solid gray'}} width="800" />
9696

9797
### Using Collector API
9898

@@ -181,7 +181,7 @@ curl -v -X POST -H 'X-Sumo-Fields:environment=dev,cluster=k8s' -T /file.txt <HTT
181181

182182
When creating or editing your HTTP Source that will receive log data add the field `_convertHeadersToFields` with a value of `true`. This field needs to be added to your Fields schema to work.
183183

184-
![convertHeadersToFields.png](/img/fields/convertHeadersToFields.png)
184+
<img src={useBaseUrl('img/fields/convertHeadersToFields.png')} alt="Convert headers to fields" style={{border: '1px solid gray'}} width="500" />
185185

186186
With this field set on your Source, headers are processed as metadata fields. For example, a cURL command posting data with custom fields would look like:
187187

@@ -235,7 +235,7 @@ You need the **Manage Fields** [role capability](users-roles/roles/role-capab
235235

236236
The Fields page displays the following information: 
237237

238-
* **Status** shows a checkmark in a green circle <img src={useBaseUrl('img/reuse/green-check-circle.png')} alt="green check circle.png" width="20"/> to indicate if the field is actively being applied or an exclamation mark in a red circle ![red-exclamation-circle.png](/img/fields/red-exclamation-circle.png) to indicate if the field is disabled and being dropped.
238+
* **Status** shows a checkmark in a green circle <img src={useBaseUrl('img/reuse/green-check-circle.png')} alt="green check circle.png" width="20"/> to indicate if the field is actively being applied or an exclamation mark in a red circle <img src={useBaseUrl('img/fields/red-exclamation-circle.png')} alt="Red exclamation circle" width="20" /> to indicate if the field is disabled and being dropped.
239239
* **Field Name** is the name of the field, known as the key in the key-value pair.
240240
* **Data Type** shows the data type of the field.
241241
* **Field Extraction Rules** shows the number of Field Extraction Rules that reference the field.
@@ -263,16 +263,14 @@ When hovering over a row in the table there are icons that appear on the far ri
263263

264264
For the fields listed, select a row to view its details. A details pane appears to the right of the table where you can disable and delete the field.<br/><img src={useBaseUrl('/img/fields/selected-field-details-pane.png')} alt="Manage Fields" style={{border:'1px solid gray'}} width="450"/>
265265

266-
![selected field details pane.png](/img/fields/selected-field-details-pane.png)
267-
268266
#### Add field
269267

270268
Adding a field will define it in the Fields schema allowing it to be assigned as metadata to your logs.
271269

272270
1. Click the **+ Add** button on the top right of the table. A panel named **Add Field** appears to the right of the fields table.
273271
1. Input a field name and click **Save**.
274272

275-
![add field input.png](/img/fields/add-field-input.png)
273+
<img src={useBaseUrl('img/fields/add-field-input.png')} alt="Add field input" style={{border: '1px solid gray'}} width="400" />
276274

277275
#### Disable field
278276

@@ -290,15 +288,15 @@ In the details pane of the field, click the **Disable** button.<br/><img src={u
290288
Deleting a field does not delete historical data assigned with that field. If you delete a field by mistake and one or more of those dependencies break, you can re-add the field to get things working properly again. You should always disable a field and ensure things are behaving as expected before deleting a field.
291289
:::
292290

293-
Select the **Delete** button in the details pane of the field. To delete a field you need to remove any references to it from some features. If the field is used by any of the following
291+
Select the **Delete** button in the details pane of the field. To delete a field you need to remove any references to it from some features if the field is used by any of the following:
294292

295293
* Field Extraction Rule
296294
* Role
297295
* Partition
298296
* Collector
299297
* Source
300298

301-
<br/><img src={useBaseUrl('/img/fields/delete-icon.png')} alt="delete-icon" style={{border:'1px solid gray'}} width="450"/>
299+
<img src={useBaseUrl('/img/fields/delete-icon.png')} alt="delete-icon" style={{border:'1px solid gray'}} width="300"/>
302300

303301
You will see the following prompt and you must remove the field reference before you can delete it.
304302

@@ -308,11 +306,11 @@ Built-in fields cannot be deleted.
308306

309307
For example, if the field is used by a Field Extraction Rule, you must first delete the Field Extraction Rule before you can delete the field.
310308

311-
![field cannot delete.png](/img/fields/field-cannot-delete.png)
309+
<img src={useBaseUrl('img/fields/field-cannot-delete.png')} alt="Field cannot delete" style={{border: '1px solid gray'}} width="400>" />
312310

313311
If the field is not used by those features you will see the following prompt.
314312

315-
![delete field confirm.png](/img/fields/delete-field-confirm.png)
313+
<img src={useBaseUrl('img/fields/delete-field-confirm.png')} alt="Delete field confirm" style={{border: '1px solid gray'}} width="400" />
316314

317315
#### View dropped fields
318316

docs/manage/health-events.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ title: Health Events
44
description: Monitor the health of your Collectors and Sources.
55
---
66

7+
import useBaseUrl from '@docusaurus/useBaseUrl';
8+
79
## Availability
810

911
| Account Type | Account Level |
@@ -40,11 +42,11 @@ On the health events table, you can search, filter, and sort incidents by ke
4042

4143
[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). To access the health events table, in the main Sumo Logic menu select **Manage Data > Monitoring > Health Events**.
4244

43-
![health events table.png](/img/health-events/health-events-table.png)
45+
<img src={useBaseUrl('img/health-events/health-events-table.png')} alt="Health events tabl" style={{border: '1px solid gray'}} width="800" />
4446

4547
Click on a row to view the details of a health event.
4648

47-
![health event detail.png](/img/health-events/health-event-detail.png)
49+
<img src={useBaseUrl('img/health-events/health-event-detail.png')} alt="Health event detail" style={{border: '1px solid gray'}} width="400" />
4850

4951
Click the **Create Scheduled Search** button on the details pane to get alerts for specific health events. The unique identifier of the resource, such as the Source or Collector, is used in the query. See [Schedule a Search](../alerts/scheduled-searches/schedule-search.md) for details.
5052

@@ -57,8 +59,8 @@ Under the **More Actions** menu you can select:
5759

5860
Events are categorized by two severity levels, warning and error. The severity column has color-coded error and warning events so you can quickly determine the severity of a given issue.
5961

60-
* ![warning label.png](/img/health-events/warning-label.png) A warning indicates the Collector or Source has a configuration issue or is operating in a degraded state.
61-
* ![Error label.png](/img/health-events/Error-label.png) An error indicates the Collector or Source is unable to collect data as expected.
62+
* <img src={useBaseUrl('img/health-events/warning-label.png')} alt="Warning label" style={{border: '1px solid gray'}} width="75" /> A warning indicates the Collector or Source has a configuration issue or is operating in a degraded state.
63+
* <img src={useBaseUrl('img/health-events/Error-label.png')} alt="Error label" style={{border: '1px solid gray'}} width="50" /> An error indicates the Collector or Source is unable to collect data as expected.
6264

6365
### Common parameters
6466

@@ -138,12 +140,7 @@ A **Health** column on the Collection page shows color-coded healthy, error, a
138140

139141
The **status** column now shows the status of Sources manually paused by users.
140142

141-
![Collection health column.png](/img/health-events/Collection-health-column.png)
142-
143-
* Hover your mouse over a Collector or Source to view a tooltip that provides the number of health events detected on the Collector or Source.
144-
145-
![health tooltip.png](/img/health-events/health_tooltip.png)
146-
147-
* Click on the **Health** status in a row to view a pop-up displaying a list of related events.
143+
<img src={useBaseUrl('img/health-events/Collection-health-column.png')} alt="Collection health column" style={{border: '1px solid gray'}} width="800" />
148144

149-
![object event details.png](/img/health-events/object_event_details.png)
145+
* Hover your mouse over a Collector or Source to view a tooltip that provides the number of health events detected on the Collector or Source.<br/><img src={useBaseUrl('img/health-events/health_tooltip.png')} alt="Health tooltip" style={{border: '1px solid gray'}} width="150" />
146+
* Click on the **Health** status in a row to view a pop-up displaying a list of related events.<br/><img src={useBaseUrl('img/health-events/object_event_details.png')} alt="Object event details" style={{border: '1px solid gray'}} width="500" />

docs/manage/ingestion-volume/collection-status-page.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ title: Collection Status Page
44
description: Provides a visual snapshot of the message history for your deployment, and a message volume histogram for each Collector.
55
---
66

7+
import useBaseUrl from '@docusaurus/useBaseUrl';
78

89
The Status page provides a message volume history for your account, as well as a message volume histogram for each Collector, giving you immediate visual feedback about traffic spikes or collection issues. To see statistics for any bar in the histogram, hover your mouse pointer over the area of interest.
910

1011
When you first install a Collector it is common to configure Sources to collect some historical data, rather than from the moment of installation. In this case, the status page shows a spike in message volume and then levels out as collection reaches a steady state. For example, a local log file can contain millions of log messages. When the Collector is initialized, it quickly gathers all those logs and sends them to Sumo Logic resulting in a traffic spike. After the initial collection, the Collector continues to tail the file, reading from the end of the file as new entries are created, and sends a smaller number of new log messages.
1112

12-
![Status tab](/img/manage/ingestion-volume/collection-status.png)
13+
<img src={useBaseUrl('img/manage/ingestion-volume/collection-status.png')} alt="Status tab" style={{border: '1px solid gray'}} width="800" />
1314

1415
* **A.** Select to show all, running, or stopped Collectors.
1516
* **B.** Select how many columns of Collectors are displayed.

docs/manage/ingestion-volume/data-volume-index/log-tracing-data-volume-index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ title: Log and Tracing Data Volume Index
44
description: The Data Volume Index is populated with a set of log messages that contain information on how much data (by bytes and messages count) your account is ingesting.
55
---
66

7+
import useBaseUrl from '@docusaurus/useBaseUrl';
8+
79
The data volume index is populated with a set of log messages every five minutes. The messages contain information on how much data (by bytes and messages count) your account is ingesting. Your data volume is calculated based on when your logs were received, in Sumo this timestamp is stored with the `_receiptTime` [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field. Each log message includes information based on one of the following index source categories.
810

911
| Index Log Type | Index Source Category |
@@ -97,7 +99,7 @@ _index=sumologic_volume _sourceCategory = "sourcecategory_and_tier_volume"
9799

98100
would produce results such as:
99101

100-
![clipboard_e08593bedbf920dea82726b15964e56f6.png](/img/manage/ingestion-volume/volume-each-category.png)
102+
<img src={useBaseUrl('img/manage/ingestion-volume/volume-each-category.png')} alt="Volume for each category" style={{border: '1px solid gray'}} width="500" />
101103

102104
**Volume for Each Collector by Tier**
103105

@@ -223,7 +225,7 @@ _index=sumologic_volume _sourceCategory="sourcecategory_tracing_volume"
223225
224226
This query produces results like these: 
225227
226-
![tracing-volume-source-category](/img/manage/ingestion-volume/tracing-volume-source-category.png)
228+
<img src={useBaseUrl('img/manage/ingestion-volume/tracing-volume-source-category.png')} alt="Tracing volume source category" style={{border: '1px solid gray'}} width="400" />
227229
228230
#### Tracing volume by collector
229231
@@ -238,7 +240,7 @@ _index=sumologic_volume _sourceCategory="collector_tracing_volume"
238240

239241
This query produces results like these:
240242

241-
![image](/img/manage/ingestion-volume/tracing-volume-source-category.png)
243+
<img src={useBaseUrl('img/manage/ingestion-volume/tracing-volume-source-category.png')} alt="Tracing volume by collector" style={{border: '1px solid gray'}} width="400" />
242244

243245
#### Tracing volume for a specific collector
244246

0 commit comments

Comments
 (0)