kafka

package

v1.56.0 Latest Latest Go to latest Published: Apr 3, 2024 License: Apache-2.0 Imports: 22 Imported by: 64

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/jaegertracing/jaeger

Documentation ¶

Index ¶

Constants
Variables
type Factory
- func NewFactory() *Factory
- func (f *Factory) AddFlags(flagSet *flag.FlagSet)
- func (f *Factory) Close() error
- func (f *Factory) CreateDependencyReader() (dependencystore.Reader, error)
- func (f *Factory) CreateSpanReader() (spanstore.Reader, error)
- func (f *Factory) CreateSpanWriter() (spanstore.Writer, error)
- func (f *Factory) InitFromOptions(o Options)
- func (f *Factory) InitFromViper(v *viper.Viper, logger *zap.Logger)
- func (f *Factory) Initialize(metricsFactory metrics.Factory, logger *zap.Logger) error
type JSONUnmarshaller
- func NewJSONUnmarshaller() *JSONUnmarshaller
- func (h *JSONUnmarshaller) Unmarshal(msg []byte) (*model.Span, error)
type Marshaller
type Options
- func (opt *Options) AddFlags(flagSet *flag.FlagSet)
- func (opt *Options) InitFromViper(v *viper.Viper)
type ProtobufUnmarshaller
- func NewProtobufUnmarshaller() *ProtobufUnmarshaller
- func (h *ProtobufUnmarshaller) Unmarshal(msg []byte) (*model.Span, error)
type SpanWriter
- func NewSpanWriter(producer sarama.AsyncProducer, marshaller Marshaller, topic string, ...) *SpanWriter
- func (w *SpanWriter) Close() error
- func (w *SpanWriter) WriteSpan(ctx context.Context, span *model.Span) error
type Unmarshaller
type ZipkinThriftUnmarshaller
- func NewZipkinThriftUnmarshaller() *ZipkinThriftUnmarshaller
- func (h *ZipkinThriftUnmarshaller) Unmarshal(msg []byte) (*model.Span, error)

Constants ¶

View Source

const (
	// EncodingJSON is used for spans encoded as Protobuf-based JSON.
	EncodingJSON = "json"
	// EncodingProto is used for spans encoded as Protobuf.
	EncodingProto = "protobuf"
	// EncodingZipkinThrift is used for spans encoded as Zipkin Thrift.
	EncodingZipkinThrift = "zipkin-thrift"
)

Variables ¶

View Source

var (
	// AllEncodings is a list of all supported encodings.
	AllEncodings = []string{EncodingJSON, EncodingProto, EncodingZipkinThrift}
)

Functions ¶

This section is empty.

Types ¶

type Factory ¶

type Factory struct {
	producer.Builder
	// contains filtered or unexported fields
}

Factory implements storage.Factory and creates write-only storage components backed by kafka.

func NewFactory ¶

func NewFactory() *Factory

NewFactory creates a new Factory.

func (*Factory) AddFlags ¶

func (f *Factory) AddFlags(flagSet *flag.FlagSet)

AddFlags implements plugin.Configurable

func (*Factory) Close ¶ added in v1.19.0

func (f *Factory) Close() error

Close closes the resources held by the factory

func (*Factory) CreateDependencyReader ¶

func (f *Factory) CreateDependencyReader() (dependencystore.Reader, error)

CreateDependencyReader implements storage.Factory

func (*Factory) CreateSpanReader ¶

func (f *Factory) CreateSpanReader() (spanstore.Reader, error)

CreateSpanReader implements storage.Factory

func (*Factory) CreateSpanWriter ¶

func (f *Factory) CreateSpanWriter() (spanstore.Writer, error)

CreateSpanWriter implements storage.Factory

func (*Factory) InitFromOptions ¶ added in v1.18.0

func (f *Factory) InitFromOptions(o Options)

InitFromOptions initializes factory from options.

func (*Factory) InitFromViper ¶

func (f *Factory) InitFromViper(v *viper.Viper, logger *zap.Logger)

InitFromViper implements plugin.Configurable

func (*Factory) Initialize ¶

func (f *Factory) Initialize(metricsFactory metrics.Factory, logger *zap.Logger) error

Initialize implements storage.Factory

type JSONUnmarshaller ¶ added in v1.7.0

type JSONUnmarshaller struct{}

JSONUnmarshaller implements Unmarshaller

func NewJSONUnmarshaller ¶ added in v1.7.0

func NewJSONUnmarshaller() *JSONUnmarshaller

NewJSONUnmarshaller constructs a JSONUnmarshaller

func (*JSONUnmarshaller) Unmarshal ¶ added in v1.7.0

func (h *JSONUnmarshaller) Unmarshal(msg []byte) (*model.Span, error)

Unmarshal decodes a json byte array to a span

type Marshaller ¶

type Marshaller interface {
	Marshal(*model.Span) ([]byte, error)
}

Marshaller encodes a span into a byte array to be sent to Kafka

type Options ¶

type Options struct {
	Config   producer.Configuration `mapstructure:",squash"`
	Topic    string                 `mapstructure:"topic"`
	Encoding string                 `mapstructure:"encoding"`
}

Options stores the configuration options for Kafka

func (*Options) AddFlags ¶

func (opt *Options) AddFlags(flagSet *flag.FlagSet)

AddFlags adds flags for Options

func (*Options) InitFromViper ¶

func (opt *Options) InitFromViper(v *viper.Viper)

InitFromViper initializes Options with properties from viper

type ProtobufUnmarshaller ¶ added in v1.7.0

type ProtobufUnmarshaller struct{}

ProtobufUnmarshaller implements Unmarshaller

func NewProtobufUnmarshaller ¶ added in v1.7.0

func NewProtobufUnmarshaller() *ProtobufUnmarshaller

NewProtobufUnmarshaller constructs a ProtobufUnmarshaller

func (*ProtobufUnmarshaller) Unmarshal ¶ added in v1.7.0

func (h *ProtobufUnmarshaller) Unmarshal(msg []byte) (*model.Span, error)

Unmarshal decodes a protobuf byte array to a span

type SpanWriter ¶

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

SpanWriter writes spans to kafka. Implements spanstore.Writer

func NewSpanWriter ¶

func NewSpanWriter(
	producer sarama.AsyncProducer,
	marshaller Marshaller,
	topic string,
	factory metrics.Factory,
	logger *zap.Logger,
) *SpanWriter

NewSpanWriter initiates and returns a new kafka spanwriter

func (*SpanWriter) Close ¶

func (w *SpanWriter) Close() error

Close closes SpanWriter by closing producer

func (*SpanWriter) WriteSpan ¶

func (w *SpanWriter) WriteSpan(ctx context.Context, span *model.Span) error

WriteSpan writes the span to kafka.

type Unmarshaller ¶ added in v1.7.0

type Unmarshaller interface {
	Unmarshal([]byte) (*model.Span, error)
}

Unmarshaller decodes a byte array to a span

type ZipkinThriftUnmarshaller ¶ added in v1.9.0

type ZipkinThriftUnmarshaller struct{}

ZipkinThriftUnmarshaller implements Unmarshaller

func NewZipkinThriftUnmarshaller ¶ added in v1.9.0

func NewZipkinThriftUnmarshaller() *ZipkinThriftUnmarshaller

NewZipkinThriftUnmarshaller constructs a zipkinThriftUnmarshaller

func (*ZipkinThriftUnmarshaller) Unmarshal ¶ added in v1.9.0

func (h *ZipkinThriftUnmarshaller) Unmarshal(msg []byte) (*model.Span, error)

Unmarshal decodes a json byte array to a span

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL