Skip to content

docs-1564 various changes to install/configure #6856

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 13, 2025
Merged

docs-1564 various changes to install/configure #6856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions advocacy_docs/pg_extensions/otel/configuring.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ No permissions changes are required for edb_otel.

## Prerequisites

Before using edb_otel to export metrics, you must set up an OpenTelemetry collector endpoint that edb_otel can communicate with. For detailed information on how to set up a quick test of the OpenTelemetry endpoint using Docker, see [OTLP Exporter Example](https://github.com/open-telemetry/opentelemetry-cpp/tree/main/examples/otlp).
The following prerequisites must be completed before using edb_otel to export metrics:

- Set up an OpenTelemetry collector endpoint that edb_otel can communicate with. For detailed information on how to set up a quick test of the OpenTelemetry endpoint using Docker, see [OTLP Exporter Example](https://github.com/open-telemetry/opentelemetry-cpp/tree/main/examples/otlp).
- Install the pg_cron extension to schedule jobs for the pg_exporter.

## GUCs

Expand Down Expand Up @@ -91,5 +94,3 @@ The `edb_otel_metric` function has the following parameters.
!!!Note
Take care when calling the function that sends metrics. It's important to avoid using it in hot paths and while holding locks, since it currently enters third-party code. In the future, it may still perform non-trivial work, if only pushing data through a shm_mq to a background worker.
!!!

For a detailed example of this C API usage, where `pg_stat_statements` was instrumented to send all metrics through OTEL, see this [example](https://github.com/EnterpriseDB/opentelemetry-work/blob/arthur/pg17/contrib/pg_stat_statements/pg_stat_statements.c).
14 changes: 11 additions & 3 deletions advocacy_docs/pg_extensions/otel/installing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The syntax to install edb_otel on EDB Postgres Advanced Server and EDB Postgres
sudo <package-manager> -y install edb-as<postgres_version>-edb_otel

# For EDB Postgres Extended:
sudo <package-maanger> -y install edb-postgresextended<postgres_version>-edb_otel
sudo <package-manager> -y install edb-postgresextended<postgres_version>-edb_otel
```

Where:
Expand All @@ -50,17 +50,25 @@ Where:

- `<postgres_version>` is the version of Postgres you're using.

For example, to install the latest version of edb_otel for EDB Postgres Advanced Server 17 on a RHEL 9 platform:
Examples:

To install the latest version of edb_otel for EDB Postgres Advanced Server 17 on a RHEL 9 platform:

```shell
sudo dnf -y install edb-as17-edb_otel
```

To install the latest version of edb_otel for EDB Postgres Extended 17 on a RHEL 9 platform:

```shell
sudo dnf -y install edb-postgresextended17-edb_otel
```

The syntax to install edb_otel on PostgreSQL is:

```shell
# For RHEL 9 and its derivatives:
sudo dnf -y install edb_otel_<postgres_version>
sudo dnf -y install edb-pg<postgres_version>-edb_otel
```

Where `<postgres_version>` is the version of PostgreSQL you're using.
Expand Down
2 changes: 1 addition & 1 deletion advocacy_docs/pg_extensions/otel/rel_notes/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ The edb_otel documentation describes the latest version of edb_otel, including m

| Version | Release date |
| -------------------------------- | ------------ |
| [1.0.0](edb_otel_1.0.0_rel_notes) | 04 March 2025 |
| [1.0.0](edb_otel_1.0.0_rel_notes) | 28 March 2025 |

Loading