@gasket/plugin-elastic-apm 7.0.0-next.68 → 7.0.0-next.69

package/README.md

@@ -114,6 +114,35 @@ According to the [Elastic APM docs], the _Elastic APM agent for Node.js is a
 singleton_. This means that you can require and configure singleton in various
 hooks of your Gasket app, such as with the [init] or [middleware] lifecycles.
 
+## Actions
+
+### getApmTransaction
+
+Use the `getApmTransaction` action to access and decorate the current APM
+transaction. This action is available in any lifecycle hook or server-side code.
+
+```js
+// example-plugin.js
+
+export default {
+  name: 'example-plugin',
+  hooks: {
+    express(gasket, app) {
+      app.use(async (req, res, next) => {
+        const transaction = await gasket.actions.getApmTransaction(req);
+        const locale = await gasket.actions.getIntlLocale(req);
+        transaction.setLabel('locale', locale);
+      });
+    }
+  }
+}
+```
+
+In the above example, we are hooking the express lifecycle to add middleware
+to decorate the transaction.
+Calling `getApmTransaction` will also allow other plugins to decorate the
+transaction by hooking the `apmTransaction` lifecycle discussed next.
+
 ## Lifecycles
 
 ### apmTransaction
@@ -142,11 +171,8 @@ export default {
 
 ## How it works
 
-This plugin hooks the Gasket [preboot] lifecycle from [@gasket/plugin-start] and
-will set up additional filtering, such as for sensitive cookies. If the
-`preboot` hook finds that the APM agent has not yet been started using the
-recommended `--require elastic-apm-node/start`, it will start it here. However,
-you risk not bootstrapping necessary modules with a late start.
+This plugin hooks the Gasket [configure] lifecycle to set additional filtering,
+such as for sensitive cookies.
 
 ## License
 

package/lib/index.js

@@ -3,7 +3,6 @@
 
 const actions = require('./actions');
 const create = require('./create');
-const middleware = require('./middleware');
 const configure = require('./configure');
 const {
   name,
@@ -20,7 +19,6 @@ const plugin = {
   hooks: {
     configure,
     create,
-    middleware,
     metadata(gasket, meta) {
       return {
         ...meta,
@@ -28,7 +26,7 @@ const plugin = {
           {
             name: 'getApmTransaction',
             description: 'Get the APM transaction data',
-            link: 'README.md'
+            link: 'README.md#getApmTransaction'
           }
         ],
         configurations: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gasket/plugin-elastic-apm",
-  "version": "7.0.0-next.68",
+  "version": "7.0.0-next.69",
   "description": "Adds Elastic APM instrumentation to your application",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -31,16 +31,13 @@
     "plugin"
   ],
   "author": "GoDaddy Operating Company, LLC",
-  "maintainers": [
-    "Keith Bartholomew <kbartholomew@godaddy.com>"
-  ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/godaddy/gasket/issues"
   },
   "homepage": "https://github.com/godaddy/gasket/tree/main/packages/gasket-plugin-elastic-apm",
   "devDependencies": {
-    "@gasket/core": "7.0.0-next.68",
+    "@gasket/core": "7.0.0-next.69",
     "dotenv": "^16.4.5",
     "elastic-apm-node": "^4.4.1",
     "eslint": "^8.56.0",
@@ -69,5 +66,5 @@
   "jest": {
     "testEnvironment": "node"
   },
-  "gitHead": "13b1cf962202f9d7212412d337cbfcd38cd92c2a"
+  "gitHead": "b5645f2b3cc18080304c9dbdfeadf6d0005e3893"
 }

package/lib/middleware.js

@@ -1,41 +0,0 @@
-/// <reference types="@gasket/plugin-express" />
-
-/**
- * Middleware for customizing transactions
- * @param {import('@gasket/core').Gasket} gasket - The Gasket engine
- * @param {import('http').IncomingMessage} req - The HTTP request being handled
- */
-async function customizeTransaction(gasket, req) {
-  const apm = require('elastic-apm-node');
-  if (!apm?.isStarted()) {
-    return;
-  }
-
-  const transaction = apm.currentTransaction;
-  if (!transaction) {
-    return;
-  }
-
-  await gasket.exec('apmTransaction', transaction, { req });
-}
-
-/**
- * Add middleware to gather config details
- * @type {import('@gasket/core').HookHandler<'middleware'>}
- */
-module.exports = function middleware(gasket) {
-  const apm = require('elastic-apm-node');
-  // eslint-disable-next-line no-undefined
-  const isStarted = apm.isStarted() || undefined;
-  return (
-    isStarted &&
-    async function apmTransactionMiddleware(req, res, next) {
-      try {
-        customizeTransaction(gasket, req);
-      } catch (error) {
-        return next(error);
-      }
-      next();
-    }
-  );
-};