Skip to content

Commit

Permalink
Improve ENDPOINT docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@pellared
pellared committed Nov 6, 2023
1 parent 0297753 commit b70c015
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 14 deletions.
8 changes: 5 additions & 3 deletions exporters/otlp/otlpmetric/otlpmetricgrpc/doc.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,11 @@ Exporter should be created using [New] and used with a [metric.PeriodicReader].
The environment variables described below can be used for configuration.
OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_METRICS_ENDPOINT (default: "https://localhost:4317") -
target URL to which the exporter sends telemtry.
The value must be a valid URL with scheme ("http" or "https") and host,
The value may additionally contain a port and a path.
target to which the exporter sends telemetry.
The target syntax is defined in https://github.com/grpc/grpc/blob/master/doc/naming.md.
The value must contain a host.
The value may additionally a port, a scheme, and a path.
The value accepts "http" and "https" scheme.
The value should not contain a query string or fragment.
OTEL_EXPORTER_OTLP_METRICS_ENDPOINT takes precedence over OTEL_EXPORTER_OTLP_ENDPOINT.
The configuration can be overridden by [WithEndpoint], [WithInsecure], [WithGRPCConn] options.
Expand Down
8 changes: 4 additions & 4 deletions exporters/otlp/otlpmetric/otlpmetrichttp/doc.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ Exporter should be created using [New] and used with a [metric.PeriodicReader].
The environment variables described below can be used for configuration.
OTEL_EXPORTER_OTLP_ENDPOINT (default: "https://localhost:4318") -
target base URL ("/v1/metrics" is appended) to which the exporter sends telemtry.
The value must be a valid URL with scheme ("http" or "https") and host,
target base URL ("/v1/metrics" is appended) to which the exporter sends telemetry.
The value must contain a scheme ("http" or "https") and host.
The value may additionally contain a port and a path.
The value should not contain a query string or fragment.
The configuration can be overridden by OTEL_EXPORTER_OTLP_METRICS_ENDPOINT
environment variable and by [WithEndpoint], [WithInsecure] options.
OTEL_EXPORTER_OTLP_METRICS_ENDPOINT (default: "https://localhost:4318/v1/metrics") -
target URL to which the exporter sends telemtry.
The value must be a valid URL with scheme ("http" or "https") and host,
target URL to which the exporter sends telemetry.
The value must contain a scheme ("http" or "https") and host.
The value may additionally contain a port and a path.
The value should not contain a query string or fragment.
The configuration can be overridden by [WithEndpoint], [WitnInsecure], [WithURLPath] options.
Expand Down
8 changes: 5 additions & 3 deletions exporters/otlp/otlptrace/otlptracegrpc/doc.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,11 @@ Exporter should be created using [New].
The environment variables described below can be used for configuration.
OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_TRACES_ENDPOINT (default: "https://localhost:4317") -
target URL to which the exporter sends telemtry.
The value must be a valid URL with scheme ("http" or "https") and host,
The value may additionally contain a port and a path.
target to which the exporter sends telemetry.
The target syntax is defined in https://github.com/grpc/grpc/blob/master/doc/naming.md.
The value must contain a host.
The value may additionally a port, a scheme, and a path.
The value accepts "http" and "https" scheme.
The value should not contain a query string or fragment.
OTEL_EXPORTER_OTLP_TRACES_ENDPOINT takes precedence over OTEL_EXPORTER_OTLP_ENDPOINT.
The configuration can be overridden by [WithEndpoint], [WithInsecure], [WithGRPCConn] options.
Expand Down
8 changes: 4 additions & 4 deletions exporters/otlp/otlptrace/otlptracehttp/doc.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ Exporter should be created using [New].
The environment variables described below can be used for configuration.
OTEL_EXPORTER_OTLP_ENDPOINT (default: "https://localhost:4318") -
target base URL ("/v1/traces" is appended) to which the exporter sends telemtry.
The value must be a valid URL with scheme ("http" or "https") and host,
target base URL ("/v1/traces" is appended) to which the exporter sends telemetry.
The value must contain a scheme ("http" or "https") and host.
The value may additionally contain a port and a path.
The value should not contain a query string or fragment.
The configuration can be overridden by OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
environment variable and by [WithEndpoint], [WithInsecure] options.
OTEL_EXPORTER_OTLP_TRACES_ENDPOINT (default: "https://localhost:4318/v1/traces") -
target URL to which the exporter sends telemtry.
The value must be a valid URL with scheme ("http" or "https") and host,
target URL to which the exporter sends telemetry.
The value must contain a scheme ("http" or "https") and host.
The value may additionally contain a port and a path.
The value should not contain a query string or fragment.
The configuration can be overridden by [WithEndpoint], [WitnInsecure], [WithURLPath] options.
Expand Down

0 comments on commit b70c015

Please sign in to comment.