Skip to content

Commit e1979b3

Browse files
authored
Merge pull request #6856 from EnterpriseDB/extensions-docs-1564-otel-updates-may
docs-1564 various changes to Otel install/configure
2 parents 93acb53 + 634ea80 commit e1979b3

File tree

3 files changed

+16
-7
lines changed

3 files changed

+16
-7
lines changed

advocacy_docs/pg_extensions/otel/configuring.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ No permissions changes are required for edb_otel.
1111

1212
## Prerequisites
1313

14-
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).
14+
The following prerequisites must be completed before using edb_otel to export metrics:
15+
16+
- 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).
17+
- Install the pg_cron extension to schedule jobs for the pg_exporter.
1518

1619
## GUCs
1720

@@ -91,5 +94,3 @@ The `edb_otel_metric` function has the following parameters.
9194
!!!Note
9295
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.
9396
!!!
94-
95-
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).

advocacy_docs/pg_extensions/otel/installing.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The syntax to install edb_otel on EDB Postgres Advanced Server and EDB Postgres
4141
sudo <package-manager> -y install edb-as<postgres_version>-edb_otel
4242

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

4747
Where:
@@ -55,17 +55,25 @@ Where:
5555

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

58-
For example, to install the latest version of edb_otel for EDB Postgres Advanced Server 17 on a RHEL 9 platform:
58+
Examples:
59+
60+
To install the latest version of edb_otel for EDB Postgres Advanced Server 17 on a RHEL 9 platform:
5961

6062
```shell
6163
sudo dnf -y install edb-as17-edb_otel
6264
```
6365

66+
To install the latest version of edb_otel for EDB Postgres Extended 17 on a RHEL 9 platform:
67+
68+
```shell
69+
sudo dnf -y install edb-postgresextended17-edb_otel
70+
```
71+
6472
The syntax to install edb_otel on PostgreSQL is:
6573

6674
```shell
6775
# For RHEL 9 and its derivatives:
68-
sudo dnf -y install edb_otel_<postgres_version>
76+
sudo dnf -y install edb-pg<postgres_version>-edb_otel
6977
```
7078

7179
Where `<postgres_version>` is the version of PostgreSQL you're using.

advocacy_docs/pg_extensions/otel/rel_notes/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ The edb_otel documentation describes the latest version of edb_otel, including m
88

99
| Version | Release date |
1010
| -------------------------------- | ------------ |
11-
| [1.0.0](edb_otel_1.0.0_rel_notes) | 04 March 2025 |
11+
| [1.0.0](edb_otel_1.0.0_rel_notes) | 28 March 2025 |
1212

0 commit comments

Comments
 (0)