From 634ea80eae21b4dd30c10e2a3ec91df210fe89f1 Mon Sep 17 00:00:00 2001 From: piano35-edb <160748516+piano35-edb@users.noreply.github.com> Date: Wed, 28 May 2025 16:31:29 -0500 Subject: [PATCH] docs-1564 various changes to install/configure --- advocacy_docs/pg_extensions/otel/configuring.mdx | 7 ++++--- advocacy_docs/pg_extensions/otel/installing.mdx | 14 +++++++++++--- .../pg_extensions/otel/rel_notes/index.mdx | 2 +- 3 files changed, 16 insertions(+), 7 deletions(-) diff --git a/advocacy_docs/pg_extensions/otel/configuring.mdx b/advocacy_docs/pg_extensions/otel/configuring.mdx index 455fba51621..338675784a7 100644 --- a/advocacy_docs/pg_extensions/otel/configuring.mdx +++ b/advocacy_docs/pg_extensions/otel/configuring.mdx @@ -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 @@ -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). diff --git a/advocacy_docs/pg_extensions/otel/installing.mdx b/advocacy_docs/pg_extensions/otel/installing.mdx index 810e0d7d41b..c9e9b1ccd70 100644 --- a/advocacy_docs/pg_extensions/otel/installing.mdx +++ b/advocacy_docs/pg_extensions/otel/installing.mdx @@ -36,7 +36,7 @@ The syntax to install edb_otel on EDB Postgres Advanced Server and EDB Postgres sudo -y install edb-as-edb_otel # For EDB Postgres Extended: -sudo -y install edb-postgresextended-edb_otel +sudo -y install edb-postgresextended-edb_otel ``` Where: @@ -50,17 +50,25 @@ Where: - `` 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_ +sudo dnf -y install edb-pg-edb_otel ``` Where `` is the version of PostgreSQL you're using. diff --git a/advocacy_docs/pg_extensions/otel/rel_notes/index.mdx b/advocacy_docs/pg_extensions/otel/rel_notes/index.mdx index f66a6ccaad1..5c31e7ad6ce 100644 --- a/advocacy_docs/pg_extensions/otel/rel_notes/index.mdx +++ b/advocacy_docs/pg_extensions/otel/rel_notes/index.mdx @@ -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 |