GithubHelp home page GithubHelp logo

rbrtm984 / kaleidoscope Goto Github PK

View Code? Open in Web Editor NEW

This project forked from oslabs-beta/kaleidoscope

0.0 0.0 0.0 36.22 MB

Observability data visualization. React, Redux, TailwindCSS, Node.js, Express, SQL, MongoDB, Docker, OpenTelemetry

JavaScript 7.96% TypeScript 91.09% CSS 0.24% HTML 0.43% Dockerfile 0.27%

kaleidoscope's Introduction

PRs Welcome License: MIT Release: 1.0

Kaleidoscope

Kaleidoscope logo

About

Kaleidoscope, an open-source observability tool, empowers developers to visually map and annotate the backend structure of web applications. With Kaleidoscope, developers can create a distinctive node map of their project, analyze request latency across endpoints, and pinpoint performance bottlenecks in the backend.

Please read the website and medium article for more information.

Features

  • Annotations for nodes and node data

Upcoming Features

  • Node map sandbox
  • Trace movement visualization
  • Implement map saving and users saving maps
  • Populating the annotations on the map so they correspond to their location in the architecture
  • Rework Node Map to be in D3 instead of HTML Canvas
  • Account information after log in
  • OAuth
  • Hosted demo of application
  • Hosted Splash Page
  • Individual trace information (waterfall?)
  • "Refresh" button to find new traces for system
  • Ease of use (npm package?)

Prerequisites

  • Opentelemetry instrumentation integrated within your app
  • Instrumentation must be configured to export to a collector with the following environment variable:
OTEL_EXPORTER_OTLP_ENDPOINT=http://otel-collector:4317

NOTE If application is writtten in Node.js it can be instrumented automatically by running the application while requiring instrumentation.js

$ node --require ./instrumentation.js <entry point to your application>

Getting Started

  • Once your app is correctly instrumented to emit telemetry data, start the OTel collector in a Docker container:
$ cd otel-collector && docker compose up
  • Data should now be transmitted to Kaleidoscope as requests travel through your app
  • Open Kaleidoscope from the root directory:
$ npm run start-dev
  • Register / Sign in to generate a node map of your app's latest trace data

Technology Stack

JavaScript React OpenTelemetry

The Developers

kaleidoscope's People

Contributors

rbrtm984 avatar thalesiii avatar hermanchen4 avatar christopher-jettoo avatar dsarlo 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.