Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/open-source-labs/chronos
📊 📊 📊 Monitors the health and web traffic of servers, microservices, Kubernetes/Kafka clusters, containers, and AWS services with real-time data monitoring and receive automated notifications over Slack or email.
https://github.com/open-source-labs/chronos
aws container-stats desktop-application docker docker-container electron graphql grpc health kafka kubernetes microservice-toolkit microservices monitoring monitoring-tool nodejs npm-module npm-package react typescript
Last synced: 29 days ago
JSON representation
📊 📊 📊 Monitors the health and web traffic of servers, microservices, Kubernetes/Kafka clusters, containers, and AWS services with real-time data monitoring and receive automated notifications over Slack or email.
- Host: GitHub
- URL: https://github.com/open-source-labs/chronos
- Owner: open-source-labs
- License: mit
- Created: 2019-09-07T13:37:38.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-16T19:26:22.000Z (6 months ago)
- Last Synced: 2024-10-09T16:21:20.688Z (29 days ago)
- Topics: aws, container-stats, desktop-application, docker, docker-container, electron, graphql, grpc, health, kafka, kubernetes, microservice-toolkit, microservices, monitoring, monitoring-tool, nodejs, npm-module, npm-package, react, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@chronosmicro/tracker
- Size: 247 MB
- Stars: 831
- Watchers: 18
- Forks: 202
- Open Issues: 63
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://github.com/open-source-labs/Chronos)
# Chronos
### ⭐️ Star us on GitHub! ⭐️
**Visit our website at [chronoslany.com](https://chronoslany.com/).**
Chronos is a comprehensive developer tool that monitors the health and web traffic for containerized (Docker & Kubernetes) and non-containerized microservices communicated via REST APIs or gRPC, whether hosted locally or on Amazon Web Services (AWS). Use Chronos to see real-time data monitoring and receive automated notifications over Slack or email.
## What's New?
### Chronos 14.0
Contributors:
[Michael Tagg](https://github.com/mdtagg),
[Ted Pham](https://github.com/TedPham397),
[Sofia Sarhiri](https://github.com/sarhiri),
[Stephen Yang](https://github.com/stephenhyang),
Updates:
### **Iteration Log**
Chronos 13.0
- Created new and improved microservices application with updated syntax to better demonstrate Chronos' capabilities
- Dockerized microservices application to demonstrate Chronos within a containerized environment
- Added visulization of Chronos' codebase to illustrate overall structure
- Simplified installation and startup instructions in the root directory README file
- Improved documentation in chronos_npm_package README file for easier on-boarding
Contributors:
[Elsa Holmgren](https://github.com/ekh88),
[Mckenzie Morris](https://github.com/mckenzie-morris),
[Kelly Chandler](https://github.com/kchandler44),
[Sean Simpson](https://github.com/seantokuzo),
[Zhongyan Liang](https://github.com/ZhongyanLiang)
Updates:
Chronos 12.0
- Grafana charting and visualizer
- Increase in Prometheus and cAdvisor integration span
- Increased testing coverage to include unit testing and Selenium-based, end-to-end testing
- Integrated CI/CD which automates GitHub Action to run testing suites in order and create a publishing action to NPM Registry
Contributors:
[Haoyu Liu](https://github.com/HaoyL666),
[Edwin Leong](https://github.com/edwinlny),
[Eisha Kaushal](https://github.com/eishakaushal),
[Tyler Coryell](https://github.com/Tcoryell)
Updates:
Chronos 11.0
- Interactive charting which can display and compare metrics in rendered graphs
- Increased user database security with user authorization to connect multiple
- services and databases and have instances persist without having to reconnect
- Improved documentation by adding ReadMes about how to initialize the app, how to use the given examples, and how to update config files
- Updated NPM Package to ‘increase reliability and ease of navigation
- Fixed bugs and improved test coverage
Contributors:
[Brisa Zhu](https://github.com/beezoo10),
[Lucie Seidler](https://github.com/LucieSeidler),
[Justin Poirier](https://github.com/jcpoirier20),
[Jeffrey Na](https://github.com/jeffreyNa),
[Kelsi Webb](https://github.com/kelsicw)
Updates:
Chronos 10.0
- Full user authentication integrating with a functional database which enables users to securely save their profile and data
- Updated microservices, gRPC, and Dockerized app examples
Contributors:
[Brian Lim](https://github.com/brianlim89),
[Claire Tischuk](https://github.com/BoopdiBop),
[Lennon Stewart](https://github.com/noahoo7),
[Victor Ye](https://github.com/vctorye),
Updates:
Chronos 9.0
- Added AWS - Users of Chronos are now able to monitor and visualize containers running in Amazon’s Elastic Kubernetes Service (EKS)~Medium
- Ability to monitor cost metrics through Opencast integration
Contributors:
[Brian Lim](https://github.com/brianlim89),
[Claire Tischuk](https://github.com/BoopdiBop),
[Lennon Stewart](https://github.com/eishakaushal),
[Victor Ye](https://github.com/vctorye)
Updates:
Chronos 8.0
- Rewrite microservice in a language with a higher level of support such as GO or Java
- Use packages such as OpenTelementry to record data and export said data to an additional application like Zipkin or Prometheus
- Purchase a license to one of the few monitoring tools that support gRPC and Node.js.
Contributors:
[Vince Ho](https://github.com/brianlim89),
[Matt Giant](https://github.com/BoopdiBop),
[Derek Lam](https://github.com/eishakaushal),
[Kit Loong Yee](https://github.com/vctorye)
Updates:
Chronos 7.0
- Ability to filter out specific metrics using a query tool
- Increased the number of metrics available from 12 to 100+
- Options to filter metrics by category
- Apache Kafka monitoring capabilities
- Bug fixes and UI improvements
Contributors:
[Yang Song](https://github.com/curiousyang),
[Giovanni Floreslovo](https://github.com/gfloresl),
[James Edwards](https://github.com/Fredwards),
[Alex Kolb](https://github.com/alexkolb1)
Updates:
### With Chronos 14.0
## Overview of the CodeBase
- If you want to visualize the way the files in the app are connected, we suggest using this data visualizer. Below, it's showing the same repository, but instead of a directory structure, each file and folder as a circle: the circle’s color is the type of file, and the circle’s size represents the size of the file. See live demo
here.
## Features
- Cloud-Based Instances:
- Option to choose between cloud hosted services and local services, giving Chronos the ability to monitor instances and clusters on AWS EC2, ECS, and EKS platforms 
- Local instances utilitizing `@chronosmicro/tracker` NPM package:
- Enables distributed tracing enabled across microservices applications
- Displays real-time temperature, speed, latency, and memory statistics for local services
- Displays and compares multiple microservice metrics in a single graph
- Allow Kubernetes and Docker monitoring via Prometheus server and Grafana visualization.
- Compatible with 
- Monitor an 
cluster via the JMX Prometheus Exporter
- Supports 
and 
databases
# Installation
This is for the latest Chronos **version 13.0 release**.
## NPM Package
In order to use Chronos within your own application, you must have the `@chronosmicro/tracker` dependency installed.
The `@chronosmicro/tracker` package tracks your application's calls and scrapes metrics from your system.
- **NOTE:** The Chronos tracker code is included in the _chronos_npm_package_ folder for ease of development, but the published NPM package can be downloaded by running `npm install @chronosmicro/tracker`.
For more details on the NPM package and instructions for how to use it, please view the [Chronos NPM Package README](./chronos_npm_package/README.md).
#
## Chronos Desktop Application
### Running the Chronos desktop app in development mode (WSL Incompatible)
1. From the root directory, run `npm install`
2. Run `npm run start:electron` to start the electron app.
3. Run `npm audit fix` or `npm audit fix --force` if prompted
4. Refer to `Examples` sections below to spin up example applications.
(Recommended):
If you have mongo community edition running locally just run `npm run start:microservices` to start populating database with server data(more detail in Microservices Example section).
#
### Packing the Chronos desktop app into an executable
1. From the root directory, run `npm run build`
2. Run `npm run package`
3. Find the `chronos.app` executable inside the newly created `release-builds` folder in the root directory.
#
### Creating User Database
**NOTE: You must create your own user database for extended features**
1. Create a MongoDB database in which to store user information and insert it on line 2 within the [UserModel.ts](./electron/models/UserModel.ts) (_electron/models/UserModel.ts_) file.
- This database will privately store user information.
2. Once this is set up, you can create new users, log in, and have your data persist between sessions.
#
# Examples
We provide eight example applications for you to test out both the Chronos NPM package and the Chronos desktop application:
- AWS
- [EC2 README](./examples/AWS/AWS-EC2/README.md)
- [ECS README](./examples/AWS/AWS-ECS/README.md)
- [EKS README](./examples/AWS/AWS-EKS/README.md)
- Docker
- [Docker README](./examples/docker/README.md)
- gRPC
- [gRPC README](./examples/gRPC/README.md)
- Kubernetes
- [Kubernetes README](./examples/kubernetes/README.md)
- Microservices
- [Microservices README](./examples/microservices/README.md)
Additional documentation on how Chronos is used **in each example** can be found in the [Chronos NPM Package README](./chronos_npm_package/README.md).
#### _AWS_
The `AWS` folder includes 3 example applications with instructions on how to deploy them in AWS platforms. Note that using AWS services may cause charges.
- The ECS folder includes an web application ready to be containerized using Docker. The instruction shows how to deploy application to ECS using Docker CLI command, and it will be managed by Fargate services.
- The EC2 folder includes a React/Redux/SQL web application ready to be containerized using Docker. The instruction shows how to deploy application using AWS Beanstalk and connect application to RDS database. Beanstalk service will generate EC2 instance.
- The EKS folder includes a containerized note taking app that uses a Mongo database as its persistent volume. The instructions show how to deploy this application on EKS, how to monitor with Prometheus & Opencost, and how to use Grafana to grab visualizations.
Refer to the [EC2 README](./examples/AWS/AWS-EC2/README.md), [ECS README](./examples/AWS/AWS-ECS/README.md), and [EKS README](./examples/AWS/AWS-EKS/README.md) example in the _AWS_ folder for more details.
#
#### _Docker_
In the 
folder within the `master` branch, we provide a sample _dockerized_ microservices application to test out Chronos and to apply distributed tracing across different containers for your testing convenience.
The `docker` folder includes individual files in their respective directories. A docker-compose.yml is in the root directory in case you'd like to deploy all services together.
Refer to the [Docker README](./examples/docker/README.md) in the `docker` folder for more details.
#
#### _gRPC_
The `gRPC` folder includes an HTML frontend and an Express server backend, as well as proto files necessary to build package definitions and make gRPC calls. The _reverse_proxy_ folder contains the server that requires in the clients, which contain methods and services defined by proto files.
Refer to the [gRPC README](./examples/gRPC/README.md) in the `gRPC` folder for more details.
#
#### _Kubernetes_
The `kubernetes` folder includes a React frontend and an Express server backend, and the Dockerfiles needed to containerize them for Kubernetes deployment. The _launch_ folder includes the YAML files needed to configure the deployments, services, and configurations of the frontend, backend, Prometheus server, and Grafana.
Refer to the [Kubernetes README](./examples/kubernetes/README.md) in the `kubernetes` folder for more details.
#
#### _Microservices_
In the `microservices` folder, we provide a sample microservice application that successfully utilizes Chronos to apply all the powerful, built-in features of our monitoring tool. You can then visualize the data with the 
app.
Refer to the [microservices README](./examples/microservices/README.md) in the `microservices` folder for more details.
#
# Testing
We've created testing suites for Chronos with React Testing, Jest, and Selenium for unit, integration, and end-to-end tests - instructions on running them can be found in the [testing README](./__tests__/README.md).
#
## Contributing
Development of Chronos is open source on GitHub through the tech accelerator OS Labs, and we are grateful to the community for contributing bug fixes and improvements.
Read our [contributing README](CONTRIBUTING.md) to learn how you can take part in improving Chronos.
#### Past [Contributors](contributors.md)
#
## Technologies
## License
[MIT](https://github.com/oslabs-beta/Chronos/blob/master/LICENSE.md)
#
###### Return to [Top](#chronos)