From d159be31369e2b8fc70ef3fdf5366bad8edd5b02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mart=C3=ADn=20Marqu=C3=A9s?= Date: Tue, 14 May 2024 09:10:30 +0200 Subject: [PATCH 1/5] Add release notes for version 1.1.0 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Martín Marqués --- .../docs/pwr/1/rel_notes/110_rel_notes.mdx | 22 +++++++++++++++++++ product_docs/docs/pwr/1/rel_notes/index.mdx | 3 ++- 2 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx diff --git a/product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx b/product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx new file mode 100644 index 00000000000..0a7e059c83f --- /dev/null +++ b/product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx @@ -0,0 +1,22 @@ +--- +title: "Postgres Workload Report 1.1.0 release notes" +navTitle: Version 1.1.0 +--- + +Released: 14 May 2024 + +New features, enhancements, bug fixes, and other changes in Postgres Workload Report 1.1.0 include: + +| Type | Description | +| ----------------- |-------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Feature | Add locking to PWR commands to avoid concurrent runs | +| Change | Changed the default value for the `assets_dir` config parameter to use the folder where the assets are going to be installed by the packages + (`/usr/share/pwr/assets` | +| Change | Added the `--use-plain-report-name` option to `execute` and `report` commands. This will bypass the default behavior of prepending the database name and report timestamp to the report name | +| Change | Rework of pwr output and logging | +| Bug Fix | Fixed RPM package to have a strict dependency on `edb-lasso` >= 4.13.0 | +| Bug Fix | Fixed PWR to not fail when `edb_wait_states` has no samples in the range | +| Bug Fix | Fix issues when using timestamp without time zone | +| Bug Fix | Fix issues related with configuration handling | +| Bug Fix | Fix issue with `pwr report` failing if `--output-directory` does not exist | + diff --git a/product_docs/docs/pwr/1/rel_notes/index.mdx b/product_docs/docs/pwr/1/rel_notes/index.mdx index f41803f5929..a08009ff0c0 100644 --- a/product_docs/docs/pwr/1/rel_notes/index.mdx +++ b/product_docs/docs/pwr/1/rel_notes/index.mdx @@ -8,5 +8,6 @@ description: "Release notes for Postgres Workload Report" The Postgres Workload Report (PWR) documentation describes the latest version of PWR 1, including minor releases and patches. The release notes provide information on what was new in each release. For new functionality introduced in a minor or patch release, indicators in the content provide information about the release that introduced the feature. | Version | Release date | -| ------------------------- | ------------ | +| ------------------------- | ------------ | +| [1.1.0](110_rel_notes) | 14 May 2024 | | [1.0.0](100_rel_notes) | 15 Feb 2024 | From 4b0fac7b4cdbf77826a5da873c3459d43cfa5a9e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mart=C3=ADn=20Marqu=C3=A9s?= Date: Tue, 14 May 2024 18:02:27 +0200 Subject: [PATCH 2/5] Update documentation for PWR to include features included in 1.1.0 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Martín Marqués --- product_docs/docs/pwr/1/configuring.mdx | 4 ++++ product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx | 3 +-- product_docs/docs/pwr/1/using.mdx | 7 ++++++- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/pwr/1/configuring.mdx b/product_docs/docs/pwr/1/configuring.mdx index 9fb219404ef..1db5ac1fbe1 100644 --- a/product_docs/docs/pwr/1/configuring.mdx +++ b/product_docs/docs/pwr/1/configuring.mdx @@ -6,6 +6,10 @@ description: "How to configure Postgres Workload Report after installation" To reduce the number of command-line arguments needed when executing `pwr`, you can use a configuration file to specify options that always have the same value and whose values differ from the default. +!!! Note +`edb-lasso` requires a configuration file to be present to work properly. If not configured correctly, `pwr` will fail to complete. Please refer to the [lasso documentation](https://www.enterprisedb.com/docs/lasso/latest/configuration/) for more information on how to configure it. +!!! + ## Configuration file locations Postgres Workload Report looks for a configuration file in the following places and uses the first one found: diff --git a/product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx b/product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx index 0a7e059c83f..89c1cd3dffa 100644 --- a/product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx +++ b/product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx @@ -10,8 +10,7 @@ New features, enhancements, bug fixes, and other changes in Postgres Workload Re | Type | Description | | ----------------- |-------------------------------------------------------------------------------------------------------------------------------------------------------- | | Feature | Add locking to PWR commands to avoid concurrent runs | -| Change | Changed the default value for the `assets_dir` config parameter to use the folder where the assets are going to be installed by the packages - (`/usr/share/pwr/assets` | +| Change | Changed the default value for the `assets_dir` config parameter to use the folder where packages place the assets (`/usr/share/pwr/assets`) | | Change | Added the `--use-plain-report-name` option to `execute` and `report` commands. This will bypass the default behavior of prepending the database name and report timestamp to the report name | | Change | Rework of pwr output and logging | | Bug Fix | Fixed RPM package to have a strict dependency on `edb-lasso` >= 4.13.0 | diff --git a/product_docs/docs/pwr/1/using.mdx b/product_docs/docs/pwr/1/using.mdx index 5ab6d405bee..bc1cc9ef5ed 100644 --- a/product_docs/docs/pwr/1/using.mdx +++ b/product_docs/docs/pwr/1/using.mdx @@ -33,13 +33,18 @@ pwr execute --host-name myserver --sampling-start '2024-01-10 09:00:00+00:00' \ ``` !!! Note -`--sampling-start` and `--sampling-end` accept both timestamps with or without time zone. If no time zone is explicitly set in the timestamp(s), PWR uses the system time zone. +`--sampling-start` and `--sampling-end` accept timestamps with or without time zone. If no time zone is explicitly set in the timestamp(s), PWR uses the system time zone. !!! Run `pwr execute -h` to get the full list of options available. ## Example for the `report` option +!!! Note +To avoid overwriting previous reports, the `pwr execute` command will append the database name and a timestamp with the format `%Y%m%d%H%M%S` (e.g. `March_report-mydatabase-20240321-133727.html`) to the report name provided. +To avoid this behavior, the user can use the `--use-plain-report-name` option when executing `pwr execute`. +!!! + In some cases, you already have a Lasso report and want PWR to use the Lasso report as the source and build a report based on it. For these cases, the `pwr report` option is useful. This example uses the same scenario already described but uses a Lasso report that was executed using the time boundaries in the previous example. Suppose that the Lasso report's name is `edb-lasso-Jan10-incident.tar.bz2` and is located in the home directory of the machine where `pwr report` will be executed. From 2a3c7257d03e1949520c965295aec2186632f1b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mart=C3=ADn=20Marqu=C3=A9s?= Date: Wed, 15 May 2024 08:35:59 -0300 Subject: [PATCH 3/5] Update product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx Co-authored-by: Israel --- product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx b/product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx index 89c1cd3dffa..2bcf0b41b0f 100644 --- a/product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx +++ b/product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx @@ -11,7 +11,7 @@ New features, enhancements, bug fixes, and other changes in Postgres Workload Re | ----------------- |-------------------------------------------------------------------------------------------------------------------------------------------------------- | | Feature | Add locking to PWR commands to avoid concurrent runs | | Change | Changed the default value for the `assets_dir` config parameter to use the folder where packages place the assets (`/usr/share/pwr/assets`) | -| Change | Added the `--use-plain-report-name` option to `execute` and `report` commands. This will bypass the default behavior of prepending the database name and report timestamp to the report name | +| Change | Added the `--use-plain-report-name` option to `execute` and `report` commands. This will bypass the default behavior of appending the database name and report timestamp to the report name | | Change | Rework of pwr output and logging | | Bug Fix | Fixed RPM package to have a strict dependency on `edb-lasso` >= 4.13.0 | | Bug Fix | Fixed PWR to not fail when `edb_wait_states` has no samples in the range | From ea2212e6d64250f473a5432fb1521a5ab8f83dba Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan <126472455+djw-m@users.noreply.github.com> Date: Wed, 15 May 2024 12:38:33 +0100 Subject: [PATCH 4/5] Fix rel notes date --- product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx b/product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx index 2bcf0b41b0f..62f90b0df1d 100644 --- a/product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx +++ b/product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx @@ -3,7 +3,7 @@ title: "Postgres Workload Report 1.1.0 release notes" navTitle: Version 1.1.0 --- -Released: 14 May 2024 +Released: 15 May 2024 New features, enhancements, bug fixes, and other changes in Postgres Workload Report 1.1.0 include: From 00ad0c010b7306e76e7cb5c6f05e93143532753b Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan <126472455+djw-m@users.noreply.github.com> Date: Wed, 15 May 2024 12:38:55 +0100 Subject: [PATCH 5/5] Fix index.mdx dates --- product_docs/docs/pwr/1/rel_notes/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/pwr/1/rel_notes/index.mdx b/product_docs/docs/pwr/1/rel_notes/index.mdx index a08009ff0c0..2acc5d3bfeb 100644 --- a/product_docs/docs/pwr/1/rel_notes/index.mdx +++ b/product_docs/docs/pwr/1/rel_notes/index.mdx @@ -9,5 +9,5 @@ The Postgres Workload Report (PWR) documentation describes the latest version of | Version | Release date | | ------------------------- | ------------ | -| [1.1.0](110_rel_notes) | 14 May 2024 | +| [1.1.0](110_rel_notes) | 15 May 2024 | | [1.0.0](100_rel_notes) | 15 Feb 2024 |