@tryghost/metrics 0.1.3 → 0.2.2

package/lib/GhostMetrics.js

@@ -8,19 +8,26 @@ class GhostMetrics {
     /**
      * Properties in the options bag:
      * 
-     * domain:           Metadata for metrics in shared databases.
-     * mode:             Is used to print short or long log - used for stdout shipper.
-     * metricTransports: An array of transports for metric shipping (e.g. ['stdout', 'elasticsearch'])
-     * elasticsearch:    Elasticsearch transport configuration
+     * domain:             Metadata for metrics in shared databases.
+     * mode:               Is used to print short or long log - used for stdout shipper.
+     * metrics.transports: An array of transports for metric shipping (e.g. ['stdout', 'elasticsearch'])
+     * metrics.metadata:   A property bag of metadata values to be shipped alongside the metric value
+     * elasticsearch:      Elasticsearch transport configuration
      * @param {object} options Bag of options
      */
     constructor(options) {
         options = options || {};
 
         this.domain = options.domain || 'localhost';
-        this.transports = options.metricTransports || [];
         this.elasticsearch = options.elasticsearch || {};
         this.mode = process.env.MODE || options.mode || 'short';
+        if ('metrics' in options && typeof options.metrics === 'object') {
+            this.transports = options.metrics.transports || [];
+            this.metadata = options.metrics.metadata || {};
+        } else {
+            this.transports = [];
+            this.metadata = {};
+        }
 
         // CASE: special env variable to enable long mode and level info
         if (process.env.LOIN) {
@@ -60,6 +67,8 @@ class GhostMetrics {
 
     /**
      * @description Setup ElasticSearch metric shipper
+     * ElasticSearch metrics are shipped to an index individually for each metric.
+     * The name of the index is the name of the metric prefixed with "metrics-", the metric name itself should be sluggified
      */
     setupElasticsearchShipper() {
         const ElasticSearch = require('@tryghost/elasticsearch');
@@ -77,9 +86,12 @@ class GhostMetrics {
                 value = {value};
             }
 
-            value.domain = this.domain;
+            value['@timestamp'] = Date.now();
+            if (this.metadata) {
+                value.metadata = this.metadata;
+            }
 
-            elasticSearch.index(value, name);
+            elasticSearch.index(value, `metrics-${name}`);
         };
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/metrics",
-  "version": "0.1.3",
+  "version": "0.2.2",
   "repository": "https://github.com/TryGhost/framework/tree/main/packages/metrics",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -26,7 +26,9 @@
     "sinon": "11.1.2"
   },
   "dependencies": {
-    "@tryghost/pretty-stream": "^0.1.1"
+    "@tryghost/elasticsearch": "^0.1.2",
+    "@tryghost/pretty-stream": "^0.1.1",
+    "@tryghost/root-utils": "^0.3.6"
   },
-  "gitHead": "90fab655c5bb4f16dd5604fc65be0ae599021e10"
+  "gitHead": "4d1564df4c15a78be73c9473c6ac64a9f57c0fe8"
 }