KafkaTrace

Table of Contents

• About Kafka Trace
• Tech Stacks
• Features
• User Guide
• Authors
• License

About KafkaTrace

Based on OpenTelemetry's standards, KafkaTrace streamlines the process of visualizing your Apache Kafka Clients by packaging together the necessary instrumentation files with popular open source monitoring UIs (Jaeger, Zipkin, and Prometheus). This documentation describes how to implement KafkaTrace.

For more information, visit our website.

Tech Stacks

Features

• Intuitive all-in-one documentation to implement distributive tracing for Kafka.
• Authentication for Google and GitHub OAuth.

User Guide

Prerequisites:

You must have Docker Desktop installed and running!

IMPORTANT REMINDER: Make sure the Kafka Cluster you want to trace has a working producer and consumer client.

• STEP 1: Install npm package

  npm install kafkatrace

• STEP 2: Build and run the preconfigured containers

  import { composer } from 'kafkatrace';
  composer();

• STEP 3: Add to each service file and replace [Service Name] as required

  import { tracer } from 'kafkatrace';
  tracer('[Service Name]');

• STEP 4: Navigate to localhost port: 16686 for Jaeger, 9411 for Zipkin, 9090 for Prometheus or simply login to the website

Authors

| Developed By | Github | LinkedIn | | :----------: | :---------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------: | | Felix Chen | | | | Navdeep Simmack | | | | Wai San Gu | | | | Alston Nguyen | | |

License

Distributed under MIT License. See LICENSE.txt for more information.