Merge branch 'master' into trentm/metrics-actually-disabled

Author: trentm

examples/README.md

@@ -0,0 +1,2 @@
+This directory holds example programs demonstrating the use of the Elastic
+Node.js APM agent (`elastic-apm-node`).

examples/trace-memcached.js

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+
+// A small example showing Elastic APM tracing of a script using `memcached`.
+//
+// By default this will use a Memcached on localhost. You can use:
+//    npm run docker:start
+// to start a Memcached container (and other containers used for testing of
+// this project).
+
+const apm = require('../').start({ // elastic-apm-node
+  serviceName: 'example-trace-memcached'
+})
+
+const Memcached = require('memcached')
+
+const HOST = process.env.MEMCACHED_HOST || '127.0.0.1'
+const PORT = 11211
+const client = new Memcached(`${HOST}:${PORT}`, { timeout: 500 })
+
+// For tracing spans to be created, there must be an active transaction.
+// Typically, a transaction is automatically started for incoming HTTP
+// requests to a Node.js server. However, because this script is not running
+// an HTTP server, we manually start a transaction. More details at:
+// https://www.elastic.co/guide/en/apm/agent/nodejs/current/custom-transactions.html
+apm.startTransaction('t0')
+
+client.version(function (err, data) {
+  console.log('Version: data=%j (err=%s)', data, err)
+
+  client.set('foo', 'bar', 10, function (err) {
+    console.log('Set: foo (err=%s)', err)
+
+    client.get('foo', function (err, data) {
+      console.log('Get foo: %s (err=%s)', data, err)
+
+      client.get('foo', function (err, data) {
+        console.log('Get foo (again): %s (err=%s)', data, err)
+
+        apm.endTransaction()
+        client.end()
+      })
+    })
+  })
+})

examples/trace-mysql.js

@@ -0,0 +1,57 @@
+#!/usr/bin/env node --unhandled-rejections=strict
+
+// A small example showing Elastic APM tracing of a script using `mysql`.
+//
+// By default this will use a MySQL on localhost with user 'root'. You can use:
+//    npm run docker:start
+// to start a MySQL container (and other containers used for testing of
+// this project).
+
+const apm = require('../').start({ // elastic-apm-node
+  serviceName: 'example-trace-mysql'
+})
+
+const mysql = require('mysql')
+
+const client = mysql.createConnection({
+  user: process.env.MYSQL_USER || 'root'
+})
+client.connect(function (err) {
+  console.warn('Connected (err=%s)', err)
+})
+
+// 1. Callback style
+// For tracing spans to be created, there must be an active transaction.
+// Typically, a transaction is automatically started for incoming HTTP
+// requests to a Node.js server. However, because this script is not running
+// an HTTP server, we manually start a transaction. More details at:
+// https://www.elastic.co/guide/en/apm/agent/nodejs/current/custom-transactions.html
+apm.startTransaction('t1')
+client.query('SELECT 1 + 1 AS solution', (err, res) => {
+  if (err) {
+    console.log('[t1] Failure: err is', err)
+  } else {
+    console.log('[t1] Success: solution is %s', res[0].solution)
+  }
+  apm.endTransaction()
+})
+
+// 2. Event emitter style
+const t2 = apm.startTransaction('t2')
+const q = client.query('SELECT 1 + 1 AS solution')
+q.on('error', function (err) {
+  console.log('[t2] Failure: err is', err)
+})
+q.on('result', function (row) {
+  console.log('[t2] solution is', row.solution)
+})
+q.on('end', function () {
+  console.log('[t2] End')
+  t2.end()
+})
+
+// Lazily shutdown client after everything above is finished.
+setTimeout(() => {
+  console.log('Done')
+  client.end()
+}, 1000)

examples/trace-pg.js

@@ -0,0 +1,73 @@
+#!/usr/bin/env node --unhandled-rejections=strict
+// A small example showing Elastic APM tracing of a script using `pg`.
+//
+// By default this will use a Postgres on localhost with user 'postgres'.
+// You can use:
+//    npm run docker:start
+// to start a Postgres container (and other containers used for testing of
+// this project).
+
+const apm = require('../').start({ // elastic-apm-node
+  serviceName: 'example-trace-pg'
+})
+
+const { Client, Query } = require('pg')
+
+const client = new Client({
+  user: process.env.PGUSER || 'postgres'
+})
+client.connect(function (err) {
+  console.warn('Connected (err=%s)', err)
+})
+
+// 1. Callback style
+// For tracing spans to be created, there must be an active transaction.
+// Typically, a transaction is automatically started for incoming HTTP
+// requests to a Node.js server. However, because this script is not running
+// an HTTP server, we manually start a transaction. More details at:
+// https://www.elastic.co/guide/en/apm/agent/nodejs/current/custom-transactions.html
+apm.startTransaction('t1')
+client.query('SELECT $1::text as message', ['Hello world!'], (err, res) => {
+  if (err) {
+    console.log('[t1] Failure: err is', err)
+  } else {
+    console.log('[t1] Success: message is %s', res.rows[0].message)
+  }
+  apm.endTransaction()
+})
+
+// 2. Using streaming style, i.e. using a `Submittable` as node-postgres calls it.
+const t2 = apm.startTransaction('t2')
+var q = client.query(new Query('select 1 + 1 as solution'))
+q.on('error', (err) => {
+  console.log('[t2] Failure: err is', err)
+  t2.end()
+})
+q.on('row', (row) => {
+  console.log('[t2] solution is %s', row.solution)
+})
+q.on('end', () => {
+  console.log('[t2] Success')
+  t2.end()
+})
+
+// 3. Promise style
+apm.startTransaction('t3')
+client.query('select 1 + 1 as solution')
+  .then(function (result) {
+    console.log('[t3] Success: solution is %s', result.rows[0].solution)
+  })
+  .catch(function (err) {
+    console.log('[t3] Failure: err is', err)
+  })
+  .finally(function () {
+    apm.endTransaction()
+  })
+
+// TODO: 4. async/await style
+
+// Lazily shutdown client after everything above is finished.
+setTimeout(() => {
+  console.log('Done')
+  client.end()
+}, 1000)