From dbe3dcf820b6cf4d599915ed08a2064c2e3e5edc Mon Sep 17 00:00:00 2001 From: Ilya Priven Date: Tue, 17 Sep 2024 21:46:23 +0100 Subject: [PATCH 1/2] Document OtelCollectorExporter.otel property --- packages/core-bridge/ts/index.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/packages/core-bridge/ts/index.ts b/packages/core-bridge/ts/index.ts index cab6261f5..6df54bd89 100644 --- a/packages/core-bridge/ts/index.ts +++ b/packages/core-bridge/ts/index.ts @@ -133,6 +133,9 @@ export interface OtelCollectorExporter { otel: { /** * URL of a gRPC OpenTelemetry collector. + * + * @format Starts with "grpc://" or "http://" for an unsecured (typical), or "grpcs://" or "https://" for a TLS connection. + * @note This URL can be overridden in runtime by the `OTEL_EXPORTER_OTLP_ENDPOINT` environment variable. */ url: string; /** From 01a5d39104e29a97b85f89ceb6863e2802bd449a Mon Sep 17 00:00:00 2001 From: Ilya Priven Date: Sun, 22 Sep 2024 17:22:23 -0400 Subject: [PATCH 2/2] Update index.ts --- packages/core-bridge/ts/index.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/core-bridge/ts/index.ts b/packages/core-bridge/ts/index.ts index 6df54bd89..9c7d4235b 100644 --- a/packages/core-bridge/ts/index.ts +++ b/packages/core-bridge/ts/index.ts @@ -134,8 +134,8 @@ export interface OtelCollectorExporter { /** * URL of a gRPC OpenTelemetry collector. * - * @format Starts with "grpc://" or "http://" for an unsecured (typical), or "grpcs://" or "https://" for a TLS connection. - * @note This URL can be overridden in runtime by the `OTEL_EXPORTER_OTLP_ENDPOINT` environment variable. + * @format Starts with "grpc://" or "http://" for an unsecured connection (typical), or "grpcs://" or "https://" for a TLS connection. + * @note The `OTEL_EXPORTER_OTLP_ENDPOINT` environment variable, if set, will override this property. */ url: string; /**