You've already forked opentelemetry-go
mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2025-07-15 01:04:25 +02:00
[website_docs] Update path to spec, run formatter (#4084)
Co-authored-by: Chester Cheung <cheung.zhy.csu@gmail.com>
This commit is contained in:
@ -150,10 +150,10 @@ Any [Maintainer] can merge the PR once the above criteria have been met.
|
||||
## Design Choices
|
||||
|
||||
As with other OpenTelemetry clients, opentelemetry-go follows the
|
||||
[OpenTelemetry Specification](https://opentelemetry.io/docs/reference/specification).
|
||||
[OpenTelemetry Specification](https://opentelemetry.io/docs/specs/otel).
|
||||
|
||||
It's especially valuable to read through the [library
|
||||
guidelines](https://opentelemetry.io/docs/reference/specification/library-guidelines).
|
||||
guidelines](https://opentelemetry.io/docs/specs/otel/library-guidelines).
|
||||
|
||||
### Focus on Capabilities, Not Structure Compliance
|
||||
|
||||
|
@ -10,7 +10,8 @@ and metrics, you will need to export them to a backend.
|
||||
## OTLP endpoint
|
||||
|
||||
To send trace data to an OTLP endpoint (like the [collector](/docs/collector) or
|
||||
Jaeger >= v1.35.0) you'll want to configure an OTLP exporter that sends to your endpoint.
|
||||
Jaeger >= v1.35.0) you'll want to configure an OTLP exporter that sends to your
|
||||
endpoint.
|
||||
|
||||
### Using HTTP
|
||||
|
||||
@ -30,12 +31,13 @@ func installExportPipeline(ctx context.Context) (func(context.Context) error, er
|
||||
}
|
||||
```
|
||||
|
||||
To learn more on how to use the OTLP HTTP exporter, try out the [otel-collector](https://github.com/open-telemetry/opentelemetry-go/tree/main/example/otel-collector)
|
||||
To learn more on how to use the OTLP HTTP exporter, try out the
|
||||
[otel-collector](https://github.com/open-telemetry/opentelemetry-go/tree/main/example/otel-collector)
|
||||
|
||||
### Jaeger
|
||||
|
||||
To try out the OTLP exporter, since v1.35.0 you can run
|
||||
[Jaeger](https://www.jaegertracing.io/) as an OTLP endpoint and for trace
|
||||
[Jaeger](https://www.jaegertracing.io/) as an OTLP endpoint and for trace
|
||||
visualization in a docker container:
|
||||
|
||||
```shell
|
||||
@ -48,6 +50,8 @@ docker run -d --name jaeger \
|
||||
|
||||
## Prometheus
|
||||
|
||||
Prometheus export is available in the `go.opentelemetry.io/otel/exporters/prometheus` package.
|
||||
Prometheus export is available in the
|
||||
`go.opentelemetry.io/otel/exporters/prometheus` package.
|
||||
|
||||
Please find more documentation on [GitHub](https://github.com/open-telemetry/opentelemetry-go/tree/main/exporters/prometheus)
|
||||
Please find more documentation on
|
||||
[GitHub](https://github.com/open-telemetry/opentelemetry-go/tree/main/exporters/prometheus)
|
||||
|
@ -190,8 +190,8 @@ With the imports added, you can start instrumenting.
|
||||
The OpenTelemetry Tracing API provides a [`Tracer`] to create traces. These
|
||||
[`Tracer`]s are designed to be associated with one instrumentation library. That
|
||||
way telemetry they produce can be understood to come from that part of a code
|
||||
base. To uniquely identify your application to the [`Tracer`] you will
|
||||
create a constant with the package name in `app.go`.
|
||||
base. To uniquely identify your application to the [`Tracer`] you will create a
|
||||
constant with the package name in `app.go`.
|
||||
|
||||
```go
|
||||
// name is the Tracer name used to identify this instrumentation library.
|
||||
|
@ -9,7 +9,7 @@ weight: 3
|
||||
|
||||
Go does not support truly automatic instrumentation like other languages today.
|
||||
Instead, you'll need to depend on
|
||||
[instrumentation libraries](/docs/reference/specification/glossary/#instrumentation-library)
|
||||
[instrumentation libraries](/docs/specs/otel/glossary/#instrumentation-library)
|
||||
that generate telemetry data for a particular instrumented library. For example,
|
||||
the instrumentation library for `net/http` will automatically create spans that
|
||||
track inbound and outbound requests once you configure it in your code.
|
||||
|
@ -297,7 +297,6 @@ After configuring context propagation, you'll most likely want to use automatic
|
||||
instrumentation to handle the behind-the-scenes work of actually managing
|
||||
serializing the context.
|
||||
|
||||
[opentelemetry specification]: /docs/reference/specification/
|
||||
[trace semantic conventions]:
|
||||
/docs/reference/specification/trace/semantic_conventions/
|
||||
[opentelemetry specification]: /docs/specs/otel/
|
||||
[trace semantic conventions]: /docs/specs/otel/trace/semantic_conventions/
|
||||
[instrumentation library]: ../libraries/
|
||||
|
Reference in New Issue
Block a user