Skip to content

Commit b7ffe13

Browse files
committed
Removing images from npm package readme to reduce installation size
1 parent 95b6e97 commit b7ffe13

23 files changed

+24
-50
lines changed

chronos_npm_package/README.md

Lines changed: 24 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,24 @@
1-
<a href="https://chronoslany.com/">
2-
<img src="assets/animated_logo.gif" alt="Chronos" title="Chronos" align="center" height="500" />
3-
</a>
4-
<br>
5-
<br>
6-
7-
81
# Chronos
9-
![Build Passing](https://img.shields.io/badge/build-passing-blue)
10-
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/open-source-labs/Chronos)
11-
![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
12-
![Release: 8.0.1](https://img.shields.io/badge/Release-8.0.1-orange)
13-
142
Chronos is a comprehensive developer tool that monitors the health and web traffic of servers, microservices, and containers. Use Chronos to see real-time data monitoring and receive automated notifications over Slack or email.
153

164
#
175

186
## What's New?
7+
- Bug Fixes
198
- Metric query tool so you can filter out specific metrics — now you only have to see what you want on the dashboard.
209
- Additional metrics added, bringing Chronos up from only 12 to 100+ metrics that are currently available
2110
- Option to filter by category and individual metric, and flip between services and categories with ease
2211
- Kubernetes monitoring via Prometheus server
2312
- Apache Kafka monitoring capability, all you need to do is run Prometheus JMX exporter on the system your Chronos application is running on. A sample JMX config.yaml file is provided in the Chronos repository for a quick and easy setup, however you are free to configure however you like.
24-
- Bug fixes and UI tweaks — Chronos is now a more seamless experience than ever.
2513

2614
#
2715

2816
## Features
2917
- Distributed tracing enabled across microservice applications
30-
- Supports <a href="#"><img src="assets/postgres-logo-color.png" alt="PostgreSQL" title="PostgreSQL" align="center" height="20" /></a> and <img src="assets/mongo-logo-color.png" alt="MongoDB" title="MongoDB" align="center" height="20" /></a> databases
18+
- Supports PostgreSQL and MongoDB databases
3119
- Displays real-time temperature, speed, latency, and memory statistics
3220
- Display and compare multiple microservice metrics in a single graph
33-
- Monitor an <a href="#"><img src="assets/pngwing.com.png" alt="Apache Kafka" title="Apache Kafka" align="center" height="20" /></a> cluster via the JMX Prometheus Exporter
21+
- Monitor an Apache Kafka cluster via the JMX Prometheus Exporter
3422
- Monitor a Kubernetes cluster via a Prometheus monitoring server
3523

3624
#
@@ -127,7 +115,7 @@ notifications: [
127115
]
128116
// ...
129117
```
130-
Chronos uses the <a href="#"><img src="assets/slack-logo-color.png" alt="Slack" title="Slack" align="center" height="20" /></a> API to send messages to a Slack channel and only requires the **webhook url**. Learn how to set up [Slack webhooks](https://api.slack.com/messaging/webhooks) for your team.
118+
Chronos uses the Slack API to send messages to a Slack channel and only requires the **webhook url**. Learn how to set up [Slack webhooks](https://api.slack.com/messaging/webhooks) for your team.
131119

132120
**Email**
133121
```js
@@ -159,7 +147,7 @@ _NOTE: Email notification settings may require alternative security settings to
159147
<br>
160148

161149
### Chronos Tracker for "Microservices" Mode
162-
The mode `microservices` uses the additional setting `dockerized`, which indicates whether or not the microservice has been containerized with <img src="assets/docker-logo-color.png" alt="Docker" title="Docker" align="center" height="20" />. If omitted, Chronos will assume this server is not running in a container, i.e. `dockerized` will default to _false_.
150+
The mode `microservices` uses the additional setting `dockerized`, which indicates whether or not the microservice has been containerized with Docker. If omitted, Chronos will assume this server is not running in a container, i.e. `dockerized` will default to _false_.
163151

164152
Setting the flag to _false_ will collect metrics from the host computer directly, while _true_ indicates for Chronos to pull metrics from the Docker daemon.
165153

@@ -203,7 +191,7 @@ app.use('/', trackingMiddleware);
203191
```
204192

205193
#### Special Notes on Dockerized Microservices
206-
<img src="assets/important.png" alt="Important" title="Important" align="center" height="20" /> Give your containers the same names you pass in as arguments for microservice names.
194+
**IMPORTANT:** Give your containers the same names you pass in as arguments for microservice names.
207195

208196
In order to have container statistics saved to your database along with other health info, bind volumes to this path when starting up the containers:
209197
```
@@ -410,56 +398,42 @@ chronos.link(client, ServerWrapper);
410398
### Viewing Chronos Data
411399
Once you have configured and intialized Chronos Tracker, it will automatically record monitoring data when your servers are running. The data will be saved into your database of choice, and then start the Chronos desktop app to view by cloning our [GitHub repo](https://github.com/open-source-labs/Chronos). Folow the ReadMe in that repo to setup the Chronos desktop app.
412400

413-
#
401+
<br>
414402

415-
### _Examples_
403+
## Examples
416404

417405
We provide working example microservice applications in Chronos desktop app repo in the *examples* folder.
418406
[GitHub repo](https://github.com/open-source-labs/Chronos)
419407

420-
421-
###### Return to [Top](#chronos)
422-
423-
<br>
408+
#
424409

425410
## Technologies
426-
427-
- <a href="#"><img src="assets/electron-logo-color.png" alt="Electron" title="Electron" align="center" height="30" /></a>
428-
- <a href="#"><img src="assets/react-logo-color.png" alt="React" title="React" align="center" height="30" /></a>
429-
- <a href="#"><img src="assets/js-logo-color.png" alt="JavaScript" title="JavaScript" align="center" height="30" /></a>
430-
- <a href="#"><img src="assets/ts-logo-long-blue.png" alt="TypeScript" title="TypeScript" align="center" height="30" /></a>
431-
- <a href="#"><img src="assets/postgres-logo-color.png" alt="PostgreSQL" title="PostgreSQL" align="center" height="30" /></a>
432-
- <a href="#"><img src="assets/mongo-logo-color.png" alt="MongoDB" title="MongoDB" align="center" height="30" /></a>
433-
- <a href="#"><img src="assets/node-logo-color.png" alt="Node" title="Node" align="center" height="30" /></a>
434-
- <a href="#"><img src="assets/express-logo-color.png" alt="Express" title="Express" align="center" height="30" /></a>
435-
- <a href="#"><img src="assets/http-logo-color.png" alt="HTTP" title="HTTP" align="center" height="30" /></a>
436-
- <a href="#"><img src="assets/grpc-logo-color.png" alt="gRPC" title="gRPC" align="center" height="30" /></a>
437-
- <a href="#"><img src="assets/docker-logo-color.png" alt="Docker" title="Docker" align="center" height="30" /></a>
438-
- <a href="#"><img src="assets/aws-logo-color.png" alt="AWS" title="AWS" align="center" height="30" /></a>
439-
- <a href="#"><img src="assets/jest-logo-color.png" alt="Jest" title="Jest" align="center" height="30" /></a>
440-
- <a href="#"><img src="assets/webpack-logo-color.png" alt="Webpack" title="Webpack" align="center" height="30" /></a>
441-
- <a href="#"><img src="assets/material-ui-logo-color.png" alt="Material-UI" title="Material-UI" align="center" height="30" /></a>
442-
- <a href="#"><img src="assets/vis-logo-color.png" alt="Vis.js" title="Vis.js" align="center" height="30" /></a>
443-
- <a href="#"><img src="assets/plotly-logo-color.png" alt="Plotly.js" title="Plotly.js" align="center" height="30" /></a>
444-
- <a href="#"><img src="assets/pngwing.com.png" alt="Apache Kafka" title="Apache Kafka" align="center" height="30" /></a>
411+
- Electron
412+
- JavaScript
413+
- TypeScript
414+
- PostgreSQL
415+
- MongoDB
416+
- Node
417+
- Express
418+
- HTTP
419+
- RPC
420+
- Docker
421+
- Apache Kafka
422+
- Docker
423+
- Kubernetes
445424

446425
#
447-
###### Return to [Top](#chronos)
448-
<br>
449-
450426

451427
## Contributing
452428

453429
Development of Chronos is open source on GitHub through the tech accelerator umbrella OS Labs, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving Chronos.
454430

455431
- [Contributing](https://github.com/oslabs-beta/Chronos/blob/master/CONTRIBUTING.md)
456-
#
457-
###### Return to [Top](#chronos)
458-
<br>
459432

433+
#
460434

461435
## License
462436

463-
Chronos is <a href="#"><img src="assets/mit-logo-color.png" alt="MIT" title="MIT" align="center" height="20" /></a> [licensed.](https://github.com/oslabs-beta/Chronos/blob/master/LICENSE.md)
437+
Chronos is MIT licenced
464438
#
465439
###### Return to [Top](#chronos)
-6.25 MB
Binary file not shown.
-86.7 KB
Binary file not shown.
-37.3 KB
Binary file not shown.
Binary file not shown.
-8.05 KB
Binary file not shown.
-45.8 KB
Binary file not shown.
-72.8 KB
Binary file not shown.
-36.6 KB
Binary file not shown.
-3.77 KB
Binary file not shown.

0 commit comments

Comments
 (0)