Skip to content

Commit

Permalink
Merge pull request #741 from iRevive/docs/update-config-link
Browse files Browse the repository at this point in the history
docs: update OpenTelemetry configuration links [no ci]
  • Loading branch information
iRevive authored Aug 30, 2024
2 parents 3bbbdda + 6ae9253 commit eaf58ae
Show file tree
Hide file tree
Showing 16 changed files with 23 additions and 23 deletions.
2 changes: 1 addition & 1 deletion docs/customization/histogram-custom-buckets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Add directives to the `histogram-buckets.scala`:

As mentioned above, we use `otel.service.name` system properties to configure the OpenTelemetry SDK.
The SDK can be configured via environment variables too. Check the full list
of [environment variable configurations](https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md)
of [environment variable configurations](https://opentelemetry.io/docs/languages/java/configuration/)
for more options.

### OpenTelemetry Autoconfigure extension customization
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/grafana/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Add directives to the `grafana.scala`:
As mentioned above, we use `otel.service.name` and `otel.metrics.exporter` system properties to configure the
OpenTelemetry SDK.
The SDK can be configured via environment variables too. Check the full list
of [environment variable configurations](https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md)
of [environment variable configurations](https://opentelemetry.io/docs/languages/java/configuration)
for more options.

### Observability stack configuration
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/honeycomb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Add directives to the `tracing.scala`:
As mentioned above, we use `otel.java.global-autoconfigure.enabled` and `otel.service.name` system properties to configure the
OpenTelemetry SDK.
The SDK can be configured via environment variables too. Check the full list
of [environment variable configurations](https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md)
of [environment variable configurations](https://opentelemetry.io/docs/languages/java/configuration)
for more options.

### Acquiring a Honeycomb API key
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/jaeger-docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Add directives to the `tracing.scala`:
As mentioned above, we use `otel.service.name` and `otel.metrics.exporter` system properties to configure the
OpenTelemetry SDK.
The SDK can be configured via environment variables too. Check the full list
of [environment variable configurations](https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md)
of [environment variable configurations](https://opentelemetry.io/docs/languages/java/configuration)
for more options.

### Jaeger configuration
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,6 @@ val io: IO[Unit] = program[IO]

[cats-effect]: https://typelevel.org/cats-effect/
[opentelemetry-java]: https://github.com/open-telemetry/opentelemetry-java/tree/main/api/all
[opentelemetry-java-autoconfigure]: https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md
[opentelemetry-java-autoconfigure]: https://opentelemetry.io/docs/languages/java/configuration/
[otel]: https://opentelemetry.io/
[otel spec]: https://opentelemetry.io/docs/reference/specification/
2 changes: 1 addition & 1 deletion docs/instrumentation/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,4 +196,4 @@ object CatsEffectMetrics {
```

[opentelemetry-java]: https://github.com/open-telemetry/opentelemetry-java
[opentelemetry-java-autoconfigure]: https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md
[opentelemetry-java-autoconfigure]: https://opentelemetry.io/docs/languages/java/configuration/
2 changes: 1 addition & 1 deletion docs/instrumentation/tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,4 +158,4 @@ class InternalUserService[F[_]: Tracer](repo: UserRepository[F]) {
```

[opentelemetry-java]: https://github.com/open-telemetry/opentelemetry-java
[opentelemetry-java-autoconfigure]: https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md
[opentelemetry-java-autoconfigure]: https://opentelemetry.io/docs/languages/java/configuration/
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ import scala.concurrent.duration.FiniteDuration
* }}}
*
* @see
* [[https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#otlp-exporter-span-metric-and-log-exporters]]
* [[https://opentelemetry.io/docs/languages/java/configuration/#otlp-exporter-span-metric-and-log-exporters]]
*/
private final class OtlpHttpClientAutoConfigure[
F[_]: Async: Network: Compression: Console,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ object OpenTelemetrySdk {
/** The auto-configured [[OpenTelemetrySdk]].
*
* @see
* [[https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md]]
* [[https://typelevel.org/otel4s/sdk/configuration.html]]
*
* @tparam F
* the higher-kinded type of a polymorphic effect
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ import java.nio.charset.StandardCharsets
* }}}
*
* @see
* [[https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#opentelemetry-resource]]
* [[https://opentelemetry.io/docs/languages/java/configuration/#resources]]
*
* @param extraDetectors
* the extra detectors to use
Expand Down Expand Up @@ -223,7 +223,7 @@ private[sdk] object TelemetryResourceAutoConfigure {
* }}}
*
* @see
* [[https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#opentelemetry-resource]]
* [[https://opentelemetry.io/docs/languages/java/configuration/#resources]]
*
* @param extraDetectors
* the extra detectors to use
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import org.typelevel.otel4s.sdk.metrics.exemplar.TraceContextLookup
* - `trace_based` - [[ExemplarFilter.traceBased]]
*
* @see
* [[https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#exemplars]]
* [[https://opentelemetry.io/docs/languages/java/configuration/#exemplars]]
*/
private final class ExemplarFilterAutoConfigure[F[_]: MonadThrow](
lookup: TraceContextLookup
Expand Down Expand Up @@ -113,7 +113,7 @@ private[sdk] object ExemplarFilterAutoConfigure {
* - `trace_based` - [[ExemplarFilter.traceBased]]
*
* @see
* [[https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#exemplars]]
* [[https://opentelemetry.io/docs/languages/java/configuration/#exemplars]]
*
* @param traceContextLookup
* used by the exemplar reservoir to extract tracing information from the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import org.typelevel.otel4s.sdk.metrics.exporter.MetricExporter
* }}}
*
* @see
* [[https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#metric-exporters]]
* [[https://opentelemetry.io/docs/languages/java/configuration/#metric-exporters]]
*/
private final class MetricExportersAutoConfigure[F[_]: MonadThrow: Console](
extra: Set[AutoConfigure.Named[F, MetricExporter[F]]]
Expand Down Expand Up @@ -157,7 +157,7 @@ private[sdk] object MetricExportersAutoConfigure {
* }}}
*
* @see
* [[https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#metric-exporters]]
* [[https://opentelemetry.io/docs/languages/java/configuration/#metric-exporters]]
*
* @param configurers
* the configurers to use
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ import scala.concurrent.duration.FiniteDuration
* }}}
*
* @see
* [[https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#batch-span-processor]]
* [[https://opentelemetry.io/docs/languages/java/configuration/#batch-span-processor]]
*
* @param exporter
* the exporter to use with the configured batch span processor
Expand Down Expand Up @@ -125,7 +125,7 @@ private[sdk] object BatchSpanProcessorAutoConfigure {
* }}}
*
* @see
* [[https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#batch-span-processor]]
* [[https://opentelemetry.io/docs/languages/java/configuration/#batch-span-processor]]
*
* @param exporter
* the exporter to use with the configured batch span processor
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ import org.typelevel.otel4s.sdk.trace.context.propagation.W3CTraceContextPropaga
* }}}
*
* @see
* [[https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#propagator]]
* [[https://opentelemetry.io/docs/languages/java/configuration/#propagators]]
*/
private final class ContextPropagatorsAutoConfigure[F[_]: MonadThrow](
extra: Set[AutoConfigure.Named[F, TextMapPropagator[Context]]]
Expand Down Expand Up @@ -144,7 +144,7 @@ private[sdk] object ContextPropagatorsAutoConfigure {
* - [[OtTracePropagator ottrace]]
*
* @see
* [[https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#propagator]]
* [[https://opentelemetry.io/docs/languages/java/configuration/#propagators]]
*
* @param extra
* extra configurers to use
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ import org.typelevel.otel4s.sdk.trace.samplers.Sampler
* }}}
*
* @see
* [[https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#sampler]]
* [[https://opentelemetry.io/docs/languages/java/configuration/#sampler]]
*/
private final class SamplerAutoConfigure[F[_]: MonadThrow](
extra: Set[AutoConfigure.Named[F, Sampler]]
Expand Down Expand Up @@ -161,7 +161,7 @@ private[sdk] object SamplerAutoConfigure {
* the ratio
*
* @see
* [[https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#sampler]]
* [[https://opentelemetry.io/docs/languages/java/configuration/#sampler]]
*/
def apply[F[_]: MonadThrow](
extra: Set[AutoConfigure.Named[F, Sampler]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import org.typelevel.otel4s.sdk.trace.exporter.SpanExporter
* }}}
*
* @see
* [[https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#span-exporters]]
* [[https://opentelemetry.io/docs/languages/java/configuration/#span-exporters]]
*/
private final class SpanExportersAutoConfigure[F[_]: MonadThrow: Console](
extra: Set[AutoConfigure.Named[F, SpanExporter[F]]]
Expand Down Expand Up @@ -152,7 +152,7 @@ private[sdk] object SpanExportersAutoConfigure {
* }}}
*
* @see
* [[https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#span-exporters]]
* [[https://opentelemetry.io/docs/languages/java/configuration/#span-exporters]]
*
* @param configurers
* the configurers to use
Expand Down

0 comments on commit eaf58ae

Please sign in to comment.