transport

Documentation

Overview

Package transport defines various transports that can be used with RemoteReporter to send spans out of process. Transport is responsible for serializing the spans into a specific format suitable for sending to the tracing backend. Examples may include Thrift over UDP, Thrift or JSON over HTTP, Thrift over Kafka, etc.

Implementations are NOT required to be thread-safe; the RemoteReporter is expected to only call methods on the Transport from the same go-routine.

Index

• type HTTPBasicAuthCredentials
• type HTTPOption
  • func HTTPBasicAuth(username string, password string) HTTPOption
  • func HTTPBatchSize(n int) HTTPOption
  • func HTTPHeaders(headers map[string]string) HTTPOption
  • func HTTPRoundTripper(transport http.RoundTripper) HTTPOption
  • func HTTPTimeout(duration time.Duration) HTTPOption
• type HTTPTransport
  • func NewHTTPTransport(url string, options ...HTTPOption) *HTTPTransport
  • func (c *HTTPTransport) Append(span *jaeger.Span) (int, error)
  • func (c *HTTPTransport) Close() error
  • func (c *HTTPTransport) Flush() (int, error)

Types

type HTTPBasicAuthCredentials

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

HTTPBasicAuthCredentials stores credentials for HTTP basic auth.

type HTTPOption

type HTTPOption func(c *HTTPTransport)

HTTPOption sets a parameter for the HttpCollector

func HTTPBasicAuth

func HTTPBasicAuth(username string, password string) HTTPOption

HTTPBasicAuth sets the credentials required to perform HTTP basic auth

func HTTPBatchSize

func HTTPBatchSize(n int) HTTPOption

HTTPBatchSize sets the maximum batch size, after which a collect will be triggered. The default batch size is 100 spans.

func HTTPHeaders

func HTTPHeaders(headers map[string]string) HTTPOption

HTTPHeaders defines the HTTP headers that will be attached to the jaeger client's HTTP request

func HTTPRoundTripper

func HTTPRoundTripper(transport http.RoundTripper) HTTPOption

HTTPRoundTripper configures the underlying Transport on the *http.Client that is used

func HTTPTimeout

func HTTPTimeout(duration time.Duration) HTTPOption

HTTPTimeout sets maximum timeout for http request.

type HTTPTransport

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

HTTPTransport implements Transport by forwarding spans to a http server.

func NewHTTPTransport

func NewHTTPTransport(url string, options ...HTTPOption) *HTTPTransport

NewHTTPTransport returns a new HTTP-backend transport. url should be an http url of the collector to handle POST request, typically something like:

http://hostname:14268/api/traces?format=jaeger.thrift

func (*HTTPTransport) Append

func (c *HTTPTransport) Append(span *jaeger.Span) (int, error)

Append implements Transport.

func (*HTTPTransport) Close

func (c *HTTPTransport) Close() error

Close implements Transport.

func (*HTTPTransport) Flush

func (c *HTTPTransport) Flush() (int, error)

Flush implements Transport.