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: documentation/docs/admin/manage-users/edit_users.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,4 +45,4 @@ The following are the privileges for the various *roles*:
45
45
46
46
-**Viewer** - Viewing dashboards
47
47
48
-
For detailed information on the privileges for these roles and the different tasks that they can perform, see [Grafana organization roles](https://grafana.com/docs/grafana/latest/permissions/organization_roles/).
48
+
For detailed information on the privileges for these roles and the different tasks that they can perform, see [Grafana organization roles :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/permissions/organization_roles/){:target="_blank"}.
Copy file name to clipboardExpand all lines: documentation/docs/admin/roles/access-control/create_roles.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ To create access roles in PMM:
27
27
28
28
If you want to add more than one label for a role, click *+* and select the values from the drop-down.
29
29
30
-
For information on how the Prometheus selectors work, see [Prometheus selectors](https://prometheus.io/docs/prometheus/latest/querying/basics/#time-series-selectors).
30
+
For information on how the Prometheus selectors work, see [Prometheus selectors :octicons-link-external-16:](https://prometheus.io/docs/prometheus/latest/querying/basics/#time-series-selectors){:target="_blank"}.
31
31
32
32
6. Review your selections, then click **Create** to finalize the role.
Copy file name to clipboardExpand all lines: documentation/docs/admin/roles/access-control/labels.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,6 +63,6 @@ PMM allows modifying certain standard labels after a service is created:
63
63
64
64
For other standard labels that cannot be modified directly, you must remove the service and re-add it with the desired labels.
65
65
66
-
This can be done either via PMM UI or via an [API endpoint](https://percona-pmm.readme.io/reference/changeservice).
66
+
This can be done either via PMM UI or via an [API endpoint :octicons-link-external-16:](https://percona-pmm.readme.io/reference/changeservice){:target="_blank"}.
67
67
68
-
Modifying the custom labels can be done as well via PMM UI of via the same [API endpoint](https://percona-pmm.readme.io/reference/changeservice).
68
+
Modifying the custom labels can be done as well via PMM UI of via the same [API endpoint :octicons-link-external-16:](https://percona-pmm.readme.io/reference/changeservice){:target="_blank"}.
Copy file name to clipboardExpand all lines: documentation/docs/admin/roles/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ For more granular data access control, see [Labels for access control](../roles/
8
8
9
9
## Role types in PMM
10
10
11
-
PMM inherits its basic role structure from [Grafana](https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/) but with customizations specific to database monitoring. PMM has three main role types:
11
+
PMM inherits its basic role structure from [Grafana :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/){:target="_blank"} but with customizations specific to database monitoring. PMM has three main role types:
12
12
13
13
-**Admin**: Has access to all resources and features within a PMM instance. This role can manage all aspects of PMM including users, teams, data sources, dashboards, and server settings.
14
14
-**Editor**: Can view and edit dashboards, create custom visualizations, work with alerts, and manage specific configurations. Editors cannot modify server-wide settings or manage users.
Copy file name to clipboardExpand all lines: documentation/docs/admin/security/ssl_encryption.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Configure both the Server and Client to implement SSL/TLS encryption in your PMM
18
18
-[Copy certificates](#copy-certificates) directly into the PMM Server container
19
19
2.**Restart PMM Server** to apply the new certificates
20
20
3.**Configure client trust**: Ensure PMM Clients can verify the server certificate:
21
-
- Add the CA certificate to the system trust store ([Ubuntu guide](https://ubuntu.com/server/docs/install-a-root-ca-certificate-in-the-trust-store) | [Red Hat guide](https://www.redhat.com/sysadmin/configure-ca-trust-list))
21
+
- Add the CA certificate to the system trust store ([Ubuntu guide :octicons-link-external-16:](https://ubuntu.com/server/docs/install-a-root-ca-certificate-in-the-trust-store){:target="_blank"} | [Red Hat guide :octicons-link-external-16:](https://www.redhat.com/sysadmin/configure-ca-trust-list){:target="_blank"})
22
22
-**Or use the `SSL_CERT_FILE` environment variable** for [custom CA certificates](#use-custom-ca-certificates-with-pmm-client)
Copy file name to clipboardExpand all lines: documentation/docs/advisors/advisor-details.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Each Advisor includes a set of automated checks, which investigate a specific ra
6
6
7
7
This page presents the complete list of database Advisors along with the corresponding subscription tier for which they are available.
8
8
9
-
You can also access this list through the [**Advisor checks for PMM**](https://portal.percona.com/advisors) section in the Percona Portal documentation, as the Advisors are hosted on the Percona Platform. PMM Server automatically downloads them from this source when the Advisors and Telemetry options are enabled in PMM under **Configuration > Settings > Advanced Settings**. Both options are enabled by default.
9
+
You can also access this list through the [**Advisor checks for PMM** :octicons-link-external-16:](https://portal.percona.com/advisors){:target="_blank"} section in the Percona Portal documentation, as the Advisors are hosted on the Percona Platform. PMM Server automatically downloads them from this source when the Advisors and Telemetry options are enabled in PMM under **Configuration > Settings > Advanced Settings**. Both options are enabled by default.
Copy file name to clipboardExpand all lines: documentation/docs/advisors/advisors.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ As soon as you connect your PMM instance to Percona Platform, has access to addi
18
18
19
19
If you are a Percona customer with a Percona Customer Portal account, you also get access to Standard/Premium Advisor checks, which offer more advanced database health information.
20
20
21
-
To see the complete list of available checks, see the [Advisor Checks for PMM](https://docs.percona.com/percona-platform/advisors.html) topic in the Percona Platform documentation.
21
+
To see the complete list of available checks, see the [Advisor Checks for PMM :octicons-link-external-16:](https://docs.percona.com/percona-platform/advisors.html){:target="_blank"} topic in the Percona Platform documentation.
22
22
23
23
## Enable/Disable
24
24
To download the checks available for your Percona Account, the Advisors and Telemetry options have to be enabled under :material-cog: **Configuration >** :material-cog-outline: **Settings > Advanced Settings**.
Copy file name to clipboardExpand all lines: documentation/docs/advisors/develop-advisor-checks.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ As a developer, you can create custom checks to cover additional use cases, rele
9
9
A check is a combination of:
10
10
11
11
- A query for extracting data from the database.
12
-
- Python script for converting extracted data into check results. This is actually a [Starlark](https://github.com/google/starlark-go) script, which is a Python dialect that adds more imperative features than Python. The script's execution environment is sandboxed, and no I/O can be done from it.
12
+
- Python script for converting extracted data into check results. This is actually a [Starlark :octicons-link-external-16:](https://github.com/google/starlark-go){:target="_blank"} script, which is a Python dialect that adds more imperative features than Python. The script's execution environment is sandboxed, and no I/O can be done from it.
13
13
14
14
All checks are self-contained in the first phase, as well as in most of the planned phases.
15
15
@@ -192,22 +192,22 @@ Expand the table below for the list of checks types that you can use to define y
192
192
| MYSQL_SELECT | Executes 'SELECT …' clause against MySQL database. |Yes|
| MONGODB_GETPARAMETER | Executes db.adminCommand( { getParameter: "*" } ) against MongoDB's "admin" database. For more information, see [getParameter](https://docs.mongodb.com/manual/reference/command/getParameter/)| No|
196
-
| MONGODB_BUILDINFO | Executes db.adminCommand( { buildInfo: 1 } ) against MongoDB's "admin" database. For more information, see [buildInfo](https://docs.mongodb.com/manual/reference/command/buildInfo/) | No|
197
-
| MONGODB_GETCMDLINEOPTS | Executes db.adminCommand( { getCmdLineOpts: 1 } ) against MongoDB's "admin" database. For more information, see [getCmdLineOpts](https://docs.mongodb.com/manual/reference/command/getCmdLineOpts/) |No|
198
-
| MONGODB_REPLSETGETSTATUS | Executes db.adminCommand( { replSetGetStatus: 1 } ) against MongoDB's "admin" database. For more information, see [replSetGetStatus](https://docs.mongodb.com/manual/reference/command/replSetGetStatus/) |No|
199
-
| MONGODB_GETDIAGNOSTICDATA |Executes db.adminCommand( { getDiagnosticData: 1 } ) against MongoDB's "admin" database. For more information, see [MongoDB Performance](https://docs.mongodb.com/manual/administration/analyzing-mongodb-performance/#full-time-diagnostic-data-capture)| No|
200
-
| METRICS_INSTANT |Executes instant [MetricsQL](https://docs.victoriametrics.com/MetricsQL.html) query. Query can use placeholders in query string {% raw %} **{{.NodeName**}} and **{{.ServiceName}}** {% endraw %}. Both match target service/node names. To read more about instant queries, check out the [Prometheus docs](https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries).|Yes|
201
-
| METRICS_RANGE |Executes range [MetricsQL](https://docs.victoriametrics.com/MetricsQL.html) query. Query can use placeholders in query string {% raw %} **{{.NodeName**}} and **{{.ServiceName}}** {% endraw %}. Both match target service/node names. To read more about range queries, check out the [Prometheus docs](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries).|Yes|
195
+
| MONGODB_GETPARAMETER | Executes db.adminCommand( { getParameter: "*" } ) against MongoDB's "admin" database. For more information, see [getParameter :octicons-link-external-16:](https://docs.mongodb.com/manual/reference/command/getParameter/){:target="_blank"}| No|
196
+
| MONGODB_BUILDINFO | Executes db.adminCommand( { buildInfo: 1 } ) against MongoDB's "admin" database. For more information, see [buildInfo :octicons-link-external-16:](https://docs.mongodb.com/manual/reference/command/buildInfo/){:target="_blank"} | No|
197
+
| MONGODB_GETCMDLINEOPTS | Executes db.adminCommand( { getCmdLineOpts: 1 } ) against MongoDB's "admin" database. For more information, see [getCmdLineOpts :octicons-link-external-16:](https://docs.mongodb.com/manual/reference/command/getCmdLineOpts/){:target="_blank"} |No|
198
+
| MONGODB_REPLSETGETSTATUS | Executes db.adminCommand( { replSetGetStatus: 1 } ) against MongoDB's "admin" database. For more information, see [replSetGetStatus :octicons-link-external-16:](https://docs.mongodb.com/manual/reference/command/replSetGetStatus/){:target="_blank"} |No|
199
+
| MONGODB_GETDIAGNOSTICDATA |Executes db.adminCommand( { getDiagnosticData: 1 } ) against MongoDB's "admin" database. For more information, see [MongoDB Performance :octicons-link-external-16:](https://docs.mongodb.com/manual/administration/analyzing-mongodb-performance/#full-time-diagnostic-data-capture){:target="_blank"}| No|
200
+
| METRICS_INSTANT |Executes instant [MetricsQL :octicons-link-external-16:](https://docs.victoriametrics.com/MetricsQL.html){:target="_blank"} query. Query can use placeholders in query string {% raw %} **{{.NodeName**}} and **{{.ServiceName}}** {% endraw %}. Both match target service/node names. To read more about instant queries, check out the [Prometheus docs :octicons-link-external-16:](https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries){:target="_blank"}.|Yes|
201
+
| METRICS_RANGE |Executes range [MetricsQL :octicons-link-external-16:](https://docs.victoriametrics.com/MetricsQL.html){:target="_blank"} query. Query can use placeholders in query string {% raw %} **{{.NodeName**}} and **{{.ServiceName}}** {% endraw %}. Both match target service/node names. To read more about range queries, check out the [Prometheus docs :octicons-link-external-16:](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries){:target="_blank"}.|Yes|
202
202
| CLICKHOUSE_SELECT |Executes 'SELECT ...' statements against PMM's [Query Analytics](../use/qan/index.md) ClickHouse database. Queries can use the {% raw %} **{{.ServiceName**}} and **{{.ServiceID}}** {% endraw %} placeholders in query string. They match the target service name and service ID respectively.|Yes|
203
203
204
204
## Query parameters
205
205
-`METRICS_INSTANT`
206
206
-**lookback** (duration, optional): specifies how far in past to look back to metrics history. If this parameter is not specified, then query executed on the latest data. Example values: `30s`, `5m`, `8h`.
207
207
-`METRICS_RANGE`
208
208
-**lookback** (duration, optional): specifies how far in past to look back to metrics history. If this parameter is not specified, then query executed on the latest data. Example values: `30s`, `5m`, `8h`.
209
-
-**range** (duration, required): specifies time window of the query. This parameter is equal to [Prometheus API](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries).
210
-
-**step** (duration, required): query resolution. This parameter is equal to [Prometheus API](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries).
209
+
-**range** (duration, required): specifies time window of the query. This parameter is equal to [Prometheus API :octicons-link-external-16:](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries){:target="_blank"}.
210
+
-**step** (duration, required): query resolution. This parameter is equal to [Prometheus API :octicons-link-external-16:](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries){:target="_blank"}.
211
211
-`POSTGRESQL_SELECT`
212
212
-**all_dbs** (boolean, optional): execute query on all available databases in PostgreSQL instance. If this parameter is not specified, then query executed on the default database (the one that was specified when service was added to PMM).
213
213
@@ -219,7 +219,7 @@ Expand the table below for the list of checks types that you can use to define y
219
219
To develop custom checks for PMM:
220
220
{.power-number}
221
221
222
-
1. Install the latest PMM Server and PMM Client builds following the [installation instructions](https://www.percona.com/software/pmm/quickstart#).
222
+
1. Install the latest PMM Server and PMM Client builds following the [installation instructions :octicons-link-external-16:](https://www.percona.com/software/pmm/quickstart#){:target="_blank"}.
223
223
2. Run PMM Server with special environment variables:
224
224
225
225
-`PMM_DEV_ADVISOR_CHECKS_FILE=/srv/custom-checks.yml` to use checks from the local files instead of downloading them from Percona Platform.
@@ -276,4 +276,4 @@ There are two ways to reload your check file after making changes:
276
276
- From command line (always works): SSH into PMM Server and execute: `supervisorctl restart pmm-managed`.
277
277
278
278
## Submit feedback
279
-
We welcome your feedback on the current process for developing and debugging checks. Send us your comments or post a question on the [Percona Forums](https://forums.percona.com/c/percona-monitoring-and-management-pmm/pmm-3/84).
279
+
We welcome your feedback on the current process for developing and debugging checks. Send us your comments or post a question on the [Percona Forums :octicons-link-external-16:](https://forums.percona.com/c/percona-monitoring-and-management-pmm/pmm-3/84){:target="_blank"}.
Copy file name to clipboardExpand all lines: documentation/docs/alert/alert_rules.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ To check the full list of available PMM templates, see the [List of available al
33
33
34
34
### Create alert rules from alert rule templates
35
35
36
-
This section focuses on creating an alert rule based on PMM templates. For information on working with the other alert types, check the Grafana documentation on [Grafana Labs](https://grafana.com/docs/grafana/latest/alerting/).
36
+
This section focuses on creating an alert rule based on PMM templates. For information on working with the other alert types, check the Grafana documentation on [Grafana Labs :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/alerting/){:target="_blank"}.
37
37
38
38
### Provision alert resources
39
39
@@ -47,7 +47,7 @@ Before creating PMM alert rules, configure the required alert resources:
47
47
### Configure alert templates
48
48
49
49
Alerts templates are YAML files that provide the source framework for alert rules.
50
-
Alert templates contain general template details and an alert expression defined in [MetricsQL](https://docs.victoriametrics.com/MetricsQL.html). This query language is backward compatible with PromQL.
50
+
Alert templates contain general template details and an alert expression defined in [MetricsQL :octicons-link-external-16:](https://docs.victoriametrics.com/MetricsQL.html){:target="_blank"}. This query language is backward compatible with PromQL.
51
51
52
52
### Create custom templates
53
53
@@ -127,7 +127,7 @@ Note that to paste the query above, **Explore** must be in `Code` mode, and not
127
127
128
128
After provisioning the resources required for creating Percona templated alerts, you are now ready to create your alert rule based on a Percona template.
129
129
130
-
If you want to learn about creating Grafana alerts instead, check out [Grafana's documentation](https://grafana.com/docs/grafana/latest/alerting/):
130
+
If you want to learn about creating Grafana alerts instead, check out [Grafana's documentation :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/alerting/){:target="_blank"}:
131
131
{.power-number}
132
132
133
133
1. Go to **Alerting > Alert Rules**, and click **New alert rule from template**.
Copy file name to clipboardExpand all lines: documentation/docs/alert/silence_alerts.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ To create a new silence:
24
24
6. Review the affected alert instances that will be silenced.
25
25
7. Click **Save silece**.
26
26
27
-
For more information on working with silences, see [About alerting silences](https://grafana.com/docs/grafana/latest/alerting/manage-notifications/create-silence/) in the Grafana documentation.
27
+
For more information on working with silences, see [About alerting silences :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/alerting/manage-notifications/create-silence/){:target="_blank"} in the Grafana documentation.
28
28
29
29
## Alerting compatibility
30
30
@@ -52,8 +52,8 @@ To see all the available options, check the scrip help using `ia_migration.py -h
52
52
53
53
#### Script prerequisites
54
54
55
-
- Python version 3.x, which you can download from [Python Downloads centre](https://www.python.org/downloads/).
56
-
-[Requests library](https://requests.readthedocs.io/en/latest/user/install/#install), which you can install with the following command: ```pip3 install requests```.
55
+
- Python version 3.x, which you can download from [Python Downloads centre :octicons-link-external-16:](https://www.python.org/downloads/){:target="_blank"}.
56
+
-[Requests library :octicons-link-external-16:](https://requests.readthedocs.io/en/latest/user/install/#install){:target="_blank"}, which you can install with the following command: ```pip3 install requests```.
57
57
58
58
!!! caution alert alert-warning "Important"
59
59
The script sets all migrated alert rules to Active. Make sure to silence any alerts that should not be firing.
0 commit comments