feat: add elastic apm and logstash components

Author: cunkz

.env.example

@@ -4,4 +4,16 @@ STORAGE_LOCATION=files
 SYSTEM_SHUTDOWN_DELAY=0
 MONGODB_URL='mongodb://localhost:27017/example?maxPoolSize=10&socketTimeoutMS=10000&connectTimeoutMS=10000&useUnifiedTopology=true'
 AUTH_BASIC_USERNAME=
-AUTH_BASIC_PASSWORD=
+AUTH_BASIC_PASSWORD=
+
+LOGSTASH_IS_ENABLE=false
+LOGSTASH_BASE_URL=
+LOGSTASH_PORT_URL=
+LOGSTASH_SSL_ENABLE=
+LOGSTASH_MAX_CONNECT_RETRIES=
+
+ELASTIC_APM_IS_ENABLE=false
+ELASTIC_APM_SERVER_URL=
+ELASTIC_APM_SECRET_TOKEN=
+ELASTIC_APM_API_KEY=
+ELASTIC_APM_OPTIONS='{}'

bin/app/server.js

@@ -1,5 +1,6 @@
 const project = require('../../package.json');
 const configs = require('../helpers/configs/global_config');
+const apm = require('../helpers/components/elastic-apm/apm');
 const { GracefulShutdown, livenessProbe, readinessProbe } = require('../helpers/components/system/graceful_shutdown');
 const observers = require('./observers');
 const multer = require("multer");
@@ -37,7 +38,10 @@ class AppServer {
   async init() {
     // Initiation
     try {
-      await Promise.all([observers.init()]);
+      await Promise.all([
+        observers.init(),
+        apm.init()
+      ]);
 
       const gs = new GracefulShutdown(configs.get('/system/shutdownDelay'));
       gs.enable(this.server);

bin/helpers/components/elastic-apm/apm.js

@@ -0,0 +1,21 @@
+const apm = require('elastic-apm-node');
+const project = require('../../../../package.json');
+const configs = require('../../../infra/configs/global_config');
+
+const init = () => {
+  if(configs.get('/elasticApm/isEnable')) {
+    const options = {
+      serviceName: project.name,
+      serviceVersion: project.version,
+      serverUrl: configs.get('/elasticApm/serverUrl'),
+      secretToken: configs.get('/elasticApm/secretToken'),
+      apiKey: configs.get('/elasticApm/apiKey'),
+    };
+    options = { ...options, ...configs.get('/elasticApm/options') };
+    apm.start(options);
+  }
+};
+
+module.exports = {
+  init
+};

bin/helpers/configs/global_config.js

@@ -19,6 +19,20 @@ const config = {
   mongodb: {
     url: process.env.MONGODB_URL,
   },
+  logstash: {
+    isEnable: process.env.LOGSTASH_IS_ENABLE === 'true',
+    host: process.env.LOGSTASH_BASE_URL,
+    port: process.env.LOGSTASH_PORT_URL,
+    ssl_enable: process.env.LOGSTASH_SSL_ENABLE === 'true',
+    max_connect_retries: process.env.LOGSTASH_MAX_CONNECT_RETRIES,
+  },
+  elasticApm: {
+    isEnable: process.env.ELASTIC_APM_IS_ENABLE === 'true',
+    serverUrl: process.env.ELASTIC_APM_SERVER_URL,
+    secretToken: process.env.ELASTIC_APM_SECRET_TOKEN,
+    apiKey: process.env.ELASTIC_APM_API_KEY,
+    options: (process.env.ELASTIC_APM_OPTIONS ? JSON.parse(process.env.ELASTIC_APM_OPTIONS) : {}),
+  },
 };
 
 const store = new confidence.Store(config);

bin/helpers/utils/logger.js

@@ -1,3 +1,4 @@
+const project = require('../../../package.json');
 const winston = require('winston');
 
 let transports = [
@@ -10,6 +11,14 @@ let transports = [
   }),
 ];
 
+if(config.get('/logstash/isEnable')) {
+  const logstashConfig = config.get('/logstash');
+  logstashConfig.node_name = project.name;
+  transports.push(
+    new winston.transports.Logstash(logstashConfig)
+  );
+}
+
 let logger = winston.createLogger({
   transports: transports,
   exitOnError: false

package.json

@@ -15,6 +15,7 @@
     "body-parser": "^1.20.2",
     "confidence": "^5.0.1",
     "dotenv": "^16.4.0",
+    "elastic-apm-node": "^4.4.0",
     "express": "^4.18.2",
     "http-errors": "^2.0.0",
     "http-status-codes": "^2.3.0",
@@ -27,6 +28,7 @@
     "passport-http": "^0.3.0",
     "uuid": "^9.0.1",
     "validate.js": "^0.13.1",
-    "winston": "^3.11.0"
+    "winston": "^3.11.0",
+    "winston-logstash": "^1.2.1"
   }
 }