Tracing node.js applications

Choose your platform

Instance

Node.JS Express

1. Install nodejs dependencies and save it in package.json using

   npm install --save elastic-apm-node@^3.20.0npm install --save sf-apm-lib@^1.0.2

   or update package.json file with following entries

   "elastic-apm-node": "^3.20.0""sf-apm-lib": "^1.0.2" 

2. And run ‘npm install’ to install dependencies

2. Provide SF_PROJECT_NAME, SF_APP_NAME, SF_PROFILE_KEY as an environment variable in .env file and load it using require('dotenv').config() and access it in code using process.env.<ENV_VAR>

3. Add initilization code at start of the file

   1. Get Snappyflow trace config using

      const Snappyflow = require('sf-apm-lib');var sfObj = new Snappyflow(); // Initialize Snappyflow. By default intialization will take profileKey, projectName and appName from sfagent config.yaml. 
      // Add below part to manually configure the initialization let projectName = process.env.SF_PROJECT_NAME; let appName = process.env.SF_APP_NAME; let profileKey = process.env.SF_PROFILE_KEY; sfObj.init(profileKey, projectName, appName); // Manual override
      let sfTraceConfig = sfObj.getTraceConfig(); 

   2. Initialize apm object using

      var apm; try {    apm = require('elastic-apm-node').start({          serviceName: '<SERVICE_NAME>', // Specify your service name for tracing          serverUrl: sfTraceConfig['SFTRACE_SERVER_URL'],          globalLabels: sfTraceConfig['SFTRACE_GLOBAL_LABELS'],          verifyServerCert: sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'] === undefined ? false : sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'],          active: sfTraceConfig['SFTRACE_SERVER_URL'] === undefined ? false : true,          stackTraceLimit: sfTraceConfig['SFTRACE_STACK_TRACE_LIMIT'],          captureSpanStackTraces: sfTraceConfig['SFTRACE_CAPTURE_SPAN_STACK_TRACES']     }) } catch (e) {    console.log(e); } 

   3. Provide SF_PROJECT_NAME, SF_APP_NAME, SF_PROFILE_KEY as an environment variables in add container section of task definitions.

      https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html

   4. Once your server is up and running you can check trace in Snappyflow Server.

      For viewing trace in Snappyflow server make sure project and app name is created or discovered with project name and app name specified in point no.2

      Once project and app name is created go to:

      View dashboard -> Click on Tracing on left side bar -> Click on view transaction -> Go to real time tab

   5. For complete code refer sample app refer at:

      https://github.com/snappyflow/tracing-reference-apps/tree/master/refapp-express

Node.JS Script

1. Install nodejs dependencies and save it in package.json using

   npm install --save elastic-apm-node@^3.20.0  npm install --save sf-apm-lib@^1.0.2 

   or update package.json file with following entries:

   "elastic-apm-node": "^3.20.0" "sf-apm-lib": "^1.0.2" 

   And run ‘npm install’ to install dependencies

2. Add initilization code at start of the file

   1. Get Snappyflow trace config using

      const Snappyflow = require('sf-apm-lib'); let projectName = <SF_PROJECT_NAME>; //replace with appropriate project name let appName = <SF_APP_NAME>; //replace with appropriate application name let profileKey = <SF_PROFILE_KEY>; //replace with key copied from SF profile
      var sfObj = new Snappyflow(); sfObj.init(profileKey, projectName, appName); let sfTraceConfig = sfObj.getTraceConfig(); 

   2. Initialize apm object using

      var apm;try {    apm = require('elastic-apm-node').start({         serviceName: '<SERVICE_NAME>', // Specify service name for tracing         serverUrl: sfTraceConfig['SFTRACE_SERVER_URL'],         globalLabels: sfTraceConfig['SFTRACE_GLOBAL_LABELS'],         verifyServerCert: sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'] === undefined ? false : sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'],          active: sfTraceConfig['SFTRACE_SERVER_URL'] === undefined ? false : true,         stackTraceLimit: sfTraceConfig['SFTRACE_STACK_TRACE_LIMIT'],         captureSpanStackTraces: sfTraceConfig['SFTRACE_CAPTURE_SPAN_STACK_TRACES']     }) } catch (e) {     console.log(e); } 

   3. Create a custom transaction and span within transaction using following code

      var trans = apm.startTransaction('json transaction', 'reference-app'); var span = apm.startSpan('parse json'); try {    JSON.parse('{"app": "test"}') } catch (e) {    apm.captureError(e); // Capture the error using apm.captureError(e) method.}  // when we've processed, stop the custom span if (span) span.end()    trans.result = err ? 'error' : 'success'; // end the transaction trans.end(); 

      For more info refer

      https://www.elastic.co/guide/en/apm/agent/nodejs/current/custom-transactions.html

      https://www.elastic.co/guide/en/apm/agent/nodejs/current/custom-spans.html

   4. Run you script using node <file_name.js> you should see trace data in Snappyflow server.

      For viewing trace in Snappyflow server make sure project and app name is created or discovered with project name and app name specified in point no.2

      Once project and app name is created go to: View dashboard -> Click on Tracing on left side bar -> Click on view transaction -> Go to real time tab

   5. Refer sample script file at:

      https://github.com/snappyflow/tracing-reference-apps/blob/master/refapp- express/node_trace_script.js

Node.JS Sails

1. Install nodejs dependencies and save it in package.json using

   npm install --save elastic-apm-node@^3.20.0  npm install --save sf-apm-lib@^1.0.2 

   or update package.json file with following entries

   "elastic-apm-node": "^3.20.0" "sf-apm-lib": "^1.0.2" 

   And run ‘npm install’ to install dependencies

2. Provide SF_PROJECT_NAME, SF_APP_NAME, SF_PROFILE_KEY as an environment variable in .env file and load it using require('dotenv').config() and access it in code using process.env.<ENV_VAR>

3. Add initilization code at start of the file in globals.js present in config folder.

   1. Get Snappyflow trace config using:

      const Snappyflow = require('sf-apm-lib');
      var sfObj = new Snappyflow(); // Initialize Snappyflow. By default intialization will take profileKey, projectName and appName from sfagent config.yaml.
      // Add below part to manually configure the initialization let projectName = process.env.SF_PROJECT_NAME; let appName = process.env.SF_APP_NAME; let profileKey = process.env.SF_PROFILE_KEY; sfObj.init(profileKey, projectName, appName); // Manual override
      let sfTraceConfig = sfObj.getTraceConfig(); 

   2. Initialize apm object using:

      var apm; try {    apm = require('elastic-apm-node').start({         serviceName: '<SERVICE_NAME>', // Specify your service name for tracing         serverUrl: sfTraceConfig['SFTRACE_SERVER_URL'],         globalLabels: sfTraceConfig['SFTRACE_GLOBAL_LABELS'],         verifyServerCert: sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'] === undefined ? false : sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'],          active: sfTraceConfig['SFTRACE_SERVER_URL'] === undefined ? false : true,         stackTraceLimit: sfTraceConfig['SFTRACE_STACK_TRACE_LIMIT'],         captureSpanStackTraces: sfTraceConfig['SFTRACE_CAPTURE_SPAN_STACK_TRACES']     }) } catch (e) {    console.log(e); } 

   3. Attach apm object to globals – This is required so we can use apm variable in other files as part of global sails object.

      module.exports.globals = {    _: require('@sailshq/lodash'),    async: false,    models: true,    sails: true,    apm : apm,    logger: logger }; 

   4. Also add middleware in http.js file present in config folder. Which allows to instrument our code.

      module.exports.http = {    middleware: {       order: [          'elasticAPM'       ],       elasticAPM: (function () {          return function (err, req, res, next) {             apm.middleware.connect();             if (typeof err !== 'undefined')                apm.captureError(err);             return next();          };       })()   }    }; 

4. Once your server is up and running you can check trace in Snappyflow Server.

   For viewing trace in snappyflow server make sure project and app name is created or discovered with project name and app name specified in point no.2

   Once project and app name is created go to

   View dashboard -> Click on Tracing on lef side bar -> Click on view transaction -> Go to real time tab

5. For complete code refer sample app refer at:

   https://github.com/snappyflow/tracing-reference-apps/tree/master/RefappNodeSail

Kubernetes

Node.JS Express

1. Install nodejs dependencies and save it in package.json using

   npm install --save elastic-apm-node@^3.20.0  npm install --save sf-apm-lib@^1.0.2 

   or update package.json file with following entries:

   "elastic-apm-node": "^3.20.0"  "sf-apm-lib": "^1.0.2" 

   And run ‘npm install’ to install dependencies

2. Add initilization code at start of the file in app.js

   1. Get Snappyflow trace config using

      const Snappyflow = require('sf-apm-lib'); var sfObj = new Snappyflow(); // Initialize Snappyflow. By default intialization will take profileKey, projectName and appName from sfagent config.yaml.
      // Add below part to manually configure the initialization let projectName = process.env.SF_PROJECT_NAME; let appName = process.env.SF_APP_NAME; let profileKey = process.env.SF_PROFILE_KEY; sfObj.init(profileKey, projectName, appName); // Manual override
      let sfTraceConfig = sfObj.getTraceConfig(); 

   2. Initialize apm object using

      var apm; try {    apm = require('elastic-apm-node').start({       serviceName: '<SERVICE_NAME>', // Specify your service name for tracing       serverUrl: sfTraceConfig['SFTRACE_SERVER_URL'],       globalLabels: sfTraceConfig['SFTRACE_GLOBAL_LABELS'],       verifyServerCert: sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'] === undefined ? false : sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'],       active: sfTraceConfig['SFTRACE_SERVER_URL'] === undefined ? false : true,       stackTraceLimit: sfTraceConfig['SFTRACE_STACK_TRACE_LIMIT'],       captureSpanStackTraces: sfTraceConfig['SFTRACE_CAPTURE_SPAN_STACK_TRACES']    }) } catch (e) {    console.log(e); } 

   3. Provide SF_PROJECT_NAME, SF_APP_NAME, SF_PROFILE_KEY as an environment variables in Kubernetes deployment file.

      https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/

   4. Once your server is up and running you can check trace in Snappyflow Server.

      For viewing trace in Snappyflow server make sure project and app name is created or discovered with project name and app name specified in point no.2

      Once project and app name is created go to: View dashboard -> Click on Tracing on left side bar -> Click on view transaction -> Go to real time tab

   5. For complete code refer sample app refer at:

      https://github.com/snappyflow/tracing-reference-apps/tree/master/refapp-express

Node.JS Sails

1. Install nodejs dependencies and save it in package.json using

   npm install --save elastic-apm-node@^3.20.0  npm install --save sf-apm-lib@^1.0.2 

   or update package.json file with following entries:

   "elastic-apm-node": "^3.20.0" "sf-apm-lib": "^1.0.2" 

   And run ‘npm install’ to install dependencies

2. Add initilization code at start of the file in globals.js present in config folder.

   1. Get Snappyflow trace config using

      const Snappyflow = require('sf-apm-lib'); var sfObj = new Snappyflow(); // Initialize Snappyflow. By default intialization will take profileKey, projectName and appName from sfagent config.yaml.
      // Add below part to manually configure the initialization let projectName = process.env.SF_PROJECT_NAME; let appName = process.env.SF_APP_NAME; let profileKey = process.env.SF_PROFILE_KEY; sfObj.init(profileKey, projectName, appName); // Manual override
      let sfTraceConfig = sfObj.getTraceConfig(); 

   2. Initialize apm object using

      var apm; try {    apm = require('elastic-apm-node').start({       serviceName: '<SERVICE_NAME>', // Specify your service name for tracing       serverUrl: sfTraceConfig['SFTRACE_SERVER_URL'],       globalLabels: sfTraceConfig['SFTRACE_GLOBAL_LABELS'],       verifyServerCert: sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'] === undefined ? false : sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'],       active: sfTraceConfig['SFTRACE_SERVER_URL'] === undefined ? false : true,       stackTraceLimit: sfTraceConfig['SFTRACE_STACK_TRACE_LIMIT'],       captureSpanStackTraces: sfTraceConfig['SFTRACE_CAPTURE_SPAN_STACK_TRACES']    }) } catch (e) {    console.log(e); } 

   3. Attach apm object to globals – This is required so we can use apm variable in other files as part of global sails object

      module.exports.globals = {    _: require('@sailshq/lodash'),    async: false,    models: true,    sails: true,    apm : apm,    logger: logger }; 

   4. Also add middleware in http.js file present in config folder. Which allows to instrument our code

      module.exports.http = {   middleware: {       order: [          'elasticAPM'       ],       elasticAPM: (function () {          return function (err, req, res, next) {          apm.middleware.connect();          if (typeof err !== 'undefined')             apm.captureError(err);          return next();          };       })()    }}; 

3. Provide SF_PROJECT_NAME, SF_APP_NAME, SF_PROFILE_KEY as an environment variables in Kubernetes deployment file.

   https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/

   If deploying with helm provide above variables in values.yaml and use them in deployment file of charts.

   https://phoenixnap.com/kb/helm-environment-variables

4. Once your server is up and running you can check trace in Snappyflow Server.

   For viewing trace in snappyflow server make sure project and app name is created or discovered with project name and app name specified in point no.2

   Once project and app name is created go to

   View dashboard -> Click on Tracing on lef side bar -> Click on view transaction -> Go to real time tab

5. For complete code refer sample app refer at:

   https://github.com/snappyflow/tracing-reference-apps/tree/master/RefappNodeSail

Docker

Node.JS Express

1. Install nodejs dependencies and save it in package.json using

   RUN npm install --save elastic-apm-node@^3.20.0 RUN npm install --save sf-apm-lib@^1.0.2 

   or update package.json file with following entries:

   "elastic-apm-node": "^3.20.0" "sf-apm-lib": "^1.0.2" 

   And run ‘npm install’ to install dependencies

2. Add initilization code at start of the file in app.js

   1. Get Snappyflow trace config using

      const Snappyflow = require('sf-apm-lib'); var sfObj = new Snappyflow(); // Initialize Snappyflow. By default intialization will take profileKey, projectName and appName from sfagent config.yaml.
      // Add below part to manually configure the initialization let projectName = process.env.SF_PROJECT_NAME; let appName = process.env.SF_APP_NAME; let profileKey = process.env.SF_PROFILE_KEY; sfObj.init(profileKey, projectName, appName); // Manual override
      let sfTraceConfig = sfObj.getTraceConfig();

   2. Initialize apm object using

      var apm; try {    apm = require('elastic-apm-node').start({       serviceName: '<SERVICE_NAME>', // Specify your service name for tracing       serverUrl: sfTraceConfig['SFTRACE_SERVER_URL'],       globalLabels: sfTraceConfig['SFTRACE_GLOBAL_LABELS'],       verifyServerCert: sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'] === undefined ? false : sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'],       active: sfTraceConfig['SFTRACE_SERVER_URL'] === undefined ? false : true,       stackTraceLimit: sfTraceConfig['SFTRACE_STACK_TRACE_LIMIT'],       captureSpanStackTraces: sfTraceConfig['SFTRACE_CAPTURE_SPAN_STACK_TRACES']    }) } catch (e) {    console.log(e); } 

3. Provide SF_PROJECT_NAME, SF_APP_NAME, SF_PROFILE_KEY as an environment variables in docker-compose.yml or docker stack deployment file or at command line when using docker run command for deployment.

   Eg:

   Docker-compose and stack: https://docs.docker.com/compose/environment-variables/

   Docker run cli command:

   docker run -d -t -i -e SF_PROJECT_NAME='<Project name>' \  -e SF_APP_NAME='<SF_APP_NAME>' \ -e SF_PROFILE_KEY='<snappyflow profile key>' \ --name <container_name>  <dockerhub_id/image_name> 

4. Once your server is up and running you can check trace in Snappyflow Server.

   // Project related info

   For viewing trace in Snappyflow server make sure project and app name is created or discovered with project name and app name specified in point no.2

   Once project and app name is created go to

   View dashboard -> Click on Tracing on lef side bar -> Click on view transaction -> Go to real time tab

5. For complete code refer sample app refer at:

   https://github.com/snappyflow/tracing-reference-apps/tree/master/refapp-express

Node.JS Sails

1. Install nodejs dependencies and save it in package.json using

   RUN npm install --save elastic-apm-node@^3.20.0 RUN npm install --save sf-apm-lib@^1.0.2 

   or update package.json file with following entries:

   "elastic-apm-node": "^3.20.0" "sf-apm-lib": "^1.0.2" 

   And run ‘npm install’ to install dependencies

2. Add initilization code at start of the file in globals.js present in config folder.

   1. Get Snappyflow trace config using

      const Snappyflow = require('sf-apm-lib'); var sfObj = new Snappyflow(); // Initialize Snappyflow. By default intialization will take profileKey, projectName and appName from sfagent config.yaml.
      // Add below part to manually configure the initialization let projectName = process.env.SF_PROJECT_NAME; let appName = process.env.SF_APP_NAME; let profileKey = process.env.SF_PROFILE_KEY; sfObj.init(profileKey, projectName, appName); // Manual override
      let sfTraceConfig = sfObj.getTraceConfig(); 

   2. Initialize apm object using

      var apm; try {    apm = require('elastic-apm-node').start({       serviceName: '<SERVICE_NAME>', // Specify your service name for tracing       serverUrl: sfTraceConfig['SFTRACE_SERVER_URL'],       globalLabels: sfTraceConfig['SFTRACE_GLOBAL_LABELS'],       verifyServerCert: sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'] === undefined ? false : sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'],       active: sfTraceConfig['SFTRACE_SERVER_URL'] === undefined ? false : true,       stackTraceLimit: sfTraceConfig['SFTRACE_STACK_TRACE_LIMIT'],       captureSpanStackTraces: sfTraceConfig['SFTRACE_CAPTURE_SPAN_STACK_TRACES']    }) } catch (e) {    console.log(e); } 

   3. Attach apm object to globals – This is required so we can use apm variable in other files as part of global sails object.

      module.exports.globals = {    _: require('@sailshq/lodash'),    async: false,    models: true,    sails: true,    apm : apm,    logger: logger }; 

   4. Also add middleware in http.js file present in config folder. Which allows to instrument our code.

      module.exports.http = {    middleware: {       order: [          'elasticAPM'       ],       elasticAPM: (function () {           return function (err, req, res, next) {          apm.middleware.connect();          if (typeof err !== 'undefined')             apm.captureError(err);          return next();          };       })()    } }; 

3. Provide SF_PROJECT_NAME, SF_APP_NAME, SF_PROFILE_KEY as an environment variables in docker-compose.yml or docker stack deployment file or at command line when using docker run command for deployment.

   Eg:

   Docker-compose and stack: https://docs.docker.com/compose/environment-variables/

   Docker run cli command:

   docker run -d -t -i -e SF_PROJECT_NAME='<SF_PROJECT_NAME>' \  -e SF_APP_NAME='<SF_APP_NAME>' \ -e SF_PROFILE_KEY='<snappyflow profile key>' \ --name <container_name>  <dockerhub_id/image_name> 

4. Once your server is up and running you can check trace in Snappyflow Server.

   For viewing trace in snappyflow server make sure project and app name is created or discovered with project name and app name specified in point no.2

   Once project and app name is created go to

   View dashboard -> Click on Tracing on lef side bar -> Click on view transaction -> Go to real time tab

5. For complete code refer sample app refer at:

   https://github.com/snappyflow/tracing-reference-apps/tree/master/RefappNodeSail

ECS

Node.JS Express

1. Install nodejs dependencies and save it in package.json using

   npm install --save elastic-apm-node@^3.20.0 npm install --save sf-apm-lib@^1.0.2 

   or update package.json file with following entries

   "elastic-apm-node": "^3.20.0" "sf-apm-lib": "^1.0.2" 

   And run ‘npm install’ to install dependencies

2. Add initilization code at start of the file in app.js

   1. Get Snappyflow trace config using:

      const Snappyflow = require('sf-apm-lib'); var sfObj = new Snappyflow(); // Initialize Snappyflow. By default intialization will take profileKey, projectName and appName from sfagent config.yaml.
      // Add below part to manually configure the initialization let projectName = process.env.SF_PROJECT_NAME; let appName = process.env.SF_APP_NAME; let profileKey = process.env.SF_PROFILE_KEY; sfObj.init(profileKey, projectName, appName); // Manual override
      let sfTraceConfig = sfObj.getTraceConfig(); 

   2. Initialize apm object using

      var apm; try {    apm = require('elastic-apm-node').start({       serviceName: '<SERVICE_NAME>', // Specify your service name for tracing       serverUrl: sfTraceConfig['SFTRACE_SERVER_URL'],       globalLabels: sfTraceConfig['SFTRACE_GLOBAL_LABELS'],       verifyServerCert: sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'] === undefined ? false : sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'],       active: sfTraceConfig['SFTRACE_SERVER_URL'] === undefined ? false : true,       stackTraceLimit: sfTraceConfig['SFTRACE_STACK_TRACE_LIMIT'],       captureSpanStackTraces: sfTraceConfig['SFTRACE_CAPTURE_SPAN_STACK_TRACES']    }) } catch (e) {    console.log(e); } 

3. Provide SF_PROJECT_NAME, SF_APP_NAME, SF_PROFILE_KEY as an environment variables in add container section of task definitions.

   https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html

4. Once your server is up and running you can check trace in Snappyflow Server.

   For viewing trace in Snappyflow server make sure project and app name is created or discovered with project name and app name specified in point no.2

   Once project and app name is created go to: View dashboard -> Click on Tracing on left side bar -> Click on view transaction -> Go to real time tab

5. For complete code refer sample app refer at:

   https://github.com/snappyflow/tracing-reference-apps/tree/master/refapp-express

Node.JS Sails

1. Install nodejs dependencies and save it in package.json using

   npm install --save elastic-apm-node@^3.20.0  npm install --save sf-apm-lib@^1.0.2 

   or update package.json file with following entries

   "elastic-apm-node": "^3.20.0" "sf-apm-lib": "^1.0.2" 

   And run ‘npm install’ to install dependencies

2. Add initilization code at start of the file in globals.js present in config folder.

   1. Get Snappyflow trace config using

      const Snappyflow = require('sf-apm-lib'); var sfObj = new Snappyflow(); // Initialize Snappyflow. By default intialization will take profileKey, projectName and appName from sfagent config.yaml.
      // Add below part to manually configure the initialization let projectName = process.env.SF_PROJECT_NAME; let appName = process.env.SF_APP_NAME; let profileKey = process.env.SF_PROFILE_KEY; sfObj.init(profileKey, projectName, appName); // Manual override
      let sfTraceConfig = sfObj.getTraceConfig(); 

   2. Initialize apm object using

      var apm; try {    apm = require('elastic-apm-node').start({       serviceName: '<SERVICE_NAME>', // Specify your service name for tracing       serverUrl: sfTraceConfig['SFTRACE_SERVER_URL'],       globalLabels: sfTraceConfig['SFTRACE_GLOBAL_LABELS'],       verifyServerCert: sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'] === undefined ? false : sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'],       active: sfTraceConfig['SFTRACE_SERVER_URL'] === undefined ? false : true,       stackTraceLimit: sfTraceConfig['SFTRACE_STACK_TRACE_LIMIT'],       captureSpanStackTraces: sfTraceConfig['SFTRACE_CAPTURE_SPAN_STACK_TRACES']    }) } catch (e) {    console.log(e); } 

   3. Attach apm object to globals – This is required so we can use apm variable in other files as part of global sails object

      module.exports.globals = {    _: require('@sailshq/lodash'),    async: false,    models: true,    sails: true,    apm : apm,    logger: logger }; 

   4. Also add middleware in http.js file present in config folder. Which allows to instrument our code

      module.exports.http = {    middleware: {       order: [          'elasticAPM'       ],       elasticAPM: (function () {          return function (err, req, res, next) {             apm.middleware.connect();             if (typeof err !== 'undefined')                apm.captureError(err);             return next();          };       })()    } }; 

3. Provide SF_PROJECT_NAME, SF_APP_NAME, SF_PROFILE_KEY as an environment variables in add container section of task definitions.

   https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html

4. Once your server is up and running you can check trace in Snappyflow Server.

   For viewing trace in snappyflow server make sure project and app name is created or discovered with project name and app name specified in point no.2

   Once project and app name is created go to

   View dashboard -> Click on Tracing on lef side bar -> Click on view transaction -> Go to real time tab

5. For complete code refer sample app refer at:

   https://github.com/snappyflow/tracing-reference-apps/tree/master/RefappNodeSail

AWS Lambda

1. Install dependency libraries in the node_modules directory using the npm install command

   npm install sf-apm-lib@^1.0.2 npm install elastic-apm-node@^3.20.0 

   Ref: https://docs.aws.amazon.com/lambda/latest/dg/nodejs-package.html

2. Instrument lambda function to enable tracing

   1. Add code outside lambda handler method to get tracing config and create trace client

      // SnappyFlow Tracing config const Snappyflow = require('sf-apm-lib');
      let projectName = process.env.SF_PROJECT_NAME; let appName = process.env.SF_APP_NAME; let profileKey = process.env.SF_PROFILE_KEY; 
      var sfObj = new Snappyflow(); sfObj.init(profileKey, projectName, appName); 
      var apm; try {    var sfTraceConfig = sfObj.getTraceConfig();    apm = require('elastic-apm-node').start({       serviceName: '<SERVICE_NAME_CHANGEME>',       serverUrl: sfTraceConfig['SFTRACE_SERVER_URL'],       globalLabels: sfTraceConfig['SFTRACE_GLOBAL_LABELS'],       verifyServerCert: sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'] === undefined ? false : sfTraceConfig['SFTRACE_VERIFY_SERVER_CERT'],       active: sfTraceConfig['SFTRACE_SERVER_URL'] === undefined ? false : true,       stackTraceLimit: sfTraceConfig['SFTRACE_STACK_TRACE_LIMIT'],       captureSpanStackTraces: sfTraceConfig['SFTRACE_CAPTURE_SPAN_STACK_TRACES'],       captureBody: 'all'   }) } catch (e) {    console.log(e) } 

   2. Add custom instrumentation inside lambda handler method

      Ref: https://www.elastic.co/guide/en/apm/agent/nodejs/current/custom-transactions.html

      https://www.elastic.co/guide/en/apm/agent/nodejs/current/custom-spans.html

      // Create custom transaction var trans = apm.startTransaction('lambda handler', 'lambda');  //Create custom span is needed var span = apm.startSpan('parse json'); // your CODE here // End of span if (span) span.end() //Some more code part of the transaction or add more spans here. Don’t RETURN/EXIT  //end custom transaction trans.result = 'success'; trans.end();     // RETURN code 

   3. Deploy the lambda app. Follow README to test sample app

      Reference app:

      https://github.com/upendrasahu/aws-lambda-nodejs-tracing-sample

   4. Configure Lambda function before trigger/invoke.

      1. Add the environment variable SF_PROFILE_KEY and set the value to your profile key copied from SnappyFlow.

      2. Add environment variables SF_APP_NAME and SF_PROJECT_NAME with appropriate values. Create this Project and Application in SnappyFlow if not already present.

         

   5. At this point you can trigger lambda function and get tracing data in SnappyFlow.