Skip to content

Commit

Permalink
Showing 6 changed files with 99 additions and 12 deletions.
5 changes: 4 additions & 1 deletion product_docs/docs/lasso/4/configuration.mdx
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@
title: Configuration
---

Besides being mandatory for the customer `id` and `token`, the Lasso
Besides being mandatory for the customer `id`, the Lasso
configuration file also allows you to omit most of the command line
options that your environment might require. (You can see a list of all
the command-line options in [Usage](usage).)
@@ -27,9 +27,12 @@ A template file for the configuration file looks like this:
; the "Company code" from the customer page in the EDB Portal
id=
; the "Token" from the customer page in the EDB Portal
; since Lasso 4.17.0, the token is no longer mandatory.
token=
; the depth of the Lasso report. Must be one between: surface, shallow and deep
depth=deep
; the environment of the server. Can be any string
environment=
[postgresql]
; Lasso uses the following connection string parameters to connect to your
39 changes: 39 additions & 0 deletions product_docs/docs/lasso/4/describe.mdx
Original file line number Diff line number Diff line change
@@ -2690,3 +2690,42 @@ Collect the location of the Barman Python modules.

**Security impact:** Low —
No known security impact.

### Databases checksums (`postgresql_databases_checksums`)

List of checksum failures in the PostgreSQL node

**Report output:**

* File `postgresql/databases_checksums.out`

**Depth:** Surface

**Security impact:** Low —
No known security impact.

### Blocking locks (`postgresql_blocking_locks`)

List of blocking locks

**Report output:**

* File `postgresql/blocking_locks.out`

**Depth:** Surface

**Security Impact:** Low —
No known security impact.

### BDR worker_errors (`postgresql_db_bdr_worker_errors`)

List all `bdr.worker_errors` entries in `error_time ASC` order

**Report output:**

* File `bdr/worker_errors.data`

**Depth:** Surface

**Security Impact:** Low —
No known security impact.
12 changes: 4 additions & 8 deletions product_docs/docs/lasso/4/install.mdx
Original file line number Diff line number Diff line change
@@ -4,8 +4,7 @@ title: Installing Lasso

EDB distributes the application through the
[EDB website](https://www.enterprisedb.com/software-downloads-postgres)
and grants usage to customers using a *company token* as a means of
authentication.
and grants usage to customers using a *company ID*.


## Linux
@@ -97,19 +96,16 @@ The minimum configuration file looks like this:
```
[customer]
id=XXXXX
token=YYYYYYYYY
```

Replace the `id` and `token` value with the information found in your
Replace the `id` value with the information found in your
company page in the Support Portal. (In the left menu bar, select
**Company info > Company**.) Enter the **Company code** value from this page
in the `id` field in the configuration file. Enter the
**Token** value in the `token` field in the
configuration file.
in the `id` field in the configuration file.

!!! Important
A configuration file for Lasso is mandatory and must contain at least
the customer id and token.
the customer id.
!!!

For more details about the Lasso configuration, see
19 changes: 19 additions & 0 deletions product_docs/docs/lasso/4/release-notes.mdx
Original file line number Diff line number Diff line change
@@ -2,6 +2,25 @@
title: Release notes
---

## Lasso - Version 4.17.0

Released: 12 Sep 2024

Lasso Version 4.17.0 includes the following enhancements and bug fixes:

| Type | Description | Addresses |
|------------------------|-------------|-----------|
| Feature | Support for Patroni | |
| Feature | New argument `--command-timeout` | DC-874 |
| Feature | New optional setting customer `environment` | DC-1013 |
| Feature | Add collection of `checksum_failures` and `checksum_last_failure` timestamp from `pg_stat_database` | DC-1014 |
| Feature | Gather blocking locks | DC-422 |
| Feature | Show symbolic link target in `linux/pg_links.data` | DC-967 |
| Bug Fixes | Make BDR's `worker_errors` output sorted by error timestamp | DC-150 |
| Bug Fixes | Fix bdr sequences query to prevent duplicate rows | DC-69 |
| Deprecation Notes | Customer `token` is now optional in the configuration | DC-1013 |


## Lasso - Version 4.16.0

Released: 04 Jun 2024
21 changes: 21 additions & 0 deletions product_docs/docs/lasso/4/report-types.mdx
Original file line number Diff line number Diff line change
@@ -250,6 +250,27 @@ We recommend this approach, as it guarantees Lasso will use
the correct EFM configuration file instead of trying to find it.


## Patroni report

Lasso can run on systems where Patroni is installed. In that
case, it gathers Patroni-related information.

In general, if you installed Patroni using EDB-certified RPM and DEB
packages, all you need to do is execute Lasso.

### How Lasso finds the Patroni configuration file

Lasso uses the following approach while trying to identify the Patroni
configuration file. It uses the first one it finds.

1. Use the one provided to the `--patroni-configuration` option, if given.
2. Check the paths provided by packages. For DEB packages, the configuration
file is usually `/etc/patroni/config.yml`, while for RPM packages, the
configuration file is usually `/etc/patroni/patroni.yml`.
3. Check the running processes. If there is any `patroni` processes running,
then the configuration file is passed as the last argument.


## Replication Server (xDB) report

Lasso can run on systems where xDB is installed. In that
15 changes: 12 additions & 3 deletions product_docs/docs/lasso/4/usage.mdx
Original file line number Diff line number Diff line change
@@ -15,7 +15,9 @@ usage: lasso [-h] [-H HOST_NAME] [-p PORT] [--password PASSWORD]
[--lock-timeout LOCK_TIMEOUT]
[--statement-timeout STATEMENT_TIMEOUT]
[--sampling-start SAMPLING_START] [--sampling-end SAMPLING_END]
[--local-size-limit LOCAL_SIZE_LIMIT] [--bindir BINDIR]
[--local-size-limit LOCAL_SIZE_LIMIT]
[--command-timeout COMMAND_TIMEOUT]
[--bindir BINDIR]
[--depth [{surface,shallow,deep}]]
[--describe [{short,json,full}]] [--version] [--info]
[--latest-version] [--system-only | --barman]
@@ -27,8 +29,9 @@ usage: lasso [-h] [-H HOST_NAME] [-p PORT] [--password PASSWORD]
[--pgbouncer-configuration PGBOUNCER_CONFIGURATION]
[--harp-configuration HARP_CONFIGURATION]
[--etcd-configuration ETCD_CONFIGURATION]
[--pgd-proxy-configuration PGD_PROXY_CONFIGURATION] [--upload]
[--keep-report] [--is-latest-version]
[--pgd-proxy-configuration PGD_PROXY_CONFIGURATION]
[--patroni-configuration PATRONI_CONFIGURATION]
[--upload] [--keep-report] [--is-latest-version]
[dbname] [user]
EDB Lasso (for 2ndquadrant)
@@ -57,6 +60,9 @@ optional arguments:
--local-size-limit LOCAL_SIZE_LIMIT
Size limit, in bytes, of each file inside the tarball
(minimum 1024, default 524288000)
--command-timeout COMMAND_TIMEOUT
Timeout for each linux command execution (example
'120s','2m',etc. default: No timeout)
--bindir BINDIR PostgreSQL binaries directory (autodetect by default)
--depth [{surface,shallow,deep}]
Depth of the report (default deep)
@@ -101,6 +107,9 @@ optional arguments:
--pgd-proxy-configuration PGD_PROXY_CONFIGURATION
Path to the pgd-proxy-config.yml file, if using a non-
default path
--patroni-configuration PATRONI_CONFIGURATION
Path to the Patroni YAML file, if using a non-default
path
--upload Report tarball file is sent to EDB at the end of the
execution. The file will be removed if successfully
uploaded unless --keep-report is specified

1 comment on commit 44d07be

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.