zipkincore

package
v1.61.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 15, 2024 License: Apache-2.0 Imports: 9 Imported by: 321

Documentation

Index

Constants

View Source 
const CLIENT_ADDR = "ca"
View Source 
const CLIENT_RECV = "cr"
View Source 
const CLIENT_RECV_FRAGMENT = "crf"
View Source 
const CLIENT_SEND = "cs"
View Source 
const CLIENT_SEND_FRAGMENT = "csf"
View Source 
const LOCAL_COMPONENT = "lc"
View Source 
const MESSAGE_ADDR = "ma"
View Source 
const MESSAGE_RECV = "mr"
View Source 
const MESSAGE_SEND = "ms"
View Source 
const SERVER_ADDR = "sa"
View Source 
const SERVER_RECV = "sr"
View Source 
const SERVER_RECV_FRAGMENT = "srf"
View Source 
const SERVER_SEND = "ss"
View Source 
const SERVER_SEND_FRAGMENT = "ssf"
View Source 
const WIRE_RECV = "wr"
View Source 
const WIRE_SEND = "ws"

Variables

View Source 
var Endpoint_Ipv6_DEFAULT []byte
View Source 
var GoUnusedProtection__ int
View Source 
var Span_Debug_DEFAULT bool = false
View Source 
var Span_Duration_DEFAULT int64
View Source 
var Span_ParentID_DEFAULT int64
View Source 
var Span_Timestamp_DEFAULT int64
View Source 
var Span_TraceIDHigh_DEFAULT int64
View Source 
var ZipkinCollectorSubmitZipkinBatchResult_Success_DEFAULT []*Response

Functions

This section is empty.

Types

type Annotation 

type Annotation struct {
	Timestamp int64     `thrift:"timestamp,1" db:"timestamp" json:"timestamp"`
	Value     string    `thrift:"value,2" db:"value" json:"value"`
	Host      *Endpoint `thrift:"host,3" db:"host" json:"host,omitempty"`
}

An annotation is similar to a log statement. It includes a host field which allows these events to be attributed properly, and also aggregatable.

Attributes:

  • Timestamp: Microseconds from epoch.

This value should use the most precise value possible. For example, gettimeofday or syncing nanoTime against a tick of currentTimeMillis.

  • Value
  • Host: Always the host that recorded the event. By specifying the host you allow

rollup of all events (such as client requests to a service) by IP address.

func NewAnnotation 

func NewAnnotation() *Annotation

func (*Annotation) Equals added in v1.23.0 

func (p *Annotation) Equals(other *Annotation) bool

func (*Annotation) GetHost 

func (p *Annotation) GetHost() *Endpoint

func (*Annotation) GetTimestamp 

func (p *Annotation) GetTimestamp() int64

func (*Annotation) GetValue 

func (p *Annotation) GetValue() string

func (*Annotation) IsSetHost 

func (p *Annotation) IsSetHost() bool

func (*Annotation) Read 

func (p *Annotation) Read(ctx context.Context, iprot thrift.TProtocol) error

func (*Annotation) ReadField1 added in v1.19.0 

func (p *Annotation) ReadField1(ctx context.Context, iprot thrift.TProtocol) error

func (*Annotation) ReadField2 added in v1.19.0 

func (p *Annotation) ReadField2(ctx context.Context, iprot thrift.TProtocol) error

func (*Annotation) ReadField3 added in v1.19.0 

func (p *Annotation) ReadField3(ctx context.Context, iprot thrift.TProtocol) error

func (*Annotation) String 

func (p *Annotation) String() string

func (*Annotation) Validate added in v1.53.0 

func (p *Annotation) Validate() error

func (*Annotation) Write 

func (p *Annotation) Write(ctx context.Context, oprot thrift.TProtocol) error

type AnnotationType 

type AnnotationType int64
const (
	AnnotationType_BOOL   AnnotationType = 0
	AnnotationType_BYTES  AnnotationType = 1
	AnnotationType_I16    AnnotationType = 2
	AnnotationType_I32    AnnotationType = 3
	AnnotationType_I64    AnnotationType = 4
	AnnotationType_DOUBLE AnnotationType = 5
	AnnotationType_STRING AnnotationType = 6
)

func AnnotationTypeFromString 

func AnnotationTypeFromString(s string) (AnnotationType, error)

func AnnotationTypePtr 

func AnnotationTypePtr(v AnnotationType) *AnnotationType

func (AnnotationType) MarshalText 

func (p AnnotationType) MarshalText() ([]byte, error)

func (*AnnotationType) Scan added in v1.19.0 

func (p *AnnotationType) Scan(value interface{}) error

func (AnnotationType) String 

func (p AnnotationType) String() string

func (*AnnotationType) UnmarshalText 

func (p *AnnotationType) UnmarshalText(text []byte) error

func (*AnnotationType) Value added in v1.19.0 

func (p *AnnotationType) Value() (driver.Value, error)

type BinaryAnnotation 

type BinaryAnnotation struct {
	Key            string         `thrift:"key,1" db:"key" json:"key"`
	Value          []byte         `thrift:"value,2" db:"value" json:"value"`
	AnnotationType AnnotationType `thrift:"annotation_type,3" db:"annotation_type" json:"annotation_type"`
	Host           *Endpoint      `thrift:"host,4" db:"host" json:"host,omitempty"`
}

Binary annotations are tags applied to a Span to give it context. For example, a binary annotation of "http.uri" could the path to a resource in a RPC call.

Binary annotations of type STRING are always queryable, though more a historical implementation detail than a structural concern.

Binary annotations can repeat, and vary on the host. Similar to Annotation, the host indicates who logged the event. This allows you to tell the difference between the client and server side of the same key. For example, the key "http.uri" might be different on the client and server side due to rewriting, like "/api/v1/myresource" vs "/myresource. Via the host field, you can see the different points of view, which often help in debugging.

Attributes:

  • Key
  • Value
  • AnnotationType
  • Host: The host that recorded tag, which allows you to differentiate between

multiple tags with the same key. There are two exceptions to this.

When the key is CLIENT_ADDR or SERVER_ADDR, host indicates the source or destination of an RPC. This exception allows zipkin to display network context of uninstrumented services, or clients such as web browsers.

func NewBinaryAnnotation 

func NewBinaryAnnotation() *BinaryAnnotation

func (*BinaryAnnotation) Equals added in v1.23.0 

func (p *BinaryAnnotation) Equals(other *BinaryAnnotation) bool

func (*BinaryAnnotation) GetAnnotationType 

func (p *BinaryAnnotation) GetAnnotationType() AnnotationType

func (*BinaryAnnotation) GetHost 

func (p *BinaryAnnotation) GetHost() *Endpoint

func (*BinaryAnnotation) GetKey 

func (p *BinaryAnnotation) GetKey() string

func (*BinaryAnnotation) GetValue 

func (p *BinaryAnnotation) GetValue() []byte

func (*BinaryAnnotation) IsSetHost 

func (p *BinaryAnnotation) IsSetHost() bool

func (*BinaryAnnotation) Read 

func (p *BinaryAnnotation) Read(ctx context.Context, iprot thrift.TProtocol) error

func (*BinaryAnnotation) ReadField1 added in v1.19.0 

func (p *BinaryAnnotation) ReadField1(ctx context.Context, iprot thrift.TProtocol) error

func (*BinaryAnnotation) ReadField2 added in v1.19.0 

func (p *BinaryAnnotation) ReadField2(ctx context.Context, iprot thrift.TProtocol) error

func (*BinaryAnnotation) ReadField3 added in v1.19.0 

func (p *BinaryAnnotation) ReadField3(ctx context.Context, iprot thrift.TProtocol) error

func (*BinaryAnnotation) ReadField4 added in v1.19.0 

func (p *BinaryAnnotation) ReadField4(ctx context.Context, iprot thrift.TProtocol) error

func (*BinaryAnnotation) String 

func (p *BinaryAnnotation) String() string

func (*BinaryAnnotation) Validate added in v1.53.0 

func (p *BinaryAnnotation) Validate() error

func (*BinaryAnnotation) Write 

func (p *BinaryAnnotation) Write(ctx context.Context, oprot thrift.TProtocol) error

type Endpoint 

type Endpoint struct {
	Ipv4        int32  `thrift:"ipv4,1" db:"ipv4" json:"ipv4"`
	Port        int16  `thrift:"port,2" db:"port" json:"port"`
	ServiceName string `thrift:"service_name,3" db:"service_name" json:"service_name"`
	Ipv6        []byte `thrift:"ipv6,4" db:"ipv6" json:"ipv6,omitempty"`
}

Indicates the network context of a service recording an annotation with two exceptions.

When a BinaryAnnotation, and key is CLIENT_ADDR or SERVER_ADDR, the endpoint indicates the source or destination of an RPC. This exception allows zipkin to display network context of uninstrumented services, or clients such as web browsers.

Attributes:

  • Ipv4: IPv4 host address packed into 4 bytes.

Ex for the ip 1.2.3.4, it would be (1 << 24) | (2 << 16) | (3 << 8) | 4

  • Port: IPv4 port

Note: this is to be treated as an unsigned integer, so watch for negatives.

Conventionally, when the port isn't known, port = 0.

  • ServiceName: Service name in lowercase, such as "memcache" or "zipkin-web"

Conventionally, when the service name isn't known, service_name = "unknown".

  • Ipv6: IPv6 host address packed into 16 bytes. Ex Inet6Address.getBytes()
var Annotation_Host_DEFAULT *Endpoint
var BinaryAnnotation_Host_DEFAULT *Endpoint

func NewEndpoint 

func NewEndpoint() *Endpoint

func (*Endpoint) Equals added in v1.23.0 

func (p *Endpoint) Equals(other *Endpoint) bool

func (*Endpoint) GetIpv4 

func (p *Endpoint) GetIpv4() int32

func (*Endpoint) GetIpv6 added in v0.7.0 

func (p *Endpoint) GetIpv6() []byte

func (*Endpoint) GetPort 

func (p *Endpoint) GetPort() int16

func (*Endpoint) GetServiceName 

func (p *Endpoint) GetServiceName() string

func (*Endpoint) IsSetIpv6 added in v0.7.0 

func (p *Endpoint) IsSetIpv6() bool

func (*Endpoint) Read 

func (p *Endpoint) Read(ctx context.Context, iprot thrift.TProtocol) error

func (*Endpoint) ReadField1 added in v1.19.0 

func (p *Endpoint) ReadField1(ctx context.Context, iprot thrift.TProtocol) error

func (*Endpoint) ReadField2 added in v1.19.0 

func (p *Endpoint) ReadField2(ctx context.Context, iprot thrift.TProtocol) error

func (*Endpoint) ReadField3 added in v1.19.0 

func (p *Endpoint) ReadField3(ctx context.Context, iprot thrift.TProtocol) error

func (*Endpoint) ReadField4 added in v1.19.0 

func (p *Endpoint) ReadField4(ctx context.Context, iprot thrift.TProtocol) error

func (*Endpoint) String 

func (p *Endpoint) String() string

func (*Endpoint) Validate added in v1.53.0 

func (p *Endpoint) Validate() error

func (*Endpoint) Write 

func (p *Endpoint) Write(ctx context.Context, oprot thrift.TProtocol) error

type Response 

type Response struct {
	Ok bool `thrift:"ok,1,required" db:"ok" json:"ok"`
}

Attributes:

  • Ok

func NewResponse 

func NewResponse() *Response

func (*Response) Equals added in v1.23.0 

func (p *Response) Equals(other *Response) bool

func (*Response) GetOk 

func (p *Response) GetOk() bool

func (*Response) Read 

func (p *Response) Read(ctx context.Context, iprot thrift.TProtocol) error

func (*Response) ReadField1 added in v1.19.0 

func (p *Response) ReadField1(ctx context.Context, iprot thrift.TProtocol) error

func (*Response) String 

func (p *Response) String() string

func (*Response) Validate added in v1.53.0 

func (p *Response) Validate() error

func (*Response) Write 

func (p *Response) Write(ctx context.Context, oprot thrift.TProtocol) error

type Span 

type Span struct {
	TraceID int64 `thrift:"trace_id,1" db:"trace_id" json:"trace_id"`
	// unused field # 2
	Name        string        `thrift:"name,3" db:"name" json:"name"`
	ID          int64         `thrift:"id,4" db:"id" json:"id"`
	ParentID    *int64        `thrift:"parent_id,5" db:"parent_id" json:"parent_id,omitempty"`
	Annotations []*Annotation `thrift:"annotations,6" db:"annotations" json:"annotations"`
	// unused field # 7
	BinaryAnnotations []*BinaryAnnotation `thrift:"binary_annotations,8" db:"binary_annotations" json:"binary_annotations"`
	Debug             bool                `thrift:"debug,9" db:"debug" json:"debug"`
	Timestamp         *int64              `thrift:"timestamp,10" db:"timestamp" json:"timestamp,omitempty"`
	Duration          *int64              `thrift:"duration,11" db:"duration" json:"duration,omitempty"`
	TraceIDHigh       *int64              `thrift:"trace_id_high,12" db:"trace_id_high" json:"trace_id_high,omitempty"`
}

A trace is a series of spans (often RPC calls) which form a latency tree.

The root span is where trace_id = id and parent_id = Nil. The root span is usually the longest interval in the trace, starting with a SERVER_RECV annotation and ending with a SERVER_SEND.

Attributes:

  • TraceID
  • Name: Span name in lowercase, rpc method for example

Conventionally, when the span name isn't known, name = "unknown".

  • ID
  • ParentID
  • Annotations
  • BinaryAnnotations
  • Debug
  • Timestamp: Microseconds from epoch of the creation of this span.

This value should be set directly by instrumentation, using the most precise value possible. For example, gettimeofday or syncing nanoTime against a tick of currentTimeMillis.

For compatibility with instrumentation that precede this field, collectors or span stores can derive this via Annotation.timestamp. For example, SERVER_RECV.timestamp or CLIENT_SEND.timestamp.

This field is optional for compatibility with old data: first-party span stores are expected to support this at time of introduction.

  • Duration: Measurement of duration in microseconds, used to support queries.

This value should be set directly, where possible. Doing so encourages precise measurement decoupled from problems of clocks, such as skew or NTP updates causing time to move backwards.

For compatibility with instrumentation that precede this field, collectors or span stores can derive this by subtracting Annotation.timestamp. For example, SERVER_SEND.timestamp - SERVER_RECV.timestamp.

If this field is persisted as unset, zipkin will continue to work, except duration query support will be implementation-specific. Similarly, setting this field non-atomically is implementation-specific.

This field is i64 vs i32 to support spans longer than 35 minutes.

  • TraceIDHigh: Optional unique 8-byte additional identifier for a trace. If non zero, this

means the trace uses 128 bit traceIds instead of 64 bit.

func NewSpan 

func NewSpan() *Span

func (*Span) Equals added in v1.23.0 

func (p *Span) Equals(other *Span) bool

func (*Span) GetAnnotations 

func (p *Span) GetAnnotations() []*Annotation

func (*Span) GetBinaryAnnotations 

func (p *Span) GetBinaryAnnotations() []*BinaryAnnotation

func (*Span) GetDebug 

func (p *Span) GetDebug() bool

func (*Span) GetDuration 

func (p *Span) GetDuration() int64

func (*Span) GetID 

func (p *Span) GetID() int64

func (*Span) GetName 

func (p *Span) GetName() string

func (*Span) GetParentID 

func (p *Span) GetParentID() int64

func (*Span) GetTimestamp 

func (p *Span) GetTimestamp() int64

func (*Span) GetTraceID 

func (p *Span) GetTraceID() int64

func (*Span) GetTraceIDHigh added in v0.7.0 

func (p *Span) GetTraceIDHigh() int64

func (*Span) IsSetDebug 

func (p *Span) IsSetDebug() bool

func (*Span) IsSetDuration 

func (p *Span) IsSetDuration() bool

func (*Span) IsSetParentID 

func (p *Span) IsSetParentID() bool

func (*Span) IsSetTimestamp 

func (p *Span) IsSetTimestamp() bool

func (*Span) IsSetTraceIDHigh added in v0.7.0 

func (p *Span) IsSetTraceIDHigh() bool

func (*Span) Read 

func (p *Span) Read(ctx context.Context, iprot thrift.TProtocol) error

func (*Span) ReadField1 added in v1.19.0 

func (p *Span) ReadField1(ctx context.Context, iprot thrift.TProtocol) error

func (*Span) ReadField10 added in v1.19.0 

func (p *Span) ReadField10(ctx context.Context, iprot thrift.TProtocol) error

func (*Span) ReadField11 added in v1.19.0 

func (p *Span) ReadField11(ctx context.Context, iprot thrift.TProtocol) error

func (*Span) ReadField12 added in v1.19.0 

func (p *Span) ReadField12(ctx context.Context, iprot thrift.TProtocol) error

func (*Span) ReadField3 added in v1.19.0 

func (p *Span) ReadField3(ctx context.Context, iprot thrift.TProtocol) error

func (*Span) ReadField4 added in v1.19.0 

func (p *Span) ReadField4(ctx context.Context, iprot thrift.TProtocol) error

func (*Span) ReadField5 added in v1.19.0 

func (p *Span) ReadField5(ctx context.Context, iprot thrift.TProtocol) error

func (*Span) ReadField6 added in v1.19.0 

func (p *Span) ReadField6(ctx context.Context, iprot thrift.TProtocol) error

func (*Span) ReadField8 added in v1.19.0 

func (p *Span) ReadField8(ctx context.Context, iprot thrift.TProtocol) error

func (*Span) ReadField9 added in v1.19.0 

func (p *Span) ReadField9(ctx context.Context, iprot thrift.TProtocol) error

func (*Span) String 

func (p *Span) String() string

func (*Span) Validate added in v1.53.0 

func (p *Span) Validate() error

func (*Span) Write 

func (p *Span) Write(ctx context.Context, oprot thrift.TProtocol) error

type ZipkinCollector 

type ZipkinCollector interface {
	// Parameters:
	//  - Spans
	SubmitZipkinBatch(ctx context.Context, spans []*Span) (_r []*Response, _err error)
}

type ZipkinCollectorClient 

type ZipkinCollectorClient struct {
	// contains filtered or unexported fields
}

func NewZipkinCollectorClient added in v1.19.0 

func NewZipkinCollectorClient(c thrift.TClient) *ZipkinCollectorClient

func NewZipkinCollectorClientFactory 

func NewZipkinCollectorClientFactory(t thrift.TTransport, f thrift.TProtocolFactory) *ZipkinCollectorClient

func NewZipkinCollectorClientProtocol 

func NewZipkinCollectorClientProtocol(t thrift.TTransport, iprot thrift.TProtocol, oprot thrift.TProtocol) *ZipkinCollectorClient

func (*ZipkinCollectorClient) Client_ added in v1.19.0 

func (p *ZipkinCollectorClient) Client_() thrift.TClient

func (*ZipkinCollectorClient) LastResponseMeta_ added in v1.23.0 

func (p *ZipkinCollectorClient) LastResponseMeta_() thrift.ResponseMeta

func (*ZipkinCollectorClient) SetLastResponseMeta_ added in v1.23.0 

func (p *ZipkinCollectorClient) SetLastResponseMeta_(meta thrift.ResponseMeta)

func (*ZipkinCollectorClient) SubmitZipkinBatch 

func (p *ZipkinCollectorClient) SubmitZipkinBatch(ctx context.Context, spans []*Span) (_r []*Response, _err error)

Parameters:

  • Spans

type ZipkinCollectorProcessor 

type ZipkinCollectorProcessor struct {
	// contains filtered or unexported fields
}

func NewZipkinCollectorProcessor 

func NewZipkinCollectorProcessor(handler ZipkinCollector) *ZipkinCollectorProcessor

func (*ZipkinCollectorProcessor) AddToProcessorMap 

func (p *ZipkinCollectorProcessor) AddToProcessorMap(key string, processor thrift.TProcessorFunction)

func (*ZipkinCollectorProcessor) GetProcessorFunction 

func (p *ZipkinCollectorProcessor) GetProcessorFunction(key string) (processor thrift.TProcessorFunction, ok bool)

func (*ZipkinCollectorProcessor) Process 

func (p *ZipkinCollectorProcessor) Process(ctx context.Context, iprot, oprot thrift.TProtocol) (success bool, err thrift.TException)

func (*ZipkinCollectorProcessor) ProcessorMap 

func (p *ZipkinCollectorProcessor) ProcessorMap() map[string]thrift.TProcessorFunction

type ZipkinCollectorSubmitZipkinBatchArgs 

type ZipkinCollectorSubmitZipkinBatchArgs struct {
	Spans []*Span `thrift:"spans,1" db:"spans" json:"spans"`
}

Attributes:

  • Spans

func NewZipkinCollectorSubmitZipkinBatchArgs 

func NewZipkinCollectorSubmitZipkinBatchArgs() *ZipkinCollectorSubmitZipkinBatchArgs

func (*ZipkinCollectorSubmitZipkinBatchArgs) GetSpans 

func (p *ZipkinCollectorSubmitZipkinBatchArgs) GetSpans() []*Span

func (*ZipkinCollectorSubmitZipkinBatchArgs) Read 

func (p *ZipkinCollectorSubmitZipkinBatchArgs) Read(ctx context.Context, iprot thrift.TProtocol) error

func (*ZipkinCollectorSubmitZipkinBatchArgs) ReadField1 added in v1.19.0 

func (p *ZipkinCollectorSubmitZipkinBatchArgs) ReadField1(ctx context.Context, iprot thrift.TProtocol) error

func (*ZipkinCollectorSubmitZipkinBatchArgs) String 

func (p *ZipkinCollectorSubmitZipkinBatchArgs) String() string

func (*ZipkinCollectorSubmitZipkinBatchArgs) Write 

func (p *ZipkinCollectorSubmitZipkinBatchArgs) Write(ctx context.Context, oprot thrift.TProtocol) error

type ZipkinCollectorSubmitZipkinBatchResult 

type ZipkinCollectorSubmitZipkinBatchResult struct {
	Success []*Response `thrift:"success,0" db:"success" json:"success,omitempty"`
}

Attributes:

  • Success

func NewZipkinCollectorSubmitZipkinBatchResult 

func NewZipkinCollectorSubmitZipkinBatchResult() *ZipkinCollectorSubmitZipkinBatchResult

func (*ZipkinCollectorSubmitZipkinBatchResult) GetSuccess 

func (p *ZipkinCollectorSubmitZipkinBatchResult) GetSuccess() []*Response

func (*ZipkinCollectorSubmitZipkinBatchResult) IsSetSuccess 

func (p *ZipkinCollectorSubmitZipkinBatchResult) IsSetSuccess() bool

func (*ZipkinCollectorSubmitZipkinBatchResult) Read 

func (p *ZipkinCollectorSubmitZipkinBatchResult) Read(ctx context.Context, iprot thrift.TProtocol) error

func (*ZipkinCollectorSubmitZipkinBatchResult) ReadField0 added in v1.19.0 

func (p *ZipkinCollectorSubmitZipkinBatchResult) ReadField0(ctx context.Context, iprot thrift.TProtocol) error

func (*ZipkinCollectorSubmitZipkinBatchResult) String 

func (p *ZipkinCollectorSubmitZipkinBatchResult) String() string

func (*ZipkinCollectorSubmitZipkinBatchResult) Write 

func (p *ZipkinCollectorSubmitZipkinBatchResult) Write(ctx context.Context, oprot thrift.TProtocol) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.