https://github.com/feedzai/dist-tracing

https://github.com/feedzai/dist-tracing

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/feedzai/dist-tracing
• Owner: feedzai
• License: apache-2.0
• Created: 2019-05-29T11:16:07.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2020-10-13T14:46:15.000Z (over 5 years ago)
• Last Synced: 2025-03-31T06:11:42.638Z (about 1 year ago)
• Language: Java
• Size: 3.94 MB
• Stars: 2
• Watchers: 19
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.com/GoncaloGarcia/DistTracing.svg?token=UL4UejHxEkoG4ZY6Wp8v&branch=master)](https://travis-ci.com/GoncaloGarcia/DistTracing) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/64c32ebc68a7406c92ec68292cc5e1ac)](https://www.codacy.com?utm_source=github.com&utm_medium=referral&utm_content=GoncaloGarcia/DistTracing&utm_campaign=Badge_Grade)[![codecov](https://codecov.io/gh/GoncaloGarcia/DistTracing/branch/master/graph/badge.svg?token=zeWoZDlzAU)](https://codecov.io/gh/GoncaloGarcia/DistTracing)

# Description

This project is a simplified API for tracing Java based distributed systems, as well as an implementation based on the OpenTracing instrumentation framework and the Jaeger tracing engine.

In this book you will first find a small explanation of the tracing model, then a high-level description of the APIs and some instruction on when to use each API.

## Installation

This project is avaliable on Maven Central. To use it in your projects add the following to your `pom.xml`

```

    com.feedzai.commons.tracing

    tracing

    0.1.10

    pom

```

## Usage

For an API description along with usage examples please refer to the [Documentation](site/src/gitbook/DESCRIPTION.md)

## Generating Gitbook documentation

Our docs are also available in Gitbook form, to generate and view them execute the following commands from the project's root.

```

cd site/src/gitbook

gitbook install

gitbook serve

```

The output of `gitbook serve` should provide a link to the generated webpage.

## Build

Run the following command:

```

mvn clean install

```

To build without running tests execute:

```

mvn clean install -DskipTests

```

## Enable Logging

If you're running the API backed by our LoggingTracingEngine you need to add the following to your `logback.xml`

```

  

    log/trace.log

    

      %msg

    

    

      log/trace%d{yyyy-MM}-week-%d{WW}.log.gz

      8

    

  

  

    

    2048

    0

    false

  

  

    

  

  ```