Skip to content

Commit

Permalink
Replace the checks icon (advisors)
Browse files Browse the repository at this point in the history
  • Loading branch information
ademidoff committed Feb 7, 2025
1 parent 8c339a8 commit 9ebc939
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion documentation/WRITERS-NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ Note: the following list is WIP and will be updated as we go along.
| :material-cog: | Cog wheel | PMM UI Configuration |
| :material-clipboard-list-outline: | Clipboard list | PMM UI - Inventory |
| :material-dots-horizontal: | Triple dots, aligned horizontally | PMM UI - Backup in progress |
| :material-magnify-expand: | Advisors | PMM UI - Advisors |
| <i class="uil uil-comment-alt-share"></i> | Share comment symbol | PMM UI - Share dashboard image |
| <i class="uil uil-compass"></i> | Compass | PMM UI - Explore |
| <i class="uil uil-copy"></i> | Copy | PMM UI - Copy (e.g. backup schedule) |
Expand Down Expand Up @@ -191,7 +192,6 @@ Custom (in-house design) icons are defined as SVG code in `variables.yml`.

| Usage | Description | Used where |
| ---------------------- | ------------------------------------ | -------------------------------- |
| `{{icon.checks}}` | Checkbox list items | Inventory list |
| `{{icon.dashboards}}` | Abstract blocks assembly | PMM Dashboards |
| `{{icon.node}}` | Circle surrounded by smaller circles | Node dashboards |
| `{{icon.percona}}` | Percona logo | Wherever PMM home icon is needed |
Expand Down
10 changes: 5 additions & 5 deletions documentation/docs/advisors/advisors.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ You can change the standard 24-hour interval to a custom frequency for each Advi
To change the frequency of an automatic check:
{.power-number}

1. Click **{{icon.checks}} Advisors**.
1. Click :material-magnify-expand: **Advisors**.
2. Select the Advisor tab that contains the check for which you want to change the frequency.
3. Expand the relevant Advisor and scroll through the list to find your check. Alternatively, use the **Filter** section at the top of the table to search checks by Name, Description, Status, or Interval.

!!! hint alert alert-success "Tip"
If you need to share filtered Advisor results with your team members, send them the PMM URL. This saves your search criteria and results.
4. Click the ![Edit](../images/edit.png) **Interval** icon in the **Actions** column, next to the check you want to update.
4. Click the :material-pencil-box-outline: **Interval** icon in the **Actions** column, next to the check you want to update.
5. Chose an interval and click **Save**.

## Manual checks
Expand All @@ -54,7 +54,7 @@ In addition to the automatic checks that run every 24 hours, you can also run ch
To run checks manually:
{.power-number}

1. Click **{{icon.checks}} Advisors** on the main menu.
1. Click :material-magnify-expand: **Advisors** on the main menu.
2. Select the Advisor tab that contains the checks which you want to run manually.
3. Click **Run checks** to run all the available checks for this Advisor group, or expand an Advisor and click **Run** next to each check that you want to run individually.
![!Actions options](../images/PMM_Checks_Actions.png)
Expand All @@ -69,9 +69,9 @@ The results are sent to PMM Server where you can review any failed checks on the

![!Failed Advisor Checks panel](../images/HomeDashboard.png)

To see more details about the available checks and any checks that failed, click the *{{icon.checks}} Advisors* icon on the main menu.
To see more details about the available checks and any checks that failed, click the :material-magnify-expand: *Advisors* icon on the main menu.

**Check results data *always* remains on the PMM Server.** This is not related to anonymous data sent for Telemetry purposes.
Note: Check results *always* remain on the PMM Server. They are never sent as part of Telemetry.

## Create your own Advisors
PMM Advisors offer a set of checks that can detect common security threats, performance degradation, data loss and data corruption.
Expand Down
Binary file removed documentation/docs/images/edit.png
Binary file not shown.

0 comments on commit 9ebc939

Please sign in to comment.