feat: grafana dashboard configuration

src/components/grafana/builder.ts

@@ -1,11 +1,13 @@
 import * as pulumi from '@pulumi/pulumi';
 import { AMPConnection, GrafanaConnection } from './connections';
 import { Grafana } from './grafana';
+import { GrafanaDashboard } from './dashboards/types';
 
 export class GrafanaBuilder {
   private readonly name: string;
   private readonly connectionBuilders: GrafanaConnection.ConnectionBuilder[] =
     [];
+  private readonly dashboardBuilders: GrafanaDashboard.DashboardBuilder[] = [];
 
   constructor(name: string) {
     this.name = name;
@@ -23,6 +25,12 @@ export class GrafanaBuilder {
     return this;
   }
 
+  public addDashboard(builder: GrafanaDashboard.DashboardBuilder): this {
+    this.dashboardBuilders.push(builder);
+
+    return this;
+  }
+
   public build(opts: pulumi.ComponentResourceOptions = {}): Grafana {
     if (!this.connectionBuilders.length) {
       throw new Error(
@@ -34,6 +42,7 @@ export class GrafanaBuilder {
       this.name,
       {
         connectionBuilders: this.connectionBuilders,
+        dashboardBuilders: this.dashboardBuilders,
       },
       opts,
     );

src/components/grafana/dashboards/dashboard-builder.ts

@@ -0,0 +1,42 @@
+import * as pulumi from '@pulumi/pulumi';
+import * as grafana from '@pulumiverse/grafana';
+import { GrafanaConnection } from '../connections';
+import { GrafanaDashboard } from './types';
+import { Panel, PanelBuilder } from '../panels/types';
+
+export class DashboardBuilder {
+  private title: pulumi.Input<string>;
+  private panelBuilders: PanelBuilder[] = [];
+
+  constructor(args: { title: pulumi.Input<string> }) {
+    this.title = args.title;
+  }
+
+  addPanel(builder: PanelBuilder): this {
+    this.panelBuilders.push(builder);
+    return this;
+  }
+
+  build(connections: GrafanaConnection[]): GrafanaDashboard.DashboardConfig {
+    const { title, panelBuilders } = this;
+    const panels = panelBuilders.map(build => build(connections));
+
+    return {
+      createResource(name, folder, opts) {
+        return new grafana.oss.Dashboard(
+          name,
+          {
+            folder: folder?.uid,
+            configJson: pulumi.jsonStringify({
+              title,
+              timezone: 'browser',
+              refresh: '10s',
+              panels,
+            }),
+          },
+          { parent: folder, ...opts },
+        );
+      },
+    };
+  }
+}

src/components/grafana/dashboards/index.ts

@@ -1,2 +1,2 @@
-export { default as WebServerSloDashboardBuilder } from './web-server-slo';
-export * as panel from './panels';
+export { DashboardBuilder } from './dashboard-builder';
+export { createWebServerSloDashboard } from './web-server-slo';

src/components/grafana/dashboards/types.ts

@@ -1,73 +1,21 @@
 import * as pulumi from '@pulumi/pulumi';
 import * as grafana from '@pulumiverse/grafana';
+import { GrafanaConnection } from '../connections';
 
-// TODO: Should we prefix all namespaces with `Studion`
-export namespace Grafana {
-  // TODO: Create SLO abstraction that enables configuring:
-  // - panels (long-window SLI, long-window error budget)
-  // - alerts (long-window burn, short-window burn)
-  export type Threshold = {
-    value: number | null;
-    color: string;
-  };
-  export type Metric = {
-    label: string;
-    query: string;
-    thresholds: Threshold[];
-  };
-
+export namespace GrafanaDashboard {
   export type Args = {
     title: pulumi.Input<string>;
-    provider: pulumi.Input<grafana.Provider>;
-    tags: pulumi.Input<pulumi.Input<string>[]>;
   };
 
-  export type Panel = {
-    title: string;
-    gridPos: Panel.Position;
-    type: string;
-    datasource: string;
-    targets: {
-      expr: string;
-      legendFormat: string;
-    }[];
-    fieldConfig: {
-      defaults: {
-        unit?: string;
-        min?: number;
-        max?: number;
-        color?: {
-          mode: string;
-        };
-        thresholds?: {
-          mode: string;
-          steps: Threshold[];
-        };
-        custom?: {
-          lineInterpolation?: string;
-          spanNulls: boolean;
-        };
-      };
-    };
-    options?: {
-      colorMode?: string;
-      graphMode?: string;
-      justifyMode?: string;
-      textMode?: string;
-      reduceOptions?: {
-        calcs?: string[];
-        fields?: string;
-        values?: boolean;
-      };
-    };
-  };
-
-  export namespace Panel {
-    export type Position = {
-      x: number;
-      y: number;
-      w: number;
-      h: number;
-    };
+  export interface DashboardConfig {
+    createResource(
+      name: string,
+      folder?: grafana.oss.Folder,
+      opts?: pulumi.ComponentResourceOptions,
+    ): grafana.oss.Dashboard;
   }
+
+  export type DashboardBuilder = (
+    connections: GrafanaConnection[],
+  ) => DashboardConfig;
 }