README
¶
Jaeger Remote Sampler
This package implements Jaeger remote sampler.
Example
example/ shows how to host remote sampling strategies using the OpenTelemetry Collector. The Collector uses the Jaeger receiver to host the strategy file. Note you do not need to run Jaeger to make use of the Jaeger remote sampling protocol. However, you do need Jaeger backend if you want to utilize its adaptive sampling engine that auto-calculates remote sampling strategies.
Run the OpenTelemetry Collector using docker-compose:
$ docker-compose up -d
You can fetch the strategy file using curl:
$ curl 'localhost:5778/sampling?service=foo'
$ curl 'localhost:5778/sampling?service=myService'
Run the Go program. This program will start with an initial sampling percentage of 50% and tries to fetch the sampling strategies from the OpenTelemetry Collector. It will print the entire Jaeger remote sampler structure every 10 seconds, this allows you to observe the internal sampler.
$ go run .
Update generated Jaeger code
Code is generated using the .proto files from jaeger-idl. In case sampling.proto is modified these have to be regenerated.
$ make proto-gen
Documentation
¶
Overview ¶
Package jaegerremote implements the Jaeger Remote protocol.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func SemVersion ¶
func SemVersion() string
SemVersion is the semantic version to be supplied to tracer/meter creation.
Types ¶
type Option ¶
type Option interface {
// contains filtered or unexported methods
}
Option applies configuration settings to a Sampler.
func WithInitialSampler ¶
WithInitialSampler creates a Option that sets the initial sampler to use before a remote sampler is created and used.
func WithMaxOperations ¶
WithMaxOperations creates a Option that sets the maximum number of operations the sampler will keep track of.
func WithOperationNameLateBinding ¶
WithOperationNameLateBinding creates a Option that sets the respective field in the perOperationSamplerParams.
func WithSamplingRefreshInterval ¶
WithSamplingRefreshInterval creates a Option that sets how often the sampler will poll local agent for the appropriate sampling strategy.
func WithSamplingServerURL ¶
WithSamplingServerURL creates a Option that sets the sampling server url of the local agent that contains the sampling strategies.
type Sampler ¶
type Sampler struct {
sync.RWMutex // used to serialize access to samplerConfig.sampler
// contains filtered or unexported fields
}
Sampler is a delegating sampler that polls a remote server for the appropriate sampling strategy, constructs a corresponding sampler and delegates to it for sampling decisions.
func New ¶
New creates a sampler that periodically pulls the sampling strategy from an HTTP sampling server (e.g. jaeger-agent).
func (*Sampler) Close ¶
func (s *Sampler) Close()
Close does a clean shutdown of the sampler, stopping any background go-routines it may have started.
func (*Sampler) Description ¶
Description returns a human-readable name for the Sampler.
func (*Sampler) ShouldSample ¶
func (s *Sampler) ShouldSample(p trace.SamplingParameters) trace.SamplingResult
ShouldSample returns a sampling choice based on the passed sampling parameters.
func (*Sampler) UpdateSampler ¶
func (s *Sampler) UpdateSampler()
UpdateSampler forces the sampler to fetch sampling strategy from backend server. This function is called automatically on a timer, but can also be safely called manually, e.g. from tests.
Source Files
Directories