internal

Documentation

Index

• Variables
• func CombineErrors(errs []error) error
• func ContextWithReceiverName(ctx context.Context, receiverName string) context.Context
• func GRPCServerWithObservabilityEnabled(extraOpts ...grpc.ServerOption) *grpc.Server
• func NewExportedSpansRecorder(exporterName string) func(context.Context, *commonpb.Node, []*tracepb.Span)
• func NewReceivedSpansRecorderStreaming(lifetimeCtx context.Context, receiverName string) func(*commonpb.Node, []*tracepb.Span)
• func SetParentLink(sideCtx context.Context, span *trace.Span) bool
• func TimeToTimestamp(t time.Time) *timestamp.Timestamp
• type Service
  • func ParseEndpointFile() (*Service, error)
  • func (s *Service) WriteToEndpointFile() (path string, err error)

Variables

var AllViews = []*view.View{
	ViewReceivedSpansReceiver,
	ViewExportedSpans,
}

AllViews has the views for the metrics provided by the agent.

var ViewExportedSpans = &view.View{
	Name:        "oc.io/receiver/exported_spans",
	Description: "Tracks the number of exported spans",
	Measure:     mExportedSpans,
	Aggregation: itemsDistribution,
	TagKeys:     []tag.Key{tagKeyExporterName},
}

ViewExportedSpans defines the view for exported spans metric.

var ViewReceivedSpansReceiver = &view.View{
	Name:        "oc.io/receiver/received_spans",
	Description: "The number of spans received by the receiver",
	Measure:     mReceivedSpans,
	Aggregation: itemsDistribution,
	TagKeys:     []tag.Key{tagKeyReceiverName},
}

ViewReceivedSpansReceiver defines the view for the received spans metric.

Functions

func CombineErrors

func CombineErrors(errs []error) error

CombineErrors converts a list of errors into one error.

func ContextWithReceiverName

func ContextWithReceiverName(ctx context.Context, receiverName string) context.Context

ContextWithReceiverName adds the tag "opencensus_receiver" and the name of the receiver as the value, and returns the newly created context.

func GRPCServerWithObservabilityEnabled

func GRPCServerWithObservabilityEnabled(extraOpts ...grpc.ServerOption) *grpc.Server

GRPCServerWithObservabilityEnabled creates a gRPC server that at a bare minimum has the OpenCensus ocgrpc server stats handler enabled for tracing and stats. Use it instead of invoking grpc.NewServer directly.

func NewExportedSpansRecorder

func NewExportedSpansRecorder(exporterName string) func(context.Context, *commonpb.Node, []*tracepb.Span)

NewExportedSpansRecorder creates a helper function that'll add the name of the creating exporter as a tag value in the context that will be used to count the the number of spans exported.

func NewReceivedSpansRecorderStreaming

func NewReceivedSpansRecorderStreaming(lifetimeCtx context.Context, receiverName string) func(*commonpb.Node, []*tracepb.Span)

NewReceivedSpansRecorderStreaming creates a function that uses a context created from the name of the receiver to record the number of the spans received by the receiver.

func SetParentLink

func SetParentLink(sideCtx context.Context, span *trace.Span) bool

SetParentLink tries to retrieve a span from sideCtx and if one exists sets its SpanID, TraceID as a link in the span provided. It returns true only if it retrieved a parent span from the context.

func TimeToTimestamp

func TimeToTimestamp(t time.Time) *timestamp.Timestamp

TimeToTimestamp converts a time.Time to a timestamp.Timestamp pointer.

Types

type Service

type Service struct {
	Endpoint string `json:"endpoint"`
}

Service contains metadata about the exporter service.

func ParseEndpointFile

func ParseEndpointFile() (*Service, error)

ParseEndpointFile reads and parses the canonical endpoint file for metadata.

func (*Service) WriteToEndpointFile

func (s *Service) WriteToEndpointFile() (path string, err error)

WriteToEndpointFile writes service metadata to canonical endpoint file.