Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PMM-7 fix links #3545

Merged
merged 18 commits into from
Feb 3, 2025
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion documentation/docs/advisors/advisors.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,5 @@ To see more details about the available checks and any checks that failed, click
## Create your own Advisors
PMM Advisors offer a set of checks that can detect common security threats, performance degradation, data loss and data corruption.

Developers can create custom checks to cover additional use cases, relevant to specific database infrastructure. For more information, see [Develop Advisor checks](../details/develop-checks/index.html).
Developers can create custom checks to cover additional use cases, relevant to specific database infrastructure. For more information, see [Develop Advisor checks](develop_advisor_checks.md).

2 changes: 1 addition & 1 deletion documentation/docs/advisors/develop_advisor_checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ Expand the table below for the list of checks types that you can use to define y
| 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|
| 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|
| 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|
| CLICKHOUSE_SELECT |Executes 'SELECT ...' statements against PMM's [Query Analytics](https://docs.percona.com/percona-monitoring-and-management/get-started/query-analytics.html) 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|
| CLICKHOUSE_SELECT |Executes 'SELECT ...' statements against PMM's [Query Analytics](../use/qan/index.html) 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|

## Query parameters
- `METRICS_INSTANT`
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/alert/templates_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The table below lists all the alert templates available in Percona Monitoring an

This list includes both built-in templates (accessible to all PMM users), and customer-only templates.

To access the customer-only templates, you must be a Percona customer and [connect PMM to Percona Platform](../how-to/integrate-platform.md) using a Percona Account.
To access the customer-only templates, you must be a Percona customer and [connect PMM to Percona Platform](../configure-pmm/percona_platform/check_percona_platform.md) using a Percona Account.

| Template name | Description | Availability | Database technology |
| :------------ | :---------- | :----------- | :------------------ |
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/backup/mongodb-backup/backup_mongo.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ PMM 3 supports backing up sharded clusters. However, restoring for sharded clust
- Creating Physical snapshot backups
- Creating logical PITR backups both locally and on S3-compatible object storage

For a detailed overview of the supported setups for MongoDB, check out the [Support matrix](../backup/mongodb_limitations.md).
For a detailed overview of the supported setups for MongoDB, check out the [Support matrix](mongodb_limitations.md).
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ You can check the list of available Paid Advisor checks on the [Advisors details

When you connect with a customer account, PMM reveals two new tabs on the main menu, where you can check all the information available for your customer accounts: **Entitlements** and **Support tickets**:

![!image](../images/CustomerTickets.png)
![!image](../../images/CustomerTickets.png)

![!image](../images/CustomerEntitlements.png)
![!image](../../images/CustomerEntitlements.png)
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,9 @@ To confirm that you have successfully connected the server and check the list of

## Check Percona Portal entitlements

After connecting to the Percona Platform, PMM has access to [additional alert templates](/docs/alert/templates_list.md), [Advisor checks](/docs/advisors/advisors-details.md), and account information. See [Check Percona Portal account information](../how-to/account-info.md).
After connecting to the Percona Platform, PMM has access to [additional alert templates](../../alert/templates_list.md), [Advisor checks](../../advisors/advisors-details.md), and account information. See [Check Percona Portal account information](account-info.md).


After connecting to the Percona Platform, PMM has access to additional alert templates, Advisor checks, and account information. See [Check Percona Portal account information](../how-to/account-info.md).

### Disconnect a PMM instance

Disconnect a PMM instance when you want to unlink it from your Percona Platform organization or stop monitoring it there.
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/configure-pmm/public-address.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The address or hostname PMM Server will be accessible at. Click **Get from brows

## Alerting

Enables [Percona Alerting](../get-started/alerting.md) and reveals the **Percona templated alerts** option on the Alerting page.
Enables [Percona Alerting](../alert/index.md) and reveals the **Percona templated alerts** option on the Alerting page.

## Microsoft Azure Monitoring

Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/how-to/manage-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This topic explains user management in PMM.

You can manage users from the [main menu](../details/interface.md#main-menu) by navigating to *Server Admin → Users* page.
You can manage users from the [main menu](../reference/ui/ui_components.md#main-menu) by navigating to *Server Admin → Users* page.


![!image](../images/PMM-manage-users.png)
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/install-pmm/HA.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Install PMM in HA mode

!!! caution alert alert-warning "Important"
This feature is currently in [Technical Preview](https://docs.percona.com/percona-monitoring-and-management/details/glossary.html#technical-preview). Early adopters are advised to use this feature for testing purposes only as it is subject to change.
This feature is currently in [Technical Preview](../reference/glossary.md#technical-preview). Early adopters are advised to use this feature for testing purposes only as it is subject to change.

Set up PMM using Docker containers in a high-availability (HA) configuration following these instructions.

Expand Down
30 changes: 15 additions & 15 deletions documentation/docs/install-pmm/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ The installation choices are:

=== "With Docker"

- [Docker installation](client/index.md#docker) simplifies deployment across different architectures and automatically selects the appropriate image for your architecture (x86_64 or ARM64).
- [Docker installation](install-pmm-client/docker.md) simplifies deployment across different architectures and automatically selects the appropriate image for your architecture (x86_64 or ARM64).

=== "With package manager"

- [Linux package](client/index.md#package-manager). Use `apt`, `apt-get`, `dnf`, `yum`. The package manager automatically selects the correct version for your architecture.
- [Linux package](install-pmm-client/package_manager.md). Use `apt`, `apt-get`, `dnf`, `yum`. The package manager automatically selects the correct version for your architecture.

=== "With binary package"

- [Binary package](client/index.md#binary-package): Download the appropriate `.tar.gz` file for your architecture (x86_64 or ARM64).
- [Binary package](install-pmm-client/binary_package.md): Download the appropriate `.tar.gz` file for your architecture (x86_64 or ARM64).


!!! hint alert "Tips"
Expand All @@ -63,18 +63,18 @@ On each PMM Client instance, configure the nodes and services you want to monito
- [HAProxy];
- [Remote instances].

[MySQL]: client/mysql.md
[MongoDB]: client/mongodb.md
[PostgreSQL]: client/postgresql.md
[ProxySQL]: client/proxysql.md
[Amazon RDS]: client/aws.md
[Microsoft Azure]: client/azure.md
[Google Cloud Platform]: client/google.md
[Linux]: client/linux.md
[External services]: client/external.md
[HAProxy]: client/haproxy.md
[Remote instances]: client/remote.md
[dashboards]: ../details/dashboards/
[MySQL]: install-pmm-client/mysql.md
[MongoDB]: install-pmm-client/mongodb.md
[PostgreSQL]: install-pmm-client/postgresql.md
[ProxySQL]: install-pmm-client/proxysql.md
[Amazon RDS]: install-pmm-client/aws.md
[Microsoft Azure]: install-pmm-client/azure.md
[Google Cloud Platform]: install-pmm-client/google.md
[Linux]: install-pmm-client/linux.md
[External services]: install-pmm-client/external.md
[HAProxy]: install-pmm-client/haproxy.md
[Remote instances]: install-pmm-client/remote.md
[dashboards]: ../use/dashboards-panels/index.md
[Docker]: ../install-pmm/install-pmm-server/baremetal/docker/index.md
[Podman]: ../install-pmm/install-pmm-server/baremetal/podman/index.md
[Helm]: ../install-pmm/install-pmm-server/baremetal/helm/index.md
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ Use `pmm-admin` to add the database server as a service using one of these examp
When successful, PMM Client will print `MongoDB Service added` with the service's ID and name. Use the `--environment` and `-custom-labels` options to set tags for the service to help identify them.

!!! hint alert alert-success "Tips"
- When adding nodes to a sharded cluster, ensure to add each node separately using the `--cluster mycluster` option. This allows the [MongoDB Cluster Summary](../../details/dashboards/dashboard-mongodb-cluster-summary.md) dashboard to populate correctly.
- When adding nodes to a sharded cluster, ensure to add each node separately using the `--cluster mycluster` option. This allows the [MongoDB Cluster Summary](../../../reference/dashboards/dashboard-mongodb-cluster-summary.md) dashboard to populate correctly.
- You can also use the `--replication-set` option to specify a replication set, altough they are automatically detected. For instance, you can use `--replication-set config` for your config servers; `--replication-set rs1` for your servers in the first replica set, `--replication-set rs2` for your servers in the second replica set, and so on.
- When running mongos routers in containers, specify the `diagnosticDataCollectionDirectoryPath` to ensure that pmm-agent can properly capture mongos metrics. For example: `mongos --setParameter diagnosticDataCollectionDirectoryPath=/var/log/mongo/mongos.diagnostic.data/`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ Some MySQL-based database servers support extended slow query log variables.

Slow query log files can grow quickly and must be managed.

When adding a service with the command line use the `pmm-admin` option `--size-slow-logs` to set at what size the slow query log file is rotated. (The size is specified as a number with a suffix. See [`pmm-admin add mysql`](../../details/commands/pmm-admin.md#mysql).)
When adding a service with the command line use the `pmm-admin` option `--size-slow-logs` to set at what size the slow query log file is rotated. (The size is specified as a number with a suffix. See [`pmm-admin add mysql`](../../../use/commands/pmm-admin.md#mysql).)

When the limit is reached, PMM Client will:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,6 @@ You can install PMM Server with Watchtower in two ways:

- To disable the Home Dashboard **PMM Upgrade** panel you can either add `-e PMM_ENABLE_UPDATES=false` to the `docker run` command (for the life of the container) or navigate to _PMM --> PMM Settings --> Advanced Settings_ and disable "Check for Updates" (can be turned back on by any admin in the UI).

- Eliminate browser certificate warnings by configuring a [trusted certificate](https://docs.percona.com/percona-monitoring-and-management/how-to/secure.html#ssl-encryption).
- Eliminate browser certificate warnings by configuring a [trusted certificate](../../../../how-to/secure.html#ssl-encryption).

- You can optionally enable an (insecure) HTTP connection by adding `--publish 80:80` to the `docker run` command. However, running PMM insecure is not recommended. You should also note that PMM Client *requires* TLS to communicate with the server, only working on a secure port.
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@

# Isolated hosts

If the host where you will run PMM Server has no internet connection, you can download the Docker image on a separate (internet-connected) host and securely copy it.
If the host where you will run [PMM Server][Docker image] has no internet connection, you can download the Docker image on a separate (internet-connected) host and securely copy it.
{.power-number}

1. On an internet-connected host, download the Docker image and its checksum file.
1. On an internet-connected host, download the [Docker][Docker] image and its checksum file:

```sh
wget https://downloads.percona.com/downloads/pmm/{{release}}/docker/pmm-server-{{release}}.docker
Expand All @@ -15,25 +14,32 @@ If the host where you will run PMM Server has no internet connection, you can do

3. Open a terminal on the PMM Server host.

4. (Optional) Check the Docker image file integrity.
4. (Optional) Check the Docker image file integrity:

```sh
shasum -ca 256 pmm-server-{{release}}.sha256sum
```

5. Load the image.
5. Load the image:

```sh
docker load -i pmm-server-{{release}}.docker
```

6. [Run the container](index.md#run-docker-container) as if your image is already pulled using your desired method for a storage volume (you can step over any docker pull commands as the image has been pre-staged).

For more information, see:
- [Docker installation guide][Docker]
- [Docker Compose installation][Docker compose]
- [PMM Server Docker tags][tags]
- [PMM Client Docker setup][PMMC_COMPOSE]
- [Setting up trusted certificates][trusted certificate]
- [Easy installation script][Easy-install script]

[tags]: https://hub.docker.com/r/percona/pmm-server/tags
[Docker]: https://docs.docker.com/get-docker/
[Docker image]: https://hub.docker.com/r/percona/pmm-server
[Docker compose]: https://docs.docker.com/compose/
[PMMC_COMPOSE]: ../client/index.md#docker-compose
[trusted certificate]: ../../how-to/secure.md#ssl-encryption
[Easy-install script]: easy-install.md
[PMMC_COMPOSE]: ../../../install-pmm-client/docker.md
[trusted certificate]: ../../../../how-to/secure.md#ssl-encryption
[Easy-install script]: easy-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,4 @@ To remove your contiainer:
[Docker]: docker.md
[Docker image]: https://hub.docker.com/r/percona/pmm-server
[Docker Environment]: docker.md#environment-variables
[trusted certificate]: ../../how-to/secure.md#ssl-encryption
[Set up repos]: ../client/index.md#package-manager
[trusted certificate]: ../../../../how-to/secure.md#ssl-encryption
8 changes: 4 additions & 4 deletions documentation/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ Once PMM is set up, choose the database or the application that you want it to m

3. Set up the `pg_stat_monitor` database extension and configure your database server accordingly.

If you need to use the `pg_stat_statements` extension instead, see [Adding a PostgreSQL database](../setting-up/client/postgresql.md) and the [`pg_stat_monitor` online documentation](https://docs.percona.com/pg-stat-monitor/configuration.html) for details about available parameters.
If you need to use the `pg_stat_statements` extension instead, see [Adding a PostgreSQL database](../install-pmm/install-pmm-client/connect-database/postgresql.md) and the [`pg_stat_monitor` online documentation](https://docs.percona.com/pg-stat-monitor/configuration.html) for details about available parameters.

4. Set or change the value for `shared_preload_library` in your `postgresql.conf` file:

Expand Down Expand Up @@ -211,7 +211,7 @@ Once PMM is set up, choose the database or the application that you want it to m
pmm-admin add postgresql --username=pmm --password=<your_password>
```

For detailed instructions and advanced installation options, see [Adding a PostgreSQL database](../setting-up/client/postgresql.md).
For detailed instructions and advanced installation options, see [Adding a PostgreSQL database](../install-pmm/install-pmm-client/connect-database/postgresql.md).

=== ":simple-mongodb: MongoDB"

Expand Down Expand Up @@ -315,7 +315,7 @@ Once PMM is set up, choose the database or the application that you want it to m
pmm-admin add mongodb --username=pmm --password=<your_password>
```

For detailed instructions, see [Adding a MongoDB database for monitoring](https://docs.percona.com/percona-monitoring-and-management/setting-up/client/mongodb.html).
For detailed instructions, see [Adding a MongoDB database for monitoring](install-pmm/install-pmm-client/connect-database/mongodb.html).

=== ":simple-nginxproxymanager: ProxySQL"
To connect a ProxySQL service:
Expand Down Expand Up @@ -372,7 +372,7 @@ Once PMM is set up, choose the database or the application that you want it to m
pmm-admin add proxysql --username=pmm --password=<your_password>
```

For detailed instructions, see [Enable ProxySQL performance metrics monitoring](../setting-up/client/proxysql.md).
For detailed instructions, see [Enable ProxySQL performance metrics monitoring](../install-pmm/install-pmm-client/connect-database/proxysql.md).

=== ":material-database: HAProxy"
To connect an HAProxy service:
Expand Down
Loading
Loading