A B C E F I M N Q R S U V Z

A

AsyncReporter<S> - Class in zipkin2.reporter

As spans are reported, they are encoded and added to a pending queue.

AsyncReporter() - Constructor for class zipkin2.reporter.AsyncReporter

AsyncReporter.Builder - Class in zipkin2.reporter

B

build() - Method in class zipkin2.reporter.AsyncReporter.Builder

Builds an async reporter that encodes zipkin spans as they are reported.

build(BytesEncoder<S>) - Method in class zipkin2.reporter.AsyncReporter.Builder

Builds an async reporter that encodes arbitrary spans as they are reported.

builder(Sender) - Static method in class zipkin2.reporter.AsyncReporter

Like AsyncReporter.create(Sender), except you can configure settings such as the timeout.

BytesMessageEncoder - Enum in zipkin2.reporter

Senders like Kafka use byte[] message encoding.

C

clear() - Method in class zipkin2.reporter.InMemoryReporterMetrics

close() - Method in class zipkin2.reporter.AsyncReporter

Shuts down the sender thread, and increments drop metrics if there were any unsent spans.

closeTimeout(long, TimeUnit) - Method in class zipkin2.reporter.AsyncReporter.Builder

How long to block for in-flight spans to send out-of-process on close.

CONSOLE - Static variable in interface zipkin2.reporter.Reporter

create(Sender) - Static method in class zipkin2.reporter.AsyncReporter

After a certain threshold, spans are drained and sent to Zipkin collectors.

E

encode(List<byte[]>) - Method in enum zipkin2.reporter.BytesMessageEncoder

Combines a list of encoded spans into an encoded list.

encoding() - Method in class zipkin2.reporter.Sender

Returns the encoding this sender requires spans to have.

F

flush() - Method in class zipkin2.reporter.AsyncReporter

Calling this will flush any pending spans to the transport on the current thread.

forEncoding(Encoding) - Static method in enum zipkin2.reporter.BytesMessageEncoder

I

incrementMessageBytes(int) - Method in class zipkin2.reporter.InMemoryReporterMetrics

incrementMessageBytes(int) - Method in interface zipkin2.reporter.ReporterMetrics

Increments the number of bytes containing encoded spans in a message.

incrementMessages() - Method in class zipkin2.reporter.InMemoryReporterMetrics

incrementMessages() - Method in interface zipkin2.reporter.ReporterMetrics

Increments count of message attempts, which contain 1 or more spans.

incrementMessagesDropped(Throwable) - Method in class zipkin2.reporter.InMemoryReporterMetrics

incrementMessagesDropped(Throwable) - Method in interface zipkin2.reporter.ReporterMetrics

Increments count of messages that could not be sent.

incrementSpanBytes(int) - Method in class zipkin2.reporter.InMemoryReporterMetrics

incrementSpanBytes(int) - Method in interface zipkin2.reporter.ReporterMetrics

Increments the number of encoded span bytes reported.

incrementSpans(int) - Method in class zipkin2.reporter.InMemoryReporterMetrics

incrementSpans(int) - Method in interface zipkin2.reporter.ReporterMetrics

Increments the count of spans reported.

incrementSpansDropped(int) - Method in class zipkin2.reporter.InMemoryReporterMetrics

incrementSpansDropped(int) - Method in interface zipkin2.reporter.ReporterMetrics

Increments the count of spans dropped for any reason.

InMemoryReporterMetrics - Class in zipkin2.reporter

InMemoryReporterMetrics() - Constructor for class zipkin2.reporter.InMemoryReporterMetrics

M

messageBytes() - Method in class zipkin2.reporter.InMemoryReporterMetrics

messageMaxBytes(int) - Method in class zipkin2.reporter.AsyncReporter.Builder

Maximum bytes sendable per message including overhead.

messageMaxBytes() - Method in class zipkin2.reporter.Sender

Maximum bytes sendable per message including overhead.

messages() - Method in class zipkin2.reporter.InMemoryReporterMetrics

messagesDropped() - Method in class zipkin2.reporter.InMemoryReporterMetrics

messagesDroppedByCause() - Method in class zipkin2.reporter.InMemoryReporterMetrics

messageSizeInBytes(List<byte[]>) - Method in class zipkin2.reporter.Sender

Before invoking Sender.sendSpans(List), callers must consider message overhead, which might be more than encoding overhead.

messageTimeout(long, TimeUnit) - Method in class zipkin2.reporter.AsyncReporter.Builder

Default 1 second.

metrics(ReporterMetrics) - Method in class zipkin2.reporter.AsyncReporter.Builder

Aggregates and reports reporter metrics to a monitoring system.

N

NOOP - Static variable in interface zipkin2.reporter.Reporter

NOOP_METRICS - Static variable in interface zipkin2.reporter.ReporterMetrics

Q

queuedBytes() - Method in class zipkin2.reporter.InMemoryReporterMetrics

queuedMaxBytes(int) - Method in class zipkin2.reporter.AsyncReporter.Builder

Maximum backlog of span bytes reported vs sent.

queuedMaxSpans(int) - Method in class zipkin2.reporter.AsyncReporter.Builder

Maximum backlog of spans reported vs sent.

queuedSpans() - Method in class zipkin2.reporter.InMemoryReporterMetrics

R

report(S) - Method in interface zipkin2.reporter.Reporter

Schedules the span to be sent onto the transport.

Reporter<S> - Interface in zipkin2.reporter

Spans are created in instrumentation, transported out-of-band, and eventually persisted.

ReporterMetrics - Interface in zipkin2.reporter

Instrumented applications report spans over a transport such as Kafka to Zipkin Collectors.

S

Sender - Class in zipkin2.reporter

Sends a list of encoded spans to a transport such as http or Kafka.

Sender() - Constructor for class zipkin2.reporter.Sender

sendSpans(List<byte[]>) - Method in class zipkin2.reporter.Sender

Sends a list of encoded spans to a transport such as http or Kafka.

spanBytes() - Method in class zipkin2.reporter.InMemoryReporterMetrics

spans() - Method in class zipkin2.reporter.InMemoryReporterMetrics

spansDropped() - Method in class zipkin2.reporter.InMemoryReporterMetrics

U

updateQueuedBytes(int) - Method in class zipkin2.reporter.InMemoryReporterMetrics

updateQueuedBytes(int) - Method in interface zipkin2.reporter.ReporterMetrics

Updates the count of encoded span bytes pending, following a flush activity.

updateQueuedSpans(int) - Method in class zipkin2.reporter.InMemoryReporterMetrics

updateQueuedSpans(int) - Method in interface zipkin2.reporter.ReporterMetrics

Updates the count of spans pending, following a flush activity.

V

v2(Sender) - Static method in class zipkin2.reporter.AsyncReporter

Builds a reporter for Zipkin V2 spans.

valueOf(String) - Static method in enum zipkin2.reporter.BytesMessageEncoder

Returns the enum constant of this type with the specified name.

values() - Static method in enum zipkin2.reporter.BytesMessageEncoder

Returns an array containing the constants of this enum type, in the order they are declared.

Z

zipkin2.reporter - package zipkin2.reporter

A B C E F I M N Q R S U V Z