Documentation
¶
Index ¶
- type Option
- type Receiver
- func (ocr *Receiver) Start(ctx context.Context, ts receiver.TraceReceiverSink, ...) error
- func (ocr *Receiver) StartMetricsReception(ctx context.Context, ms receiver.MetricsReceiverSink) error
- func (ocr *Receiver) StartTraceReception(ctx context.Context, ts receiver.TraceReceiverSink) error
- func (ocr *Receiver) Stop() error
- func (ocr *Receiver) StopMetricsReception(ctx context.Context) error
- func (ocr *Receiver) StopTraceReception(ctx context.Context) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Option ¶ added in v0.1.0
type Option interface {
// contains filtered or unexported methods
}
Option interface defines for configuration settings to be applied to receivers.
withReceiver applies the configuration to the given receiver.
func WithCorsOrigins ¶ added in v0.1.0
WithCorsOrigins is an option to specify the allowed origins to enable writing HTTP/JSON requests to the grpc-gateway adapter using CORS.
func WithMetricsReceiverOptions ¶ added in v0.1.0
WithMetricsReceiverOptions is an option to specify the options that will be passed to the New call for ocmetrics.Receiver
func WithTraceReceiverOptions ¶ added in v0.1.0
WithTraceReceiverOptions is an option to specify the options that will be passed to the New call for octrace.Receiver
type Receiver ¶ added in v0.0.4
type Receiver struct {
// contains filtered or unexported fields
}
Receiver is the type that exposes Trace and Metrics reception.
func New ¶
New just creates the OpenCensus receiver services. It is the caller's responsibility to invoke the respective Start*Reception methods as well as the various Stop*Reception methods or simply Stop to end it.
func (*Receiver) Start ¶ added in v0.0.4
func (ocr *Receiver) Start(ctx context.Context, ts receiver.TraceReceiverSink, ms receiver.MetricsReceiverSink) error
Start runs all the receivers/services namely, Trace and Metrics services.
func (*Receiver) StartMetricsReception ¶ added in v0.0.4
func (ocr *Receiver) StartMetricsReception(ctx context.Context, ms receiver.MetricsReceiverSink) error
StartMetricsReception exclusively runs the Metrics receiver on the gRPC server. To start both Trace and Metrics receivers/services, please use Start.
func (*Receiver) StartTraceReception ¶ added in v0.0.4
StartTraceReception exclusively runs the Trace receiver on the gRPC server. To start both Trace and Metrics receivers/services, please use Start.
func (*Receiver) Stop ¶ added in v0.0.4
Stop stops the underlying gRPC server and all the services running on it.
func (*Receiver) StopMetricsReception ¶ added in v0.0.4
StopMetricsReception is a method to turn off receiving metrics. It currently is a noop because we don't yet know if gRPC allows stopping a specific service.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package ocmetrics is the logic for receiving OpenCensus metrics proto from already instrumented applications and then passing them onto a metricsink instance.
|
Package ocmetrics is the logic for receiving OpenCensus metrics proto from already instrumented applications and then passing them onto a metricsink instance. |
|
Package octrace is the logic for receiving OpenCensus trace protobuf defined spans from already instrumented applications and then passing them onto a TraceReceiverSink instance.
|
Package octrace is the logic for receiving OpenCensus trace protobuf defined spans from already instrumented applications and then passing them onto a TraceReceiverSink instance. |