Merge branch 'main' into v3

percona · Aug 23, 2024 · 435d0a1 · 435d0a1
2 parents 0a4e947 + 3410da4
commit 435d0a1
Show file tree

Hide file tree

Showing 14 changed files with 469 additions and 332 deletions.
diff --git a/cli-tests/package-lock.json b/cli-tests/package-lock.json
diff --git a/cli-tests/package.json b/cli-tests/package.json
@@ -24,7 +24,7 @@
   "devDependencies": {
     "@types/promise-retry": "^1.1.3",
     "@types/shelljs": "^0.8.12",
-    "@typescript-eslint/eslint-plugin": "^8.0.1",
+    "@typescript-eslint/eslint-plugin": "^8.1.0",
     "@typescript-eslint/parser": "^7.18.0",
     "eslint": "8.57",
     "eslint-config-airbnb-base": "^15.0.0",

diff --git a/docs/api/pmm-server-config/troubleshooting/logs.md b/docs/api/pmm-server-config/troubleshooting/logs.md
@@ -3,12 +3,26 @@ title: Logs
 slug: "logs"
 category: 66acab7b0bf230001846b5e2
 ---
+Download the logs and components configuration to troubleshoot any issues with the PMM Server.
 
-Sometimes users need to troubleshoot an issue. PMM Server offers an ability to download the logs as well as configuration of its components. 
+## Accessing logs
 
-You can download the logs either by calling this endpoint or by visiting a dedicated URL (ex: https://pmmdemo.percona.com/logs.zip) or via the **Settings UI** as explained in the [Troubleshooting](https://docs.percona.com/percona-monitoring-and-management/how-to/troubleshoot.html#client-server-connections) section of our docs.
+PMM Server offers three ways to access and download logs:
+
+1. Through direct URL, by visiting `https://<address-of-your-pmm-server>/logs.zip`.
+2. By calling the Logs endpoint. This method enables you to customize the log content using the `line-count` parameter: For example:
+
+   - Default 50,000 lines: `https://<pmm-server>/logs.zip`
+   - Custom number of lines: `https://<pmm-server>/logs.zip?line-count=10000`
+   - Unlimited, full log: `https://<pmm-server>/logs.zip?line-count=-1`
+3. Through the UI, by selecting the **Help > PMM Logs** option from the main menu.
+  If you need to share logs with Percona Support via an SFTP server, you can also use the **PMM Dump** option from the Help menu to generate a compressed tarball file with an export of your PMM metrics and QAN data.
+  For more information, see [Export PMM data with PMM Dump](https://docs.percona.com/percona-monitoring-and-management/how-to/PMM_dump.html) topic in the product documentation.
+
+## Log structure
+
+The downloaded logs package contains the following structure:
 
-The structure of the logs is as follows:
 [block:code]
 {
   "codes": [