Giter Club home page Giter Club logo

m3-tracing's Introduction

Distributed Tracing Wrapper Libraries.

Aim of this libraries

  • Provide unified/tested set of libraries
    • No need to load/maintain various contrib libraries
  • Provide high-level & simple interface over tracing standard APIs (e.g. OpenCensus)
    • No need to know detail of API
    • Provides simple interface
    • Hide complicated object lifecycle of APIs (hide error prone things from you)

Non-goal of this libraries

  • Do not aim to provide agent, you need to activate/call this library explicitly
    • Do not prefer to use dynamic code rewriting / monkey patching to minimize risk
    • To use feature of this library, please explicitly call/enable them
  • Do not aim to support all libraries in the world (HTTP client library, logging library, ...)
    • Focus on use case in our company.
    • If you want to add library support, feel free to fork this.

How to start

Java

See jvm/README.

Features

Feature matrix

Feature Java (core) Spring Play (Scala)
Supported runtime JRE >= 8 ( Same as Java ) ( Same as Java )
Capture incoming HTTP request Servlet >= 3.0.1 Spring Web Play ?.?
Capture & Propagate to outgoing HTTP request Commons HTTP client >= ?.?, async-http-client RestTemplate ?????? (Play)
Capture database call p6spy support for JDBC/RDBMS ( Same as Java ) ( Same as Java )
Multi-thread ( Custom context machanism ) ( Same as Java ) Future wrapper (Play)
Log correlation SLF4J, Log4j ( Same as Java ) ( Same as Java )
Capture method invocation method annotation AOP Play: ????
Dependency injection AutoConfiguration (Boot) ????

Summary of each features are described below, but don't forget to see document of each language to see how to use/enable it.

Feature: Capture incoming HTTP request

With this feature, this library automatically create trace/span for each incoming requests.

Feature: Capture & Propagate to outgoing HTTP request

With this feature:

  • This library create span for each outgoing requests
    • So that you can know duration/summary of outgoing requests
  • This library adds Trace ID to outgoing HTTP requests
    • If destination service uses this library, we can trace request over services (-> "distributed" tracing)

Feature: Capture database call

With this feature, this library yield spans for each database call.

Feature: Multi-thread

With this feature, this library wraps multi-thread (async) operations and propagate thread-bounded trace/span to threads.

Feature: Log correlation

With this feature, you can output Trace ID in logs. So that you can find related logs from/to traces.

Feature: Capture any method invocation

With this feature, you can capture method call of your own class.

Feature: Dependency injection

With this feature, this library provides DI configuration so that you can get objects from DI context.

m3-tracing's People

Contributors

ma2gedev avatar saiya avatar sekikatsu36 avatar

Watchers

 avatar

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.