modified

Author: eishakaushal

.nyc_output/6afafb04-53de-4650-8a6f-e99dbdd3dee9.json

@@ -0,0 +1 @@
+{}

.nyc_output/processinfo/6afafb04-53de-4650-8a6f-e99dbdd3dee9.json

@@ -0,0 +1 @@
+{"parent":"7ce5bbc3-ccce-4f76-a001-595a6a22ccc5","pid":46687,"argv":["/Users/eishakaushal/.nvm/versions/node/v18.16.0/bin/node","/Users/eishakaushal/Chronos/node_modules/.bin/tsc"],"execArgv":[],"cwd":"/Users/eishakaushal/Chronos","time":1692737594551,"ppid":46686,"coverageFilename":"/Users/eishakaushal/Chronos/.nyc_output/6afafb04-53de-4650-8a6f-e99dbdd3dee9.json","externalId":"","uuid":"6afafb04-53de-4650-8a6f-e99dbdd3dee9","files":[]}

chronos_npm_package/README.md

@@ -1,9 +1,10 @@
 ## What's New?
+- Enhanced Metrics Collection: Docker now supports Prometheus metrics scraping, offering improved monitoring capabilities
+- Streamlined Visualization: Docker and Kubernetes integrate with Grafana to provide dynamic visualization of collected metrics
+- Ability to select graph type and process kubernetes resource data
 - Bug Fixes
 - Refactored code for additional modularity and customization
-- Ability for developers to increase number of metrics monitored for microservices
-- Connected to Grafana interface.
-- Ability to select graph type and process kubernetes resource data
+
 #
 
 ## Features 
@@ -12,7 +13,7 @@
 - Displays real-time temperature, speed, latency, and memory statistics
 - Display and compare multiple microservice metrics in a single graph
 - Monitor an Apache Kafka cluster via the JMX Prometheus Exporter
-- Monitor Docker and Kubernetes cluster via a Prometheus monitoring server and display charts using Grafana
+- Monitor Docker and Kubernetes clusters via a Prometheus monitoring server and display charts using Grafana
 
 #
 
@@ -54,10 +55,18 @@ module.exports = {
   mode: 'kubernetes',
   promService: 'prometheus-service',
   promPort: 8080,
+  grafanaAPIKey: process.env.CHRONOS_GRAFANA_API_KEY,
 
   // (c) Apache Kafka
   mode: 'kafka',
   jmxuri: '<insert URI>',
+
+  // (d) Docker
+  mode: 'docker',
+  promService: 'docker.for.mac.localhost',
+  promPort: 9090,
+  grafanaAPIKey: process.env.CHRONOS_GRAFANA_API_KEY,
+
   /*  USE ONE OF THE MODE-SPECIFIC CONFIGURATIONS ABOVE   */
 
   // Notifications
@@ -87,7 +96,7 @@ The `database` property is required and takes in the following:
 - `type` should be a string and only supports 'MongoDB' and 'PostgreSQL' at this time
 - `URI` should be a connection string to the database where you intend Chronos to write and record data regarding health, HTTP route tracing, and container infomation
 
-The `mode` property accepts a string that can either be 'microservices', 'kubernetes', or 'kafka'. There are other settings that depend on the mode choice, so these are broken down in the "Chronos Tracker for Microservices" section.
+The `mode` property accepts a string that can either be 'microservices', 'kubernetes', 'kafka', or 'docker'. There are other settings that depend on the mode choice, so these are broken down in the "Chronos Tracker for Microservices" section.
 
 The `notifications` property is an array that can be optionally left empty. It allows developers to be alerted when the server responds to requests with status codes >= 400. To set up notifications, set the value of the `notifications` property to an array of objects, each with a `type` and `settings` property. 
 
@@ -269,6 +278,40 @@ When viewing your information in the Chronos Electron application the data will
 
 **NOTE:** We provide a jmx_config.yaml file in the Chronos root folder for use with JMX prometheus that provides some useful baseline metrics to monitor.
 
+### Chronos Tracker for "docker" Mode
+Chronos can monitor Docker containers by saving metric data from instant queries to a Prometheus server in your Docker container. 
+
+In `chronos-config.js`, set the `mode` to `docker` and pass it both the name of the port the Prometheus server is listening on INSIDE the container, and the name of the Prometheus service so that its IP address can be resolved using DNS.
+
+Also add a `grafanaAPIKey` section, this API key will grant chronos access to create and update dashboards in Grafana.
+
+```js
+// Excerpt from a chronos-config.js
+
+module.exports = {
+  // ...
+
+  mode: 'docker',
+  promService: 'docker.for.mac.localhost',
+  promPort: 8080,
+
+  grafanaAPIKey: process.env.CHRONOS_GRAFANA_API_KEY,
+
+  // ...
+}
+
+```
+
+Then, insert the code below into a **SINGLE** microservice that will be deployed only as a **SINGLE** container, call `Chronos.docker`:
+
+```js
+const chronosConfig = require('./chronos-config.js');
+const Chronos = require('@chronosmicro/tracker');
+const chronos = new Chronos(chronosConfig);
+
+chronos.docker();
+```
+
 ### Chronos Tracker for gRPC
 
 To monitor your gRPC server, setup `chronos-config.js` as if it was a standard microservices example, but be sure to set the `connection` type to `gRPC`.