Skip to content

Commit 50be65a

Browse files
committed
README changes in the overall repo, added repo in the chronos_npm_package folder
1 parent 9da2a61 commit 50be65a

File tree

2 files changed

+42
-5
lines changed

2 files changed

+42
-5
lines changed

README.md

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
2525
- [Configure Chronos Tracker](#configure-chronos-tracker)
2626
- [Initialize Chronos Tracker](#initialize-chronos-tracker)
2727
- [Docker Configuration](#docker-configuration)
28+
- [Kafka Configuration](#Apache-Monitoring-(Via-JMX-to-Prometheus-Exporter))
2829
- [Start Chronos](#start-chronos)
2930
- [Getting the Executable](#getting-the-chronos-executable)
3031
- [Notifications](#notifications)
@@ -317,6 +318,47 @@ volumes:
317318
- "/var/run/docker.sock:/var/run/docker.sock"
318319
```
319320

321+
322+
323+
### Apache Monitoring (Via JMX to Prometheus Exporter)
324+
325+
Chronos now offers the ability to monitor an Apache Kafka cluster via JMX to Prometheus Exporter. In order for this feature to work you must be running [JMX to Prometheus
326+
Exporter](https://github.com/prometheus/jmx_exporter) either as a Java Agent with your cluster or as a standalone HTTP server. Then, use `chronos-config.js` to specifiy the port exposed for metrics scraping.
327+
328+
To start, add the property `jmxuri` to the object in `chronos-config.js`. Your file should look similar to this:
329+
330+
```js
331+
const chronos = require('chronos-tracker-7');
332+
333+
chronos.use({
334+
microservice: 'payments',
335+
interval: 5000,
336+
dockerized: true,
337+
jmxuri: // your URI here
338+
database: {
339+
connection: 'REST',
340+
type: 'MongoDB',
341+
URI: process.env.URI,
342+
},
343+
notifications: [],
344+
});
345+
```
346+
The `jmxuri` property should be a string whose value is the port specified for scraping when starting the exporter.
347+
348+
Then, in ***ONE AND ONLY ONE** of your microservices, call
349+
350+
```js
351+
352+
chronos.kafka()
353+
354+
```
355+
356+
in your express server. When viewing your information in the Chronos Electron application the data will be available in the service "kafkametrics"
357+
358+
#
359+
###### Return to [Top](#chronos)
360+
<br>
361+
320362
### Start Chronos
321363

322364
Once you have configured and intialized Chronos Tracker, it will automatically record monitoring data when your servers are running. Finally, start the Chronos desktop app to view that data! After cloning our [GitHub repo](https://github.com/open-source-labs/Chronos), run `npm install` and `npm run both` to start Chronos.
@@ -417,9 +459,6 @@ Refer to the [README](link) in the `docker` folder for more details.
417459

418460
<br>
419461

420-
### gRPC Branch
421-
The **'gRPC'** branch is the current codebase for the <a href="#"><img src="./app/assets/npm-logo-color.png" alt="NPM" title="NPM" align="center" height="20" /></a> package, which is what you will install in your own application in order to use Chronos. Download the <a href="#"><img src="./app/assets/npm-logo-color.png" alt="NPM" title="NPM" align="center" height="20" /></a> package [here](https://www.npmjs.com/package/chronos-tracker).
422-
423462
## chronosWebsite
424463
This is the branch that holds the code base for the splash page. Edit the website by first running `git clone -b chronosWebsite https://github.com/open-source-labs/Chronos.git .` and then updating the aws S3 bucket with the changes.
425464

chronos_npm_package/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,8 +200,6 @@ Exporter](https://github.com/prometheus/jmx_exporter) either as a Java Agent wit
200200
To start, add the property `jmxuri` to the object in `chronos-config.js`. Your file should look similar to this:
201201

202202
```js
203-
// A sample `chronos-config.js` file
204-
205203
const chronos = require('chronos-tracker-7');
206204

207205
chronos.use({

0 commit comments

Comments
 (0)