feat: grafana dashboard configuration

src/components/grafana/builder.ts

@@ -0,0 +1,36 @@
+import * as pulumi from '@pulumi/pulumi';
+import { Grafana } from './grafana';
+import { GrafanaDashboard } from './dashboards/types';
+
+export class GrafanaBuilder {
+  private name: string;
+  private prometheusConfig?: Grafana.PrometheusConfig;
+  private dashboardConfigs: GrafanaDashboard.DashboardConfig[] = [];
+
+  constructor(name: string) {
+    this.name = name;
+  }
+
+  public withPrometheus(config: Grafana.PrometheusConfig): this {
+    this.prometheusConfig = config;
+
+    return this;
+  }
+
+  public addDashboard(config: GrafanaDashboard.DashboardConfig): this {
+    this.dashboardConfigs.push(config);
+
+    return this;
+  }
+
+  public build(opts: pulumi.ComponentResourceOptions = {}): Grafana {
+    return new Grafana(
+      this.name,
+      {
+        prometheusConfig: this.prometheusConfig,
+        dashboards: this.dashboardConfigs,
+      },
+      opts,
+    );
+  }
+}

src/components/grafana/dashboards/panels.ts

@@ -1,4 +1,5 @@
-import { Grafana } from './types';
+import * as pulumi from '@pulumi/pulumi';
+import { GrafanaDashboard } from './types';
 
 const percentageFieldConfig = {
   unit: 'percent',
@@ -8,10 +9,10 @@ const percentageFieldConfig = {
 
 export function createStatPercentagePanel(
   title: string,
-  position: Grafana.Panel.Position,
-  dataSource: string,
-  metric: Grafana.Metric,
-): Grafana.Panel {
+  position: GrafanaDashboard.PanelPosition,
+  dataSource: pulumi.Input<string>,
+  metric: GrafanaDashboard.Metric,
+): GrafanaDashboard.Panel {
   return {
     title,
     gridPos: position,
@@ -41,10 +42,10 @@ export function createStatPercentagePanel(
 
 export function createTimeSeriesPercentagePanel(
   title: string,
-  position: Grafana.Panel.Position,
-  dataSource: string,
-  metric: Grafana.Metric,
-): Grafana.Panel {
+  position: GrafanaDashboard.PanelPosition,
+  dataSource: pulumi.Input<string>,
+  metric: GrafanaDashboard.Metric,
+): GrafanaDashboard.Panel {
   return createTimeSeriesPanel(
     title,
     position,
@@ -58,13 +59,13 @@ export function createTimeSeriesPercentagePanel(
 
 export function createTimeSeriesPanel(
   title: string,
-  position: Grafana.Panel.Position,
-  dataSource: string,
-  metric: Grafana.Metric,
+  position: GrafanaDashboard.PanelPosition,
+  dataSource: pulumi.Input<string>,
+  metric: GrafanaDashboard.Metric,
   unit?: string,
   min?: number,
   max?: number,
-): Grafana.Panel {
+): GrafanaDashboard.Panel {
   return {
     title,
     type: 'timeseries',
@@ -96,10 +97,10 @@ export function createTimeSeriesPanel(
 
 export function createBurnRatePanel(
   title: string,
-  position: Grafana.Panel.Position,
-  dataSource: string,
-  metric: Grafana.Metric,
-): Grafana.Panel {
+  position: GrafanaDashboard.PanelPosition,
+  dataSource: pulumi.Input<string>,
+  metric: GrafanaDashboard.Metric,
+): GrafanaDashboard.Panel {
   return {
     type: 'stat',
     title,

src/components/grafana/dashboards/types.ts

@@ -1,32 +1,27 @@
 import * as pulumi from '@pulumi/pulumi';
 import * as grafana from '@pulumiverse/grafana';
 
-// 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[];
+// TODO: Create SLO abstraction that enables configuring:
+// - panels (long-window SLI, long-window error budget)
+// - alerts (long-window burn, short-window burn)
+export namespace GrafanaDashboard {
+  export type DataSources = {
+    prometheus?: pulumi.Output<string>;
   };
 
+  export interface DashboardConfig {
+    createResource(dataSources: DataSources): grafana.oss.Dashboard;
+  }
+
   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;
+    gridPos: PanelPosition;
     type: string;
-    datasource: string;
+    datasource: pulumi.Input<string>;
     targets: {
       expr: string;
       legendFormat: string;
@@ -62,12 +57,21 @@ export namespace Grafana {
     };
   };
 
-  export namespace Panel {
-    export type Position = {
-      x: number;
-      y: number;
-      w: number;
-      h: number;
-    };
-  }
+  export type PanelPosition = {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+  };
+
+  export type Threshold = {
+    value: number | null;
+    color: string;
+  };
+
+  export type Metric = {
+    label: string;
+    query: string;
+    thresholds: Threshold[];
+  };
 }