Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Elastic{ON} 2018: Instrumenting Node.js Apps wi...

Elastic{ON} 2018: Instrumenting Node.js Apps with Elastic APM

Identifying, debugging, and fixing Node.js production performance issues is difficult. Learn about Node.js instrumentation and how Elastic APM can help. See how to improve error monitoring and how to automatically instrument incoming HTTP requests, database queries, etc.

We'll also cover more advanced topics like how to minimize instrumentation overhead, how to add valuable metadata to the collected metrics to ease debugging, and how to add custom watchers to instrument any part of your codebase.

Thomas Watson

February 28, 2018
Tweet

More Decks by Thomas Watson

Other Decks in Programming

Transcript

  1. @wa7son Who am I? • Thomas Watson • Open Source

    developer at
 github.com/watson • Node.js Engineer at Elastic • Elastic APM Node.js agent • Member of the Diagnostics Working Group under the Node.js Foundation • Tweets as @wa7son
  2. @wa7son module.exports = { serviceName: 'my-node-app', secretToken: ‘secret!', serverUrl: 'https://example.com:8200',

    active: process.env.NODE_ENV === 'production' } require('elastic-apm-node').start()
  3. @wa7son Put the call to the “start” function at the

    very top of your main app file - before requiring any other modules
  4. @wa7son const path = require('path') const express = require('express') const

    afterAll = require('after-all-results') const db = require('./lib/db') const redis = require('./lib/redis') const accounting = require('./lib/accounting') const app = express() // etc...
  5. @wa7son const agent = require('elastic-apm-node').start({...}) const path = require('path') const

    express = require('express') const afterAll = require('after-all-results') const db = require('./lib/db') const redis = require('./lib/redis') const accounting = require('./lib/accounting') const app = express() // etc...
  6. @wa7son const conf = require(‘./lib/config') const agent = require('elastic-apm-node').start(conf.apm) const

    path = require('path') const express = require('express') const afterAll = require('after-all-results') const db = require('./lib/db') const redis = require('./lib/redis') const accounting = require('./lib/accounting') const app = express() // etc...
  7. @wa7son import conf from './server/config' import agent from 'elastic-apm-node' import

    path from 'path' import express from 'express' import afterAll from 'after-all-results' import db from './lib/db' import redis from './lib/redis' import accounting from './lib/accounting' agent.start(conf.apm) var app = express() // etc...
  8. @wa7son Custom Filters agent.addFilter((payload) => { if (payload.context.request && payload.context.request.headers)

    { // redact sensitive data payload.context.request.headers['x-secret'] = '[REDACTED]' } // remember to return the modified payload return payload })
  9. @wa7son const queue = require('./queue') queue.on('job', (job, cb) => {

    processJob(job, cb) }) const agent = require('elastic-apm-node').start()
  10. @wa7son const queue = require('./queue') queue.on('job', (job, cb) => {

    const name = 'Job ' + job.type const type = 'job' const trans = agent.startTransaction(name, type) processJob(job, cb) }) const agent = require('elastic-apm-node').start()
  11. @wa7son const queue = require('./queue') queue.on('job', (job, cb) => {

    const name = 'Job ' + job.type const type = 'job' const trans = agent.startTransaction(name, type) processJob(job, (err) => { if (err) trans.result = 'error' trans.end() cb(err) }) }) const agent = require('elastic-apm-node').start()
  12. @wa7son const queue = require('./queue') queue.on('job', (job, cb) => {

    const name = 'Job ' + job.type const type = 'job' const trans = agent.startTransaction(name, type) processJob(job, (err) => { if (err) trans.result = 'error' trans.end() cb(err) }) })
  13. @wa7son const queue = require('./queue') queue.on('job', (job, cb) => {

    const name = 'Job ' + job.type const type = 'job' const trans = agent.startTransaction(name, type) processJob(job, (err) => { if (err) { trans.result = 'error' agent.captureError(err) } trans.end() cb(err) }) })
  14. @wa7son In-memory Queue Config option Default Description flushInterval 10 How

    often the queue is flushed (in seconds) maxQueueSize -1 Max number of items in the queue before its flushed (unlimited: -1)
  15. @wa7son Source Code Context Config option Default Description sourceLinesErrorAppFrames 5

    Lines of source code to collect around in-app frames on error stack traces sourceLinesErrorLibraryFrames 5 Lines of source code to collect around library frames on error stack traces sourceLinesSpanAppFrames 0 Lines of source code to collect around in-app frames for spans sourceLinesSpanLibraryFrames 0 Lines of source code to collect around library frames for spans