Git Product home page Git Product logo

pulsar-tracing's Introduction

Apache Pulsar Client Tracing Instrumentation

Tracing instrumentation for Apache Pulsar client.

OpenTracing Instrumentation

Requirements

  • Java 8
  • Pulsar client >= 2.5.0

Installation

Add Pulsar client and OpenTracing instrumentation for the Pulsar client.

<dependency>
    <groupId>org.apache.pulsar</groupId>
    <artifactId>pulsar-client</artifactId>
    <version>VERSION</version>
</dependency>
<dependency>
    <groupId>io.streamnative</groupId>
    <artifactId>opentracing-pulsar-client</artifactId>
    <version>VERSION</version>
</dependency>

Usage

Interceptors based solution

// Instantiate tracer
Tracer tracer = ...

// Optionally register tracer with GlobalTracer
GlobalTracer.register(tracer);

Producer

// Instantiate Producer with tracing interceptor.
Producer<String> producer = client
    .newProducer(Schema.STRING)
    .intercept(new TracingProducerInterceptor())
    .topic("your-topic")
    .create();

// Send messages.
producer.send("Hello OpenTracing!");

Consumer

// Instantiate Consumer with tracing interceptor.
Consumer<String> consumer = client.newConsumer(Schema.STRING)
    .topic("your-topic")
    .intercept(new TracingConsumerInterceptor<>())
    .subscriptionName("your-sub")
    .subscribe();

// Receive messages.
Message<String> message = consumer.receive();

// To retrieve SpanContext from the message(Consumer side).
SpanContext spanContext = TracingPulsarUtils.extractSpanContext(message, tracer);

License

Apache 2.0 License.

pulsar-tracing's People

Contributors

avimas avatar codelipenghui avatar sijie avatar streamnativebot avatar tjiuming avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

pulsar-tracing's Issues

Documentation for opentracing-pulsar-client

Add document for how to use opentracing-pulsar-client lib to trace messages.

  1. Add maven dependency
  2. Set interceptor for producer and consumer
  3. Choose a Tracer implementation(such as Jaeder?)

MessagePropertiesInjectAdapter incompatible with pulsar-client 2.7.1, works with 2.10.4

io.streamnative.pulsar.tracing.MessagePropertiesInjectAdapter 0.2.0 incompatible with org.apache.pulsar.client.impl.MessageImpl (2.7.1, works fine with 2.10.4)

org.apache.pulsar.client removed:

  • msg.getMessageBuilder().addProperty() method
  • org.apache.pulsar.common.api.proto.KeyValue class

{code}
08:44:57.191 [pulsar-client-io-1-1] WARN o.a.p.c.impl.ConsumerInterceptors , - Error executing interceptor beforeConsume callback topic: persistent://tenant/namespace/topic-partition-0 consumerName: c0e18 java.lang.NoSuchMethodError: 'org.apache.pulsar.common.api.proto.MessageMetadata org.apache.pulsar.client.impl.MessageImpl.getMessageBuilder()' at io.streamnative.pulsar.tracing.MessagePropertiesInjectAdapter.put(MessagePropertiesInjectAdapter.java:49) at io.opentelemetry.opentracingshim.Propagation$TextMapSetter.set(Propagation.java:71) at io.opentelemetry.opentracingshim.Propagation$TextMapSetter.set(Propagation.java:64) at io.opentelemetry.api.trace.propagation.W3CTraceContextPropagator.inject(W3CTraceContextPropagator.java:123) at io.opentelemetry.context.propagation.MultiTextMapPropagator.inject(MultiTextMapPropagator.java:52)
{code}

image

Questions about producer behaviors

Thans for this good job.

When studying the code about this project, I have been confused by the producer interceptor behavior which injects unfinished span to tracer.
Meanwhile, I have noticed the jaeger ui result that the span indeed finished. How it worked?

Will this be finished by other function in the feature milestones?
Will this opetation cause memory leak?

Thank you very much.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.