mirror of
https://github.com/golang/go
synced 2024-11-06 03:16:10 -07:00
046aa1cdaf
This adds a type to events and makes the logging calls use it. Change-Id: Iaa50fe2e332caae611b1e00424c878a3bc479feb Reviewed-on: https://go-review.googlesource.com/c/tools/+/221741 Run-TryBot: Ian Cottrell <iancottrell@google.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Robert Findley <rfindley@google.com> Reviewed-by: Emmanuel Odeke <emm.odeke@gmail.com>
109 lines
2.6 KiB
Go
109 lines
2.6 KiB
Go
// Copyright 2019 The Go Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
// Package export holds the definition of the telemetry Exporter interface,
|
|
// along with some simple implementations.
|
|
// Larger more complex exporters are in sub packages of their own.
|
|
package export
|
|
|
|
import (
|
|
"context"
|
|
"os"
|
|
"sync/atomic"
|
|
"time"
|
|
"unsafe"
|
|
|
|
"golang.org/x/tools/internal/telemetry"
|
|
)
|
|
|
|
type Exporter interface {
|
|
// ProcessEvent is a function that handles all events.
|
|
// Exporters may use information in the context to decide what to do with a
|
|
// given event.
|
|
ProcessEvent(context.Context, telemetry.Event) context.Context
|
|
|
|
StartSpan(context.Context, *telemetry.Span)
|
|
FinishSpan(context.Context, *telemetry.Span)
|
|
|
|
Metric(context.Context, telemetry.MetricData)
|
|
}
|
|
|
|
var (
|
|
exporter unsafe.Pointer
|
|
)
|
|
|
|
func init() {
|
|
SetExporter(LogWriter(os.Stderr, true))
|
|
}
|
|
|
|
func SetExporter(e Exporter) {
|
|
p := unsafe.Pointer(&e)
|
|
if e == nil {
|
|
p = nil
|
|
}
|
|
atomic.StorePointer(&exporter, p)
|
|
}
|
|
|
|
func StartSpan(ctx context.Context, span *telemetry.Span, at time.Time) {
|
|
exporterPtr := (*Exporter)(atomic.LoadPointer(&exporter))
|
|
if exporterPtr == nil {
|
|
return
|
|
}
|
|
span.Start = at
|
|
(*exporterPtr).StartSpan(ctx, span)
|
|
}
|
|
|
|
func FinishSpan(ctx context.Context, span *telemetry.Span, at time.Time) {
|
|
exporterPtr := (*Exporter)(atomic.LoadPointer(&exporter))
|
|
if exporterPtr == nil {
|
|
return
|
|
}
|
|
span.Finish = at
|
|
(*exporterPtr).FinishSpan(ctx, span)
|
|
}
|
|
|
|
func Tag(ctx context.Context, at time.Time, tags telemetry.TagList) {
|
|
exporterPtr := (*Exporter)(atomic.LoadPointer(&exporter))
|
|
if exporterPtr == nil {
|
|
return
|
|
}
|
|
// If context has a span we need to add the tags to it
|
|
span := telemetry.GetSpan(ctx)
|
|
if span == nil {
|
|
return
|
|
}
|
|
if span.Start.IsZero() {
|
|
// span still being created, tag it directly
|
|
span.Tags = append(span.Tags, tags...)
|
|
return
|
|
}
|
|
// span in progress, add an event to the span
|
|
span.Events = append(span.Events, telemetry.Event{
|
|
At: at,
|
|
Tags: tags,
|
|
})
|
|
}
|
|
|
|
func ProcessEvent(ctx context.Context, event telemetry.Event) context.Context {
|
|
exporterPtr := (*Exporter)(atomic.LoadPointer(&exporter))
|
|
if exporterPtr == nil {
|
|
return ctx
|
|
}
|
|
// If context has a span we need to add the event to it
|
|
span := telemetry.GetSpan(ctx)
|
|
if span != nil {
|
|
span.Events = append(span.Events, event)
|
|
}
|
|
// and now also hand the event of to the current exporter
|
|
return (*exporterPtr).ProcessEvent(ctx, event)
|
|
}
|
|
|
|
func Metric(ctx context.Context, data telemetry.MetricData) {
|
|
exporterPtr := (*Exporter)(atomic.LoadPointer(&exporter))
|
|
if exporterPtr == nil {
|
|
return
|
|
}
|
|
(*exporterPtr).Metric(ctx, data)
|
|
}
|