Skip to content

Commit

Permalink
add note about tracing's experimental status in godoc
Browse files Browse the repository at this point in the history
  • Loading branch information
guseggert committed Mar 24, 2022
1 parent 74bfbb3 commit ca46ca5
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions tracing/doc.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
// Package tracing contains the tracing logic for go-ipfs, including configuring the tracer and
// helping keep consistent naming conventions across the stack.
//
// NOTE: Tracing is currently experimental. Span names may change unexpectedly, spans may be removed,
// and backwards-incompatible changes may be made to tracing configuration, options, and defaults.
//
// go-ipfs uses OpenTelemetry as its tracing API, and when possible, standard OpenTelemetry environment
// variables can be used to configure it. Multiple exporters can also be installed simultaneously,
// including one that writes traces to a JSON file on disk.
Expand Down Expand Up @@ -56,8 +59,8 @@
//
// Span names follow a convention of <Component>.<Span>, some examples:
//
// - component=Gateway + span=Request = Gateway.Request
// - component=CoreAPI.PinAPI + span=Verify.CheckPin = CoreAPI.PinAPI.Verify.CheckPin
// - component=Gateway + span=Request -> Gateway.Request
// - component=CoreAPI.PinAPI + span=Verify.CheckPin -> CoreAPI.PinAPI.Verify.CheckPin
//
// We follow the OpenTelemetry convention of using whatever TracerProvider is registered globally.
package tracing

0 comments on commit ca46ca5

Please sign in to comment.