Skip to content

oslabs-beta/kafkatrace-npm-package

Repository files navigation

KafkaTrace

image

Table of Contents

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

TypescriptJavaScriptReactPrometheusZipkinJaegerOpenTelemetryJestTailwindDaisyUINextJSNextAuthKafkaJSDockerAWS

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

demo-vid

Authors

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

License

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

About

No description, website, or topics provided.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •