Abbot – “grafana v1.0.0” by Serious Business

Code

<br /> using System.Net.Http;</p> <p>const string ApiKey = “GrafanaKey”;<br /> const string HostKey = “host”;<br /> const string ApiEndpointKey = “endpoint”;</p> <p>const string DefaultApiEndpoint = “d-solo”;</p> <p>Uri HostUri;<br /> Headers Headers;<br /> string Endpoint;</p> <p>// This section describes the chat interactions<br /> var (cmd, args) = Bot.Arguments.Pop();</p> <p>Task reply = cmd switch<br /> {<br /> “help” => ReplyWithHelp(args),<br /> var x when x ==”db” || x == “dash” => args.Count > 0 ? DbCmd(args) : ListCmd(),<br /> “dash” => args.Count > 0 ? DbCmd(args) : ListCmd(),<br /> “panels” => PanelsCmd(args),<br /> “list” => ListCmd(),<br /> “config” => ConfigCmd(args),<br /> _ => ReplyWithHelp(args)<br /> };</p> <p>await reply;</p> <p>Task ReplyWithHelp(IArguments args) {<br /> var (cmd, _) = args.Pop();<br /> return Bot.ReplyAsync(GetHelpMessage(cmd));<br /> }</p> <p>string GetHelpMessage(string cmd) {<br /> var reply = cmd switch {<br /> var x when x ==”db” || x == “dash” => new []{<br /> $”• `{Bot.SkillName} {x} [dashboard]:[panel name or id] [from] [to]` – Render a given panel dashboard, with optional time ranges in hours, days, months, etc”,<br /> $”• `{Bot.SkillName} {x} [dashboard]` – Render all panels in the dashboard”,<br /> $”• `{Bot.SkillName} {x}` – List all dashboards”,<br /> “Dashboard names can be partial. If it contains spaces, double-quote it.”,<br /> “”,<br /> “Examples:”,<br /> $”• `{Bot.SkillName} {x} stats:logins 2d 8h` – Render the logins panel of the stats dashboard with a window of 2 days to 8 hours”,<br /> $”• `{Bot.SkillName} {x} \”Global Stats:4\” 8h` – Render the panel with ID 4 of the Global Stats (stats) dashboard with a window of 8 hours from now”,<br /> “”,<br /> $”List panel IDs with `{Bot} {Bot.SkillName} panels [dashboard]`”,<br /> },<br /> “panels” => new [] {<br /> “• `{Bot.SkillName} panels {dashboard}` – List the panels of a given dashboard.”,<br /> $”Use the IDs returned by this in `{Bot.SkillName} db [dashboard]:[panel id]` calls as the panel id.”<br /> },<br /> “config” => new [] {<br /> $”• `{Bot.SkillName} config` – List all configuration variables”,<br /> $”• `{Bot.SkillName} config {HostKey}` – Get the value of {HostKey}”,<br /> $”• `{Bot.SkillName} config {HostKey} {{value}}` – Set the value of {HostKey} to {{value}}”,<br /> $”• `{Bot.SkillName} config {ApiEndpointKey}` – Get the value of {ApiEndpointKey}”,<br /> $”• `{Bot.SkillName} config {ApiEndpointKey} {{value}}` – Set the value of {ApiEndpointKey} to {{value}}”,<br /> },<br /> _ => new []{<br /> “• `{Bot.SkillName} db` or `dash` – Render panels in a dashboard.”,<br /> “• `{Bot.SkillName} panels` – List the panels of a given dashboard. Use the IDs returned by this in the `db`/`dash` command as the panel id.”,<br /> “• `{Bot.SkillName} list` – List available dashboards.”,<br /> “• `{Bot.SkillName} config` – Manage configuration variables.”,<br /> “• `{Bot.SkillName} help [command]` – Get detailed help on each available command.”,<br /> “”,<br /> “This skill requires a Grafana API key set up as a secret, and the hostname of your grafana instance.”,<br /> “”,<br /> “Grafana API Key:”,<br /> “• Visit {Grafana Host}/org/apikeys to create a key (for eg https://play.grafana.com/org/apikeys)”,<br /> $”• Visit {Bot.SkillUrl} and click \”Manage skill secrets\” to add a secret named `{ApiKey}` with the key you created.”,<br /> “”,<br /> “Grafana Host:”,<br /> $”• Call `{Bot} {Bot.SkillName} config host [hostname]`, where `[hostname]` is your grafana instance url (for eg. https://play.grafana.com).”,<br /> “”,<br /> “Run `{Bot} {Bot.SkillName} help [command]` for more information on a command.”,<br /> },<br /> };</p> <p> var sb = new System.Text.StringBuilder();<br /> foreach (var line in reply)<br /> sb.AppendLine(line);</p> <p> return sb.ToString();<br /> }</p> <p>Task ReplyWithLackOfUnderstanding() =><br /> Bot.ReplyAsync($”Sorry, I did not understand that. {GetHelpMessage()}”);</p> <p>string GetHelpMessage() => $”`{Bot} help {Bot.SkillName}` to learn how to use this skill.”;</p> <p>async Task DbCmd(IArguments args)<br /> {<br /> var (dashboard, vars) = args.Pop();<br /> string panelName = null;<br /> int panelId = -1;<br /> bool havePanelId = false;<br /> var parts = dashboard.Split(‘:’);<br /> var selectPanel = parts.Length > 1;</p> <p> if (selectPanel)<br /> {<br /> dashboard = parts[0];<br /> panelName = parts[1];<br /> havePanelId = int.TryParse(panelName, out panelId);<br /> }</p> <p> var db = await GetDashboard(dashboard);<br /> if (db == null) {<br /> await Bot.ReplyAsync($”Dashboard {dashboard} not found.”);<br /> return;<br /> }</p> <p> var pos = 0;<br /> var query = string.Join(‘&’, vars.Select(x =><br /> {<br /> if (x.Value.IndexOf(‘=’) < 0)<br /> {<br /> if (++pos == 1)<br /> return $”from=now-{x.Value}”;<br /> else if (pos == 2)<br /> return $”to=now-{x.Value}”;<br /> }<br /> return x.Value;<br /> }));</p> <p> var panelFound = false;</p> <p> foreach (var availablePanel in await GetPanels(db.Uid))<br /> {<br /> if ((selectPanel &&<br /> ((havePanelId && panelId == availablePanel.Id) || (availablePanel.Title?.ToUpper() == panelName.ToUpper())))<br /> || !selectPanel)<br /> {<br /> panelFound = true;<br /> await RenderPanel(db, availablePanel, query);<br /> }<br /> }</p> <p> if (!panelFound) {<br /> await Bot.ReplyAsync($”No panel \”{panelName}\” found on dashboard \”{dashboard}\””);<br /> }<br /> }</p> <p>async Task ConfigCmd(IArguments arguments)<br /> {<br /> var (cmd, args) = arguments.Pop();</p> <p> var result = cmd switch<br /> {<br /> HostKey => GetSetVariable(cmd, args), // host<br /> ApiEndpointKey => GetSetVariable(cmd, args), // endpoint<br /> _ => GetAllVariables(),<br /> };</p> <p> var reply = await result;<br /> await Bot.ReplyAsync(reply);<br /> }</p> <p>async Task ListCmd() {<br /> var sb = new System.Text.StringBuilder();<br /> sb.AppendLine(“Available dashboards:”);<br /> foreach (var dashboard in await GetDashboards()) {<br /> sb.AppendLine($”• <{HostUri}{dashboard.Url}|{dashboard.Title}>”);<br /> }<br /> sb.AppendLine();<br /> sb.AppendLine(“Dashboard Help:”);<br /> sb.Append(GetHelpMessage(“db”));<br /> await Bot.ReplyAsync(sb.ToString());<br /> }</p> <p>async Task PanelsCmd(IArguments args) {</p> <p> var sb = new System.Text.StringBuilder();<br /> var (dashboard, _) = args;<br /> if (dashboard is IMissingArgument) {<br /> sb.AppendLine(“Which dashboard do you want to list panels for?”);<br /> foreach (var d in await GetDashboards()) {<br /> sb.AppendLine($”• {d}”);<br /> }<br /> sb.AppendLine(“”);<br /> sb.AppendLine($”Call me with `{Bot} {Bot.SkillName} panels [dashboard]`. `[dashboard]` can be a partial name.”);<br /> await Bot.ReplyAsync(sb.ToString());<br /> return;<br /> }</p> <p> var db = await GetDashboard(dashboard.Value);<br /> if (db == null) {<br /> sb.AppendLine($”Dashboard {dashboard.Value} not found.”);<br /> sb.AppendLine(“Available dashboards:”);<br /> foreach (var d in await GetDashboards()) {<br /> sb.AppendLine($”• {d}”);<br /> }<br /> await Bot.ReplyAsync(sb.ToString());<br /> return;<br /> }</p> <p> var panels = await GetPanels(db.Uid);</p> <p> sb.AppendLine($”Available panels for dashboard {dashboard.Value}:”);<br /> sb.AppendLine($”\tId\tPanel”);<br /> sb.AppendLine($”\t–\t——–“);<br /> foreach (var panel in await GetPanels(db.Uid)) {<br /> sb.AppendLine($”\t{panel.Id}\t{panel.Title}”);<br /> }<br /> await Bot.ReplyAsync(sb.ToString());<br /> }</p> <p>async Task<string> GetAllVariables()<br /> {<br /> var sb = new System.Text.StringBuilder();<br /> sb.AppendLine(await GetSetVariable(HostKey));<br /> sb.AppendLine(await GetSetVariable(ApiEndpointKey));<br /> return sb.ToString();<br /> }</p> <p>async Task<string> GetSetVariable(string key, IArguments args = null)<br /> {<br /> if (args?.Count > 0) {<br /> var (val, _) = args.Pop();<br /> val = val?.TrimEnd(‘/’);<br /> await Bot.Brain.WriteAsync(key, val);<br /> return $”{key} is set to ‘{val}’”;<br /> } else {<br /> var val = await Bot.Brain.GetAsync(key);<br /> if (string.IsNullOrWhiteSpace(val) && key == ApiEndpointKey) {<br /> val = DefaultApiEndpoint;<br /> return $”{key} is set to ‘{val}’ (default value)”;<br /> }<br /> if (string.IsNullOrWhiteSpace(val))<br /> return $”{key} is not set”;<br /> return $”{key} is set to ‘{val}’”;<br /> }<br /> }</p> <p>async Task RenderPanel(Dashboard db, PanelData panel, string query) {<br /> var (success, errorMsg) = await EnsureAPI();<br /> if (!success) {<br /> await Bot.ReplyAsync(errorMsg);<br /> return;<br /> }</p> <p> var url = $”{HostUri}render/{Endpoint}/{db.Uid}/{db.Name}?panelId={panel.Id}&{query}”;</p> <p> var http = new HttpClient();<br /> using var request = new HttpRequestMessage<br /> {<br /> Method = HttpMethod.Get,<br /> RequestUri = new Uri(url)<br /> };</p> <p> Headers.CopyTo(request.Headers);</p> <p> var response = await http.SendAsync(request);<br /> response.EnsureSuccessStatusCode();</p> <p> var image = await response.Content.ReadAsByteArrayAsync();<br /> var base64 = System.Convert.ToBase64String(image);</p> <p> var link = new Uri($”{HostUri}{db.Url}/?panelId={panel.Id}&fullscreen&{query}”);<br /> await Bot.ReplyWithImageAsync(base64, title: panel.Title, titleUrl: link);<br /> }</p> <p>async Task<List<Dashboard>> GetDashboards() {<br /> var (success, errorMsg) = await EnsureAPI();<br /> var result = new List<Dashboard>();<br /> if (!success) {<br /> await Bot.ReplyAsync(errorMsg);<br /> return result;<br /> }</p> <p> var query = $”{HostUri}api/search?type=dash-db”;</p> <p> dynamic response = await Bot.Http.GetJsonAsync(query, Headers);<br /> foreach (var r in response) {<br /> if (r.type != “dash-db”)<br /> continue;<br /> result.Add(new Dashboard((string)r.uid, (string)r.title, (string)r.url));<br /> }<br /> return result;<br /> }</p> <p>async Task<Dashboard> GetDashboard(string dashboard) {<br /> var (success, errorMsg) = await EnsureAPI();<br /> if (!success) {<br /> await Bot.ReplyAsync(errorMsg);<br /> return null;<br /> }</p> <p> var query = $”{HostUri}api/search?query={dashboard}”;</p> <p> dynamic response = await Bot.Http.GetJsonAsync(query, Headers);</p> <p> if (response.Count > 0) {<br /> return new Dashboard((string)response[0].uid, (string)response[0].title, (string)response[0].url);<br /> }<br /> return null;<br /> }</p> <p>async Task<List<PanelData>> GetPanels(string uid) {<br /> var (success, errorMsg) = await EnsureAPI();<br /> var results = new List<PanelData>();<br /> if (!success) {<br /> await Bot.ReplyAsync(errorMsg);<br /> return results;<br /> }</p> <p> var query = $”{HostUri}api/dashboards/uid/{uid}”;</p> <p> dynamic response = await Bot.Http.GetJsonAsync(query, Headers);<br /> foreach (var panel in response.dashboard.panels) {<br /> results.Add(new PanelData((string)panel.title, (string)panel.id));<br /> }<br /> return results;<br /> }</p> <p>async Task<(bool, string)> EnsureAPI()<br /> {<br /> if (HostUri != null && Headers != null)<br /> return (true, null);</p> <p> string host = await Bot.Brain.GetAsync(HostKey);<br /> if (!Uri.TryCreate(host, UriKind.Absolute, out var uri))<br /> {<br /> // tell the user to set things<br /> return (false, $”I need to know what your Grafana host is. Call `{Bot} {Bot.SkillName} config {HostKey} {{host}}`, where {{host}} is your grafana instance url (for eg. https://play.grafana.org).”);<br /> }</p> <p> Endpoint = await Bot.Brain.GetAsync(ApiEndpointKey);<br /> if (string.IsNullOrWhiteSpace(Endpoint)) {<br /> Endpoint = DefaultApiEndpoint;<br /> }</p> <p> HostUri = uri;</p> <p> // special casing the example dashboards that don’t need auth<br /> if (host == “https://play.grafana.org”)<br /> {<br /> Headers = new Headers();<br /> }<br /> else<br /> {<br /> var key = await Bot.Secrets.GetAsync(ApiKey);<br /> if (string.IsNullOrWhiteSpace(key))<br /> {<br /> // tell the user to set things<br /> return (false,<br /> “This skill requires a Grafana API key set up as a secret. ”<br /> + “Visit {host}/org/apikeys to create a key. ”<br /> + $”Then visit {Bot.SkillUrl} and click \”Manage skill secrets\” to add a secret named `{ApiKey}` with the key you created.”);<br /> }</p> <p> Headers = new Headers(new Dictionary<string, string> {{“Authorization”, $”Bearer {key}”}});<br /> }</p> <p> return (true, null);<br /> }</p> <p>public class Dashboard {</p> <p> public Dashboard(string uid, string title, string url) {<br /> Title = title;<br /> Url = url.TrimStart(‘/’);<br /> Uid = uid;<br /> var idx = Url.LastIndexOf(‘/’);<br /> Name = Url[(idx < 0 ? 0 : idx + 1)..];<br /> }</p> <p> public string Uid { get; }<br /> public string Url { get; }<br /> public string Name { get; }<br /> public string Title { get; }<br /> }</p> <p>public class PanelData {<br /> public PanelData(string title, string id) {<br /> Title = title;<br /> Id = int.Parse(id);<br /> }</p> <p> public int Id { get; }<br /> public string Title { get; }<br /> }</p> <p>