trace

Documentation

Overview

Package trace defines common-use Dapper-style tracing APIs for the Go programming language.

Example

package main

import (
	"fmt"
	"time"

	"github.com/rakyll/trace"
)

func main() {
	trace.Start(func(s *trace.Span) {
		fmt.Printf("recorded span: %v\n", s)
	})

	s := trace.NewSpan("/foo")
	time.Sleep(time.Second)
	s.End()

	time.Sleep(time.Second)
}

Index

• func NewContext(ctx context.Context, span *Span) context.Context
• func Start(fn func(s *Span))
• func Stop()
• type Span
  • func FromContext(ctx context.Context) *Span
  • func NewSpan(name string) *Span
  • func (s *Span) End()
  • func (s *Span) ForLabels(f func(key, value string))
  • func (s *Span) NewChild(name string) *Span
  • func (s *Span) SetLabels(args ...string)

Examples

• Package

Functions

func NewContext

func NewContext(ctx context.Context, span *Span) context.Context

func Start

func Start(fn func(s *Span))

func Stop

func Stop()

Types

type Span

type Span struct {
	TraceID  []byte
	ParentID []byte
	ID       []byte

	Name      string
	StartTime time.Time
	EndTime   time.Time
	// contains filtered or unexported fields
}

func FromContext

func FromContext(ctx context.Context) *Span

func NewSpan

func NewSpan(name string) *Span

func (*Span) End

func (s *Span) End()

func (*Span) ForLabels

func (s *Span) ForLabels(f func(key, value string))

func (*Span) NewChild

func (s *Span) NewChild(name string) *Span

func (*Span) SetLabels

func (s *Span) SetLabels(args ...string)