IntenseFinance/nosqlbench
3
0
Fork 0
mirror of https://github.com/nosqlbench/nosqlbench.git synced 2025-02-25 18:55:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

grafana client improvements

Browse Source
This commit is contained in:
Jonathan Shook 2020-12-09 16:26:12 -06:00
parent c83f4d87da
commit bb0884e21f
7 changed files with 159 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
engine-clients/src/main/java/io/nosqlbench/engine/clients/grafana/By.java
View File

@ -1,6 +1,7 @@
package io.nosqlbench.engine.clients.grafana;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
public class By {
@ -57,8 +58,11 @@ public class By {
return new By("type", "alert");
}
public static By tags(String tag) {
return new By("tags", tag);
/**
* Add one tag at a time, in either "tag" or "tag:value" form.
*/
public static By tag(String tag) {
return new By("tag", tag);
}
public static By id(int id) {
@ -69,11 +73,12 @@ public class By {
List<String> tags = new ArrayList<>();
StringBuilder sb = new StringBuilder();
for (By by : bys) {
if (by.key.equals("tags")) {
tags.add(by.value.toString());
if (by.key.equals("tag")) {
tags.addAll(Arrays.asList(by.value.toString().split(",")));
} else {
sb.append(by.key).append("=").append(by.value);
sb.append("&");
}
sb.append(by.key).append("=").append(by.value);
sb.append("&");
}
for (String tag : tags) {
sb.append("tags=").append(tag).append("&");

73
engine-clients/src/main/java/io/nosqlbench/engine/clients/grafana/GrafanaClient.java
View File

@ -2,13 +2,19 @@ package io.nosqlbench.engine.clients.grafana;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import io.nosqlbench.engine.clients.grafana.transfer.GrafanaAnnotation;
import io.nosqlbench.engine.clients.grafana.transfer.Annotations;
import io.nosqlbench.engine.clients.grafana.transfer.ApiTokenRequest;
import io.nosqlbench.engine.clients.grafana.transfer.DashboardResponse;
import io.nosqlbench.engine.clients.grafana.transfer.GrafanaAnnotation;
import java.io.File;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.attribute.PosixFilePermissions;
import java.util.function.Supplier;
/**
* @see <a href="https://grafana.com/docs/grafana/latest/http_api/annotations/">Grafana Annotations API Docs</a>
@ -179,6 +185,27 @@ public class GrafanaClient {
return savedGrafanaAnnotation;
}
public DashboardResponse getDashboardByUid(String uid) {
HttpClient client = config.newClient();
HttpRequest.Builder rqb = config.newRequest("api/dashboards/uid/" + uid);
rqb = rqb.GET();
HttpResponse<String> response = null;
try {
response = client.send(rqb.build(), HttpResponse.BodyHandlers.ofString());
} catch (Exception e) {
throw new RuntimeException(e);
}
if (response.statusCode() < 200 || response.statusCode() >= 300) {
throw new RuntimeException("Getting dashboard by uid (" + uid + ") failed with status code " + response.statusCode() +
" at baseuri " + config.getBaseUri() + ": " + response.body());
}
String body = response.body();
DashboardResponse dashboardResponse = gson.fromJson(body, DashboardResponse.class);
return dashboardResponse;
}
/**
* <pre>{@code
* POST /api/annotations/graphite
@ -302,13 +329,52 @@ public class GrafanaClient {
throw new RuntimeException("unimplemented");
}
/**
* This can be called to create an api token and store it for later use as long as you
* have the admin credentials for basic auth. This is preferred to continuing to
* passing basic auth for admin privileges. The permissions can now be narrowed or managed
* in a modular way.
*
* @param namer the principal name for the privelege
* @param role the Grafana role
* @param ttl Length of validity for the granted api token
* @param keyfilePath The path of the token. If it is present it will simply be used.
* @param un The basic auth username for the Admin role
* @param pw The basic auth password for the Admin role
*/
public void cacheApiToken(Supplier<String> namer, String role, long ttl, Path keyfilePath, String un, String pw) {
if (!Files.exists(keyfilePath)) {
GrafanaClientConfig basicClientConfig = config.copy();
basicClientConfig = basicClientConfig.basicAuth(un, pw);
GrafanaClient apiClient = new GrafanaClient(basicClientConfig);
String keyName = namer.get();
ApiToken apiToken = apiClient.createApiToken(keyName, role, ttl);
try {
if (keyfilePath.toString().contains(File.separator)) {
Files.createDirectories(keyfilePath.getParent(),
PosixFilePermissions.asFileAttribute(PosixFilePermissions.fromString("rwxrwx---")));
}
Files.writeString(keyfilePath, apiToken.getKey());
} catch (Exception e) {
throw new RuntimeException(e);
}
}
GrafanaMetricsAnnotator.AuthWrapper authHeaderSupplier = new GrafanaMetricsAnnotator.AuthWrapper(
"Authorization",
new GrafanaKeyFileReader(keyfilePath),
s -> "Bearer " + s
);
config.addHeaderSource(authHeaderSupplier);
}
public ApiToken createApiToken(String name, String role, long ttl) {
ApiTokenRequest r = new ApiTokenRequest(name, role, ttl);
ApiToken token = postToGrafana(r, ApiToken.class, "gen api token");
ApiToken token = postApiTokenRequest(r, ApiToken.class, "gen api token");
return token;
}
private <T> T postToGrafana(Object request, Class<? extends T> clazz, String desc) {
private <T> T postApiTokenRequest(Object request, Class<? extends T> clazz, String desc) {
HttpRequest rq = config.newJsonPOST("api/auth/keys", request);
HttpClient client = config.newClient();
@ -331,4 +397,5 @@ public class GrafanaClient {
T result = gson.fromJson(body, clazz);
return result;
}
}

28
engine-clients/src/main/java/io/nosqlbench/engine/clients/grafana/transfer/Dashboard.java Normal file
View File

@ -0,0 +1,28 @@
package io.nosqlbench.engine.clients.grafana.transfer;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class Dashboard {
Map<String, Object> annotations = new HashMap<>();
String description;
boolean editable;
long graphToolTip;
long id;
long iteration;
List<Object> links;
List<PanelDef> panels;
String refresh;
long schemaVersion;
String style;
List<Object> tags;
Map<String, Object> templating;
Map<String, Object> time;
Map<String, List<String>> timepicker;
String timezone;
String title;
String uid;
long version;
}

8
engine-clients/src/main/java/io/nosqlbench/engine/clients/grafana/transfer/DashboardAnnotations.java Normal file
View File

@ -0,0 +1,8 @@
package io.nosqlbench.engine.clients.grafana.transfer;
import java.util.List;
import java.util.Map;
public class DashboardAnnotations {
List<Map<String, Object>> list;
}

9
engine-clients/src/main/java/io/nosqlbench/engine/clients/grafana/transfer/DashboardResponse.java Normal file
View File

@ -0,0 +1,9 @@
package io.nosqlbench.engine.clients.grafana.transfer;
import java.util.HashMap;
import java.util.Map;
public class DashboardResponse {
Map<String, String> meta = new HashMap<>();
Dashboard dashboard;
}

9
engine-clients/src/main/java/io/nosqlbench/engine/clients/grafana/transfer/GrafanaAnnotation.java
View File

@ -171,4 +171,13 @@ public class GrafanaAnnotation {
", data=" + data +
'}';
}
public LinkedHashMap<String, String> getTagMap() {
LinkedHashMap<String, String> map = new LinkedHashMap<>();
for (String tag : this.getTags()) {
String[] split = tag.split(":", 2);
map.put(split[0], (split.length == 2 ? split[1] : null));
}
return map;
}
}

24
engine-clients/src/main/java/io/nosqlbench/engine/clients/grafana/transfer/PanelDef.java Normal file
View File

@ -0,0 +1,24 @@
package io.nosqlbench.engine.clients.grafana.transfer;
import java.util.List;
import java.util.Map;
public class PanelDef {
boolean collapsed;
Map<String, String> gridPos;
long id;
List<PanelDef> panels;
String description;
Map<String, Object> fieldConfig;
Map<String, String> options;
String pluginVersion;
List<Map<String, String>> targets;
String title;
String type;
String datasource;
public String toString() {
return id + ":'" + title + "'";
}
}