Initial commit

Author: kwakayama

README.md

@@ -0,0 +1,38 @@
+# Node.js Application Monitoring with Prometheus and Grafana
+
+![](https://cdn.codersociety.com/uploads/keystone/nodejs-performance-monitoring-with-prometheus-and-grafana.png)
+
+We discuss this repository in this article in detail:
+https://codersociety.com/blog/articles/nodejs-application-monitoring-with-prometheus-and-grafana
+
+The repository contains a sample Node.js app which integrates the [Prometheus client for node.js](https://github.com/siimon/prom-client) and exposes metrics on [http://localhost:8080/metrics](http://localhost:8080/metrics). The metrics are periodically scraped by [Prometheus](https://prometheus.io) and visualized through a [Grafana](https://grafana.com/oss/grafana) monitoring dashboard.
+
+## Prerequisites
+Make sure that you have Docker and Docker Compose installed:
+- [Docker Engine](https://docs.docker.com/engine)
+- [Docker Compose](https://docs.docker.com/compose)
+
+## Getting started
+Clone the repository:
+```bash
+git clone https://github.com/coder-society/nodejs-monitoring-with-prometheus-and-grafana.git
+```
+
+Navigate into the project directory:
+```bash
+cd nodejs-monitoring-with-prometheus-and-grafana
+```
+
+ Start the Docker containers:
+```bash
+docker-compose up -d
+```
+
+## Test containers
+- Prometheus should be accessible via [http://localhost:9090](http://localhost:9090)
+- Grafana should be accessible via [http://localhost:3000](http://localhost:3000)
+- Example Node.js server metrics for RED monitoring should be accessible via [http://localhost:8080/metrics](http://localhost:8080/metrics)
+
+## Open monitoring dashboards
+Open in your web browser the monitoring dashboards:
+- Monitoring dashboard for the Node.js app can be found on[http://localhost:3000/d/1DYaynomMk/example-service-dashboard](http://localhost:3000/d/1DYaynomMk/example-service-dashboard)

docker-compose.yml

@@ -0,0 +1,45 @@
+version: '2.1'
+networks:
+  monitoring:
+    driver: bridge
+volumes:
+    prometheus_data: {}
+    grafana_data: {}
+services:
+  prometheus:
+    image: prom/prometheus:v2.20.1
+    container_name: prometheus
+    volumes:
+      - ./prometheus:/etc/prometheus
+      - prometheus_data:/prometheus
+    ports:
+      - 9090:9090
+    expose:
+      - 9090
+    networks:
+      - monitoring
+  grafana:
+    image: grafana/grafana:7.1.5
+    container_name: grafana
+    volumes:
+      - grafana_data:/var/lib/grafana
+      - ./grafana/provisioning:/etc/grafana/provisioning
+    environment:
+      - GF_AUTH_DISABLE_LOGIN_FORM=true
+      - GF_AUTH_ANONYMOUS_ENABLED=true
+      - GF_AUTH_ANONYMOUS_ORG_ROLE=Admin
+    ports:
+      - 3000:3000
+    expose:
+      - 3000
+    networks:
+      - monitoring
+  example-nodejs-app:
+    build:
+      context: example-nodejs-app
+    ports:
+      - 8080:8080
+    expose:
+      - 8080
+    networks:
+      - monitoring

example-nodejs-app/Dockerfile

@@ -0,0 +1,23 @@
+FROM node:13-alpine3.11 AS installer
+
+RUN mkdir /app
+WORKDIR /app
+
+COPY package.json /app/
+COPY package-lock.json /app/
+
+RUN npm install
+
+FROM node:13-alpine3.11
+
+RUN mkdir /app
+WORKDIR /app
+
+COPY index.js /app
+
+COPY --from=installer /app/package.json .
+COPY --from=installer /app/node_modules ./node_modules
+
+EXPOSE 8080
+
+CMD npm start

example-nodejs-app/index.js

@@ -0,0 +1,62 @@
+const http = require('http')
+const url = require('url');
+const client = require('prom-client')
+
+const register = new client.Registry()
+
+register.setDefaultLabels({
+  app: 'example-nodejs-app'
+})
+
+client.collectDefaultMetrics({ register })
+
+const httpRequestDurationMicroseconds = new client.Histogram({
+  name: 'http_request_duration_seconds',
+  help: 'Duration of HTTP requests in seconds',
+  labelNames: ['method', 'route', 'code'],
+  buckets: [0.1, 0.3, 0.5, 0.7, 1, 3, 5, 7, 10] // 0.1 to 10 seconds
+})
+
+register.registerMetric(httpRequestDurationMicroseconds)
+
+const createOrderHandler = async (req, res) => {
+  // return an error 1% of the time
+  if ((Math.floor(Math.random() * 100)) === 0) {
+    throw new Error('Internal Error')
+  }
+
+  // delay for 3-6 seconds
+  const delaySeconds = Math.floor(Math.random() * (6 - 3)) + 3
+  await new Promise(res => setTimeout(res, delaySeconds * 1000))
+
+  res.end('Order created successfully');
+}
+
+const server = http.createServer(async (req, res) => {
+  const end = httpRequestDurationMicroseconds.startTimer();
+  const route = url.parse(req.url).pathname;
+
+  try {
+      if (route === '/metrics') {
+        res.setHeader('Content-Type', register.contentType)
+        res.end(register.metrics())
+      }
+
+      if (route === '/order') {
+        await createOrderHandler(req, res)
+      }
+
+  } catch (error) {
+    res.writeHead(500).end()
+  }
+
+  if (!res.finished) {
+    res.writeHead(404).end() // Default 404 handler
+  }
+
+  end({ route, code: res.statusCode, method: req.method })
+})
+
+server.listen(8080, () => {
+  console.log('Server is running on http://localhost:8080, metrics are exposed on http://localhost:8080/metrics')
+})

example-nodejs-app/package-lock.json

@@ -0,0 +1,22 @@
+{
+  "name": "example-nodejs-app",
+  "version": "1.0.0",
+  "description": "Node.js Monitoring with Prometheus and Grafana",
+  "main": "index.js",
+  "scripts": {
+    "start": "node index.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "prometheus",
+    "node.js",
+    "monitoring",
+    "grafana",
+    "metrics"
+  ],
+  "author": "Kentaro Wakayama",
+  "license": "ISC",
+  "dependencies": {
+    "prom-client": "^12.0.0"
+  }
+}

example-nodejs-app/package.json

@@ -0,0 +1,11 @@
+apiVersion: 1
+
+providers:
+- name: 'Prometheus'
+  orgId: 1
+  folder: ''
+  type: file
+  disableDeletion: false
+  editable: true
+  options:
+    path: /etc/grafana/provisioning/dashboards