docs: update metrics plugin example (#1599)

restify · Feb 9, 2018 · 3071c23 · 3071c23
1 parent 35bd1c2
commit 3071c23
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/docs/_api/plugins.md b/docs/_api/plugins.md
@@ -1038,7 +1038,7 @@ Returns **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Ref
 ### metrics
 
 The module includes the following plugins to be used with restify's `after`
-event, e.g., `server.on('after', plugins.metrics());`:
+event, e.g., `server.on('after', restify.plugins.metrics());`:
 
 A plugin that listens to the server's after event and emits information
 about that request.
@@ -1052,8 +1052,9 @@ about that request.
 **Examples**
 
 ```javascript
-server.on('after', plugins.metrics(function onMetrics(err, metrics) {
-     // metrics is an object containing information about the request
+server.on('after', restify.plugins.metrics({ server: server },
+    function (err, metrics, req, res, route) {
+        // metrics is an object containing information about the request
 }));
 ```
 

diff --git a/lib/plugins/metrics.js b/lib/plugins/metrics.js
@@ -7,7 +7,7 @@ var hrTimeDurationInMs = require('./utils/hrTimeDurationInMs');
 
 /**
  * The module includes the following plugins to be used with restify's `after`
- * event, e.g., `server.on('after', plugins.metrics());`:
+ * event, e.g., `server.on('after', restify.plugins.metrics());`:
  *
  * A plugin that listens to the server's after event and emits information
  * about that request.
@@ -20,8 +20,9 @@ var hrTimeDurationInMs = require('./utils/hrTimeDurationInMs');
  * @returns {Function} returns a function suitable to be used
  *   with restify server's `after` event
  * @example
- * server.on('after', plugins.metrics(function onMetrics(err, metrics) {
- *      // metrics is an object containing information about the request
+ * server.on('after', restify.plugins.metrics({ server: server },
+ *     function (err, metrics, req, res, route) {
+ *         // metrics is an object containing information about the request
  * }));
  */
 function createMetrics(opts, callback) {