Remove experimental flag for perIteration metric for Graphite. (#3069)

* Remove exprimental flag for perIteration metric for Graphite.

* more updates per iteration

docs/documentation/sitespeed.io/graphite/index.md

@@ -72,7 +72,7 @@ You can choose the namespace under where sitespeed.io will publish the metrics.
 
 Each URL is by default split into domain and the URL when we send it to Graphite. By default sitespeed.io remove query parameters from the URL bit if you need them you can change that by adding <code>--graphite.includeQueryParams</code>.
 
-If you want metrics from each iteration you can use <code>--graphite.experimental.perIteration</code>. Using this will give raw metrics that are not aggregated (min, max, median, mean). The structure for those metrics is experimental and can change.
+If you want metrics from each iteration you can use <code>--graphite.perIteration</code>. Using this will give raw metrics that are not aggregated (min, max, median, mean).
 
 If you use Graphite < 1.0 you need to make sure the tags in the annotations follow the old format, you do that by adding <code>--graphite.arrayTags</code>.
 

lib/plugins/graphite/cli.js

@@ -76,11 +76,11 @@ module.exports = {
     describe: 'Break up number of metrics to send with each request.',
     group: 'Graphite'
   },
-  'experimental.perIteration': {
+  perIteration: {
     default: false,
     type: 'boolean',
     describe:
-      'Experimental setup to send each iteration of metrics to Graphite. Experimental means this can change and is not released as stable. Use it with care.',
+      'Send each iteration of metrics to Graphite. By default we only send page summaries (the summaries of all runs) but you can also send all the runs. Make sure to setup statsd or Graphite correctly to handle it.',
     group: 'Graphite'
   }
 };

lib/plugins/graphite/data-generator.js

@@ -55,8 +55,7 @@ function keyPathFromMessage(message, options, includeQueryParams, alias) {
   // if we are sending run metrics and we have an iteration
   if (
     options.graphite &&
-    options.graphite.experimental &&
-    options.graphite.experimental.perIteration &&
+    options.graphite.perIteration &&
     message.type.endsWith('run') &&
     message.iteration
   ) {
@@ -87,11 +86,7 @@ class GraphiteDataGenerator {
     return reduce(
       flatten.flattenMessageData(message),
       (entries, value, key) => {
-        if (
-          this.options.graphite &&
-          this.options.graphite.experimental &&
-          this.options.graphite.experimental.perIteration
-        ) {
+        if (this.options.graphite && this.options.graphite.perIteration) {
           if (message.type === 'browsertime.run') {
             if (key.includes('timings') && key.includes('marks')) {
               key = key.replace(/marks\.(\d+)/, function(match, idx) {

lib/plugins/graphite/index.js

@@ -32,7 +32,7 @@ module.exports = {
     throwIfMissing(options.graphite, ['host'], 'graphite');
     const opts = merge({}, this.config, options.graphite);
     this.options = options;
-    this.perIteration = get(opts, 'experimental.perIteration', false);
+    this.perIteration = get(opts, 'perIteration', false);
     const SenderConstructor = isStatsd(opts) ? StatsDSender : GraphiteSender;
 
     this.filterRegistry = context.filterRegistry;

test/cliTests.js

@@ -148,9 +148,9 @@ describe('cli', () => {
         'Break up number of metrics to send with each request.'
       );
 
-      expect(stdout).to.contain('--graphite.experimental.perIteration');
+      expect(stdout).to.contain('--graphite.perIteration');
       expect(stdout).to.contain(
-        'Experimental setup to send each iteration of metrics to Graphite. Experimental means this can change and is not released as stable. Use it with care.'
+        'Send each iteration of metrics to Graphite. By default we only send page summaries (the summaries of all runs) but you can also send all the runs. Make sure to setup statsd or Graphite correctly to handle it.'
       );
     });