package b3

Import Path
	go.opencensus.io/plugin/ochttp/propagation/b3 (on go.dev)

Dependency Relation
	imports 4 packages, and imported by one package

Involved Source Files

	   d➜ b3.go
		Package b3 contains a propagation.HTTPFormat implementation
		for B3 propagation. See https://github.com/openzipkin/b3-propagation
		for more details.
Package-Level Type Names (only one, which is exported)

	/* sort exporteds by: alphabet | popularity */
	 type HTTPFormat (struct)
		HTTPFormat implements propagation.HTTPFormat to propagate
		traces in HTTP headers in B3 propagation format.
		HTTPFormat skips the X-B3-ParentId and X-B3-Flags headers
		because there are additional fields not represented in the
		OpenCensus span context. Spans created from the incoming
		header will be the direct children of the client-side span.
		Similarly, receiver of the outgoing spans should use client-side
		span created by OpenCensus as the parent.

		Methods (total 2, both are exported)
			(*T) SpanContextFromRequest(req *http.Request) (sc trace.SpanContext, ok bool)
				SpanContextFromRequest extracts a B3 span context from incoming requests.

			(*T) SpanContextToRequest(sc trace.SpanContext, req *http.Request)
				SpanContextToRequest modifies the given request to include B3 headers.

		Implements (at least one exported)
			*T : go.opencensus.io/trace/propagation.HTTPFormat


Package-Level Functions (total 3, all are exported)

	 func ParseSampled(sampled string) (trace.TraceOptions, bool)
		ParseSampled parses the value of the X-B3-Sampled header.

	 func ParseSpanID(sid string) (spanID trace.SpanID, ok bool)
		ParseSpanID parses the value of the X-B3-SpanId or X-B3-ParentSpanId headers.

	 func ParseTraceID(tid string) (trace.TraceID, bool)
		ParseTraceID parses the value of the X-B3-TraceId header.


Package-Level Constants (total 3, all are exported)

	const SampledHeader = "X-B3-Sampled"
		B3 headers that OpenCensus understands.

	const SpanIDHeader = "X-B3-SpanId"
		B3 headers that OpenCensus understands.

	const TraceIDHeader = "X-B3-TraceId"
		B3 headers that OpenCensus understands.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.