com.loadcoder.result.clients.GrafanaClient Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (C) 2018 Stefan Vahlgren at Loadcoder
 * 
 * This file is part of Loadcoder.
 * 
 * Loadcoder is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * Loadcoder is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 ******************************************************************************/
package com.loadcoder.result.clients;

import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.loadcoder.result.Result;

/**
 * This is an incredibly simlpe Grafana client build just upon java's net
 * package
 */
public class GrafanaClient extends HttpClient {

	private Logger log = LoggerFactory.getLogger(GrafanaClient.class);

	protected static final String GRAFANA_DASHBOARD_TIMESPAN_DATETIMEFORMAT = "yyyy-MM-dd'T'HH:mm:ss.000";
	protected static final SimpleDateFormat TIMESPAN_FORMAT = new SimpleDateFormat(
			GRAFANA_DASHBOARD_TIMESPAN_DATETIMEFORMAT);
	private final String DB_URL_TEMPLATE = "%s://%s:%s/api/dashboards/db";
	private final String DB_URL;

	private static final long TIMESPAN_MILLIS_PRECREATED_DASHBOARD = 50_000;

	private final String authorizationValue;

	/**
	 * Constructor for the GrafanaClient
	 * 
	 * @param host is the hostname of where Grafana is hosted
	 * @param port is the port where Grafana exposes is API
	 * @param https is boolean if the communcation is encrypted or not. 
	 * @param authorizationValue the value for the HTTP header Authorization used in the request towards
	 * Grafana in order to authenticate the client
	 */
	public GrafanaClient(String host, int port, boolean https, String authorizationValue) {
		String protocol = protocolAsString(https);
		DB_URL = String.format(DB_URL_TEMPLATE, protocol, host, port);
		this.authorizationValue = authorizationValue;
	}

	private static class Type {
		String type;
		String refId;

		private Type(String type, String refId) {
			this.type = type;
			this.refId = refId;
		}
	}

	private List types = Arrays.asList(new Type("mean", "A"));

	private String getFileAsString(String filename) {
		InputStream in = getClass().getResourceAsStream("/" + filename);
		BufferedReader reader = new BufferedReader(new InputStreamReader(in));

		List fileAsLineList = new ArrayList();
		reader.lines().forEach(line -> fileAsLineList.add(line));
		try {
			String fileAsString = "";
			for (String line : fileAsLineList) {
				fileAsString = fileAsString + line + "\n";
			}
			return fileAsString;
		} catch (Exception e) {
			throw new RuntimeException(e);
		}
	}

	private String getTargets(Set measurementNames, String executionId) {

		String targetTagTemplate = "";
		if (executionId != null) {
			targetTagTemplate = getFileAsString("grafana_5.2.4/grafana_target_tag_body_template.json");
			targetTagTemplate = targetTagTemplate.replace("${executionid}", executionId);

		}
		String targetTemplate = getFileAsString("grafana_5.2.4/grafana_target_body_template.json");

		targetTemplate = targetTemplate.replace("${tags}", targetTagTemplate);

		List targetsList = new ArrayList();
		for (String name : measurementNames) {
			for (Type t : types) {
				String target = targetTemplate.replace("${measurement_name}", name).replace("${refid}", t.refId)
						.replace("${select_type}", t.type);
				targetsList.add(target);
			}
		}
		String result = "";
		for (int i = 0; i < targetsList.size(); i++) {
			String delimiter = i == targetsList.size() - 1 ? "\n" : ",\n";
			result = result + targetsList.get(i) + delimiter;
		}
		return result;
	}

	private int createNewDashboardBase(long start, long end, String name, String executionId,
			Set transactionNamesSet, boolean refresh) {

		long usedEnd = (end - start) < TIMESPAN_MILLIS_PRECREATED_DASHBOARD
				? start + TIMESPAN_MILLIS_PRECREATED_DASHBOARD
				: end;
		String startTimespan = DateTimeUtil.convertMilliSecondsToFormattedDate(start, TIMESPAN_FORMAT);
		String endTimespan = DateTimeUtil.convertMilliSecondsToFormattedDate(usedEnd, TIMESPAN_FORMAT);

		log.debug("panel will have timespan: " + startTimespan + " - " + endTimespan);
		String dateTimeLabel = DateTimeUtil.convertMilliSecondsToFormattedDate(start);
		String fileAsString = getFileAsString("grafana_5.2.4/grafana_post_dashboard_body_template.json");

		fileAsString = fileAsString.replace("${time_from}", startTimespan);
		fileAsString = fileAsString.replace("${time_to}", endTimespan);
		fileAsString = fileAsString.replace("${title}", name + "_" + dateTimeLabel);

		fileAsString = fileAsString.replace("${refresh}", refresh ? "\"5s\"" : "false");

		String targets = getTargets(transactionNamesSet, executionId);
		fileAsString = fileAsString.replace("${targets}", targets);
		fileAsString = fileAsString.replace("${requestid}", "" + System.currentTimeMillis());

		List headers = Arrays.asList(new Header("Content-Type", "application/json"),
				new Header("Authorization", authorizationValue));
		return sendPost(fileAsString, DB_URL, headers);
	}

	
	/**
	 * Create a new Grafana Dashboard.
	 *  
	 * @param name is the name of the Dashboard
	 * @param transactionNames is a list of the transaction names
	 * @return the http status code for the Grafana request
	 */
	public int createNewDashboard(String name, List transactionNames) {

		Set transactionNamesSet = new HashSet();
		for (String transactionName : transactionNames) {
			transactionNamesSet.add(transactionName);
		}
		long now = System.currentTimeMillis();
		return createNewDashboardBase(now, now, name, null, transactionNamesSet, true);
	}

	/**
	 * Create a new Grafana Dashboard.
	 *  
	 * @param name is the name of the Dashboard
	 * @param executionId is the id for a specific set of results, for instance all results for
	 * a particular test execution
	 * @param transactionNames is a list of the transaction names
	 * @return the http status code for the Grafana request
	 */
	public int createNewDashboard(String name, String executionId, List transactionNames) {

		Set transactionNamesSet = new HashSet();
		for (String transactionName : transactionNames) {
			transactionNamesSet.add(transactionName);
		}
		long now = System.currentTimeMillis();
		return createNewDashboardBase(now, now, name, executionId, transactionNamesSet, true);
	}

	/**
	 * Create a new Grafana Dashboard.
	 * 
	 * @param name is the name of the Dashboard
	 * @param result is the Result of an already executed test
	 * @return the http status code for the Grafana request
	 */
	public int createNewDashboardFromResult(String name, Result result) {
		long now = System.currentTimeMillis();
		return createNewDashboardBase(result.getStart(), result.getEnd(), name, null, result.getResultLists().keySet(),
				false);
	}

	/**
	 * Create a new Grafana Dashboard.
	 * 
	 * @param name is the name of the Dashboard
	 * @param executionId is the id for a specific set of results, for instance all results for
	 * a particular test execution
	 * @param result is the Result of an already executed test
	 * @return the http status code for the Grafana request
	 */
	public int createNewDashboardFromResult(String name, String executionId, Result result) {
		return createNewDashboardBase(result.getStart(), result.getEnd(), name, executionId,
				result.getResultLists().keySet(), false);
	}
}