sitespeed.io/lib/plugins/graphite/send-annotation.js

105 lines
3.8 KiB
JavaScript

'use strict';
const http = require('http');
const https = require('https');
const log = require('intel').getLogger('sitespeedio.plugin.graphite');
const Promise = require('bluebird');
const graphiteUtil = require('../../support/tsdbUtil');
const util = require('../../support/util');
module.exports = {
send(options, group, url, resultPageUrl, screenshotPath, harPath, time) {
// The tags make it possible for the dashboard to use the
// templates to choose which annotations that will be showed.
// That's why we need to send tags that matches the template
// variables in Grafana.
const connectivity = graphiteUtil.getConnectivity(options);
const browser = options.browser;
const namespace = options.graphite.namespace.split('.');
const urlAndGroup = graphiteUtil
.getURLAndGroup(options, group, url, options.graphite.includeQueryParams)
.split('.');
const tags = [
connectivity,
browser,
namespace[0],
namespace[1],
urlAndGroup[0],
urlAndGroup[1]
];
const extraTags = util.toArray(options.graphite.annotationTag);
// We got some extra tag(s) from the user, let us add them to the annotation
if (extraTags.length > 0) {
tags.push(...extraTags);
}
let tagsString = `"`;
let tagsArray = '[';
for (let myTag of tags) {
tagsString += myTag + ',';
tagsArray += '"' + myTag + '",';
}
tagsString = tagsString.substring(0, tagsString.length - 1);
tagsArray = tagsArray.substring(0, tagsArray.length - 1);
tagsString += '"';
tagsArray += ']';
const s = options.browsertime.iterations > 1 ? 's' : '';
const screenshotSize = options.mobile ? 'height=200px' : 'width=100%';
let message =
screenshotPath &&
options.graphite &&
options.graphite.annotationScreenshot
? `<a href='${resultPageUrl}' target='_blank'><img src='${screenshotPath}' ${screenshotSize}></a><p><a href='${resultPageUrl}'>Result</a> - <a href='${harPath}'>Download HAR</a></p>`
: `<a href='${resultPageUrl}' target='_blank'>Result ${
options.browsertime.iterations
} run${s}</a>`;
if (options.graphite.annotationMessage) {
message += options.graphite.annotationMessage;
}
const timestamp = Math.round(time.valueOf() / 1000);
const theTags = options.graphite.arrayTags ? tagsArray : tagsString;
const postData = `{"what": "${
options.browsertime.iterations
} run${s}", "tags": ${theTags}, "data": "${message}", "when": ${timestamp}}`;
const postOptions = {
hostname: options.graphite.webHost || options.graphite.host,
port: options.graphite.httpPort || 8080,
path: '/events/',
method: 'POST',
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
'Content-Length': Buffer.byteLength(postData)
}
};
// If Graphite is behind auth, use it!
if (options.graphite.auth) {
postOptions.auth = options.graphite.auth;
}
return new Promise((resolve, reject) => {
log.verbose('Send annotation to Graphite: %j', postData);
// not perfect but maybe work for us
const lib = options.graphite.httpPort === 443 ? https : http;
const req = lib.request(postOptions, res => {
if (res.statusCode !== 200) {
const e = new Error(
`Got ${res.statusCode} from Graphite when sending annotation`
);
log.warn(e.message);
reject(e);
} else {
res.setEncoding('utf8');
log.debug('Sent annotation to Graphite');
resolve();
}
});
req.on('error', err => {
log.error('Got error from Graphite when sending annotation', err);
reject(err);
});
req.write(postData);
req.end();
});
}
};