@backstage-community/plugin-grafana 0.10.1 → 0.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @backstage-community/plugin-grafana
2
2
 
3
+ ## 0.12.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 7872032: Use pagination for Grafana Dashboard search
8
+
9
+ ## 0.11.0
10
+
11
+ ### Minor Changes
12
+
13
+ - bc8d728: Backstage version bump to v1.45.1
14
+
3
15
  ## 0.10.1
4
16
 
5
17
  ### Patch Changes
package/config.d.ts CHANGED
@@ -34,5 +34,17 @@ export interface Config {
34
34
  * @visibility frontend
35
35
  */
36
36
  unifiedAlerting?: boolean;
37
+
38
+ /**
39
+ * Limit value to pass in Grafana Dashboard search query.
40
+ * @visibility frontend
41
+ */
42
+ grafanaDashboardSearchLimit?: number;
43
+
44
+ /**
45
+ * Max pages of Grafana Dashboard search query to fetch.
46
+ * @visibility frontend
47
+ */
48
+ grafanaDashboardMaxPages?: number;
37
49
  };
38
50
  }
@@ -17,14 +17,26 @@ const grafanaApiExtension = ApiBlueprint.make({
17
17
  fetchApi,
18
18
  discoveryApi,
19
19
  domain: configApi.getString("grafana.domain"),
20
- proxyPath: configApi.getOptionalString("grafana.proxyPath")
20
+ proxyPath: configApi.getOptionalString("grafana.proxyPath"),
21
+ grafanaDashboardSearchLimit: configApi.getOptionalNumber(
22
+ "grafana.grafanaDashboardSearchLimit"
23
+ ),
24
+ grafanaDashboardMaxPages: configApi.getOptionalNumber(
25
+ "grafana.grafanaDashboardMaxPages"
26
+ )
21
27
  });
22
28
  }
23
29
  return new UnifiedAlertingGrafanaApiClient({
24
30
  fetchApi,
25
31
  discoveryApi,
26
32
  domain: configApi.getString("grafana.domain"),
27
- proxyPath: configApi.getOptionalString("grafana.proxyPath")
33
+ proxyPath: configApi.getOptionalString("grafana.proxyPath"),
34
+ grafanaDashboardSearchLimit: configApi.getOptionalNumber(
35
+ "grafana.grafanaDashboardSearchLimit"
36
+ ),
37
+ grafanaDashboardMaxPages: configApi.getOptionalNumber(
38
+ "grafana.grafanaDashboardMaxPages"
39
+ )
28
40
  });
29
41
  }
30
42
  })
@@ -1 +1 @@
1
- {"version":3,"file":"apis.esm.js","sources":["../../src/alpha/apis.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n configApiRef,\n ApiBlueprint,\n discoveryApiRef,\n fetchApiRef,\n identityApiRef,\n} from '@backstage/frontend-plugin-api';\nimport {\n GrafanaApiClient,\n grafanaApiRef,\n UnifiedAlertingGrafanaApiClient,\n} from '../api';\n\n/**\n * @alpha\n */\nexport const grafanaApiExtension = ApiBlueprint.make({\n params: defineParams =>\n defineParams({\n api: grafanaApiRef,\n deps: {\n discoveryApi: discoveryApiRef,\n identityApi: identityApiRef,\n configApi: configApiRef,\n fetchApi: fetchApiRef,\n },\n factory: ({ discoveryApi, configApi, fetchApi }) => {\n const unifiedAlertingEnabled =\n configApi.getOptionalBoolean('grafana.unifiedAlerting') || false;\n\n if (!unifiedAlertingEnabled) {\n return new GrafanaApiClient({\n fetchApi,\n discoveryApi,\n domain: configApi.getString('grafana.domain'),\n proxyPath: configApi.getOptionalString('grafana.proxyPath'),\n });\n }\n\n return new UnifiedAlertingGrafanaApiClient({\n fetchApi,\n discoveryApi,\n domain: configApi.getString('grafana.domain'),\n proxyPath: configApi.getOptionalString('grafana.proxyPath'),\n });\n },\n }),\n});\n"],"names":[],"mappings":";;;AA+Ba,MAAA,mBAAA,GAAsB,aAAa,IAAK,CAAA;AAAA,EACnD,MAAA,EAAQ,kBACN,YAAa,CAAA;AAAA,IACX,GAAK,EAAA,aAAA;AAAA,IACL,IAAM,EAAA;AAAA,MACJ,YAAc,EAAA,eAAA;AAAA,MACd,WAAa,EAAA,cAAA;AAAA,MACb,SAAW,EAAA,YAAA;AAAA,MACX,QAAU,EAAA;AAAA,KACZ;AAAA,IACA,SAAS,CAAC,EAAE,YAAc,EAAA,SAAA,EAAW,UAAe,KAAA;AAClD,MAAA,MAAM,sBACJ,GAAA,SAAA,CAAU,kBAAmB,CAAA,yBAAyB,CAAK,IAAA,KAAA;AAE7D,MAAA,IAAI,CAAC,sBAAwB,EAAA;AAC3B,QAAA,OAAO,IAAI,gBAAiB,CAAA;AAAA,UAC1B,QAAA;AAAA,UACA,YAAA;AAAA,UACA,MAAA,EAAQ,SAAU,CAAA,SAAA,CAAU,gBAAgB,CAAA;AAAA,UAC5C,SAAA,EAAW,SAAU,CAAA,iBAAA,CAAkB,mBAAmB;AAAA,SAC3D,CAAA;AAAA;AAGH,MAAA,OAAO,IAAI,+BAAgC,CAAA;AAAA,QACzC,QAAA;AAAA,QACA,YAAA;AAAA,QACA,MAAA,EAAQ,SAAU,CAAA,SAAA,CAAU,gBAAgB,CAAA;AAAA,QAC5C,SAAA,EAAW,SAAU,CAAA,iBAAA,CAAkB,mBAAmB;AAAA,OAC3D,CAAA;AAAA;AACH,GACD;AACL,CAAC;;;;"}
1
+ {"version":3,"file":"apis.esm.js","sources":["../../src/alpha/apis.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n configApiRef,\n ApiBlueprint,\n discoveryApiRef,\n fetchApiRef,\n identityApiRef,\n} from '@backstage/frontend-plugin-api';\nimport {\n GrafanaApiClient,\n grafanaApiRef,\n UnifiedAlertingGrafanaApiClient,\n} from '../api';\n\n/**\n * @alpha\n */\nexport const grafanaApiExtension = ApiBlueprint.make({\n params: defineParams =>\n defineParams({\n api: grafanaApiRef,\n deps: {\n discoveryApi: discoveryApiRef,\n identityApi: identityApiRef,\n configApi: configApiRef,\n fetchApi: fetchApiRef,\n },\n factory: ({ discoveryApi, configApi, fetchApi }) => {\n const unifiedAlertingEnabled =\n configApi.getOptionalBoolean('grafana.unifiedAlerting') || false;\n\n if (!unifiedAlertingEnabled) {\n return new GrafanaApiClient({\n fetchApi,\n discoveryApi,\n domain: configApi.getString('grafana.domain'),\n proxyPath: configApi.getOptionalString('grafana.proxyPath'),\n grafanaDashboardSearchLimit: configApi.getOptionalNumber(\n 'grafana.grafanaDashboardSearchLimit',\n ),\n grafanaDashboardMaxPages: configApi.getOptionalNumber(\n 'grafana.grafanaDashboardMaxPages',\n ),\n });\n }\n\n return new UnifiedAlertingGrafanaApiClient({\n fetchApi,\n discoveryApi,\n domain: configApi.getString('grafana.domain'),\n proxyPath: configApi.getOptionalString('grafana.proxyPath'),\n grafanaDashboardSearchLimit: configApi.getOptionalNumber(\n 'grafana.grafanaDashboardSearchLimit',\n ),\n grafanaDashboardMaxPages: configApi.getOptionalNumber(\n 'grafana.grafanaDashboardMaxPages',\n ),\n });\n },\n }),\n});\n"],"names":[],"mappings":";;;AA+Ba,MAAA,mBAAA,GAAsB,aAAa,IAAK,CAAA;AAAA,EACnD,MAAA,EAAQ,kBACN,YAAa,CAAA;AAAA,IACX,GAAK,EAAA,aAAA;AAAA,IACL,IAAM,EAAA;AAAA,MACJ,YAAc,EAAA,eAAA;AAAA,MACd,WAAa,EAAA,cAAA;AAAA,MACb,SAAW,EAAA,YAAA;AAAA,MACX,QAAU,EAAA;AAAA,KACZ;AAAA,IACA,SAAS,CAAC,EAAE,YAAc,EAAA,SAAA,EAAW,UAAe,KAAA;AAClD,MAAA,MAAM,sBACJ,GAAA,SAAA,CAAU,kBAAmB,CAAA,yBAAyB,CAAK,IAAA,KAAA;AAE7D,MAAA,IAAI,CAAC,sBAAwB,EAAA;AAC3B,QAAA,OAAO,IAAI,gBAAiB,CAAA;AAAA,UAC1B,QAAA;AAAA,UACA,YAAA;AAAA,UACA,MAAA,EAAQ,SAAU,CAAA,SAAA,CAAU,gBAAgB,CAAA;AAAA,UAC5C,SAAA,EAAW,SAAU,CAAA,iBAAA,CAAkB,mBAAmB,CAAA;AAAA,UAC1D,6BAA6B,SAAU,CAAA,iBAAA;AAAA,YACrC;AAAA,WACF;AAAA,UACA,0BAA0B,SAAU,CAAA,iBAAA;AAAA,YAClC;AAAA;AACF,SACD,CAAA;AAAA;AAGH,MAAA,OAAO,IAAI,+BAAgC,CAAA;AAAA,QACzC,QAAA;AAAA,QACA,YAAA;AAAA,QACA,MAAA,EAAQ,SAAU,CAAA,SAAA,CAAU,gBAAgB,CAAA;AAAA,QAC5C,SAAA,EAAW,SAAU,CAAA,iBAAA,CAAkB,mBAAmB,CAAA;AAAA,QAC1D,6BAA6B,SAAU,CAAA,iBAAA;AAAA,UACrC;AAAA,SACF;AAAA,QACA,0BAA0B,SAAU,CAAA,iBAAA;AAAA,UAClC;AAAA;AACF,OACD,CAAA;AAAA;AACH,GACD;AACL,CAAC;;;;"}
package/dist/alpha.d.ts CHANGED
@@ -11,7 +11,7 @@ import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
11
11
  * @alpha
12
12
  */
13
13
  declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin<{}, {}, {
14
- "api:grafana": _backstage_frontend_plugin_api.ExtensionDefinition<{
14
+ "api:grafana": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
15
15
  kind: "api";
16
16
  name: undefined;
17
17
  config: {};
@@ -22,7 +22,7 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
22
22
  [x: string]: unknown;
23
23
  }>(params: _backstage_core_plugin_api.ApiFactory<TApi, TImpl, TDeps>) => _backstage_frontend_plugin_api.ExtensionBlueprintParams<_backstage_core_plugin_api.AnyApiFactory>;
24
24
  }>;
25
- "entity-card:grafana/alerts": _backstage_frontend_plugin_api.ExtensionDefinition<{
25
+ "entity-card:grafana/alerts": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
26
26
  kind: "entity-card";
27
27
  name: "alerts";
28
28
  config: {
@@ -47,7 +47,7 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
47
47
  type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
48
48
  };
49
49
  }>;
50
- "entity-card:grafana/dashboards": _backstage_frontend_plugin_api.ExtensionDefinition<{
50
+ "entity-card:grafana/dashboards": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
51
51
  kind: "entity-card";
52
52
  name: "dashboards";
53
53
  config: {
@@ -72,7 +72,7 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
72
72
  type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
73
73
  };
74
74
  }>;
75
- "entity-card:grafana/overview-dashboard": _backstage_frontend_plugin_api.ExtensionDefinition<{
75
+ "entity-card:grafana/overview-dashboard": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
76
76
  kind: "entity-card";
77
77
  name: "overview-dashboard";
78
78
  config: {
package/dist/api.esm.js CHANGED
@@ -5,6 +5,9 @@ const grafanaApiRef = createApiRef({
5
5
  id: "plugin.grafana.service"
6
6
  });
7
7
  const DEFAULT_PROXY_PATH = "/grafana/api";
8
+ const DEFAULT_DASHBOARDS_LIMIT = 1e3;
9
+ const DEFAULT_PAGES_LIMIT = 1;
10
+ const UPSTREAM_DASHBOARDS_LIMIT_MAX = 5e3;
8
11
  const isSingleWord = (input) => {
9
12
  return input.match(/^[\w-]+$/g) !== null;
10
13
  };
@@ -13,11 +16,18 @@ class Client {
13
16
  fetchApi;
14
17
  proxyPath;
15
18
  queryEvaluator;
19
+ grafanaDashboardSearchLimit;
20
+ grafanaDashboardMaxPages;
16
21
  constructor(opts) {
17
22
  this.discoveryApi = opts.discoveryApi;
18
23
  this.fetchApi = opts.fetchApi;
19
24
  this.proxyPath = opts.proxyPath ?? DEFAULT_PROXY_PATH;
20
25
  this.queryEvaluator = new QueryEvaluator();
26
+ this.grafanaDashboardSearchLimit = Math.min(
27
+ opts.grafanaDashboardSearchLimit ?? DEFAULT_DASHBOARDS_LIMIT,
28
+ UPSTREAM_DASHBOARDS_LIMIT_MAX
29
+ );
30
+ this.grafanaDashboardMaxPages = opts.grafanaDashboardMaxPages ?? DEFAULT_PAGES_LIMIT;
21
31
  }
22
32
  async fetch(input, init) {
23
33
  const apiUrl = await this.apiUrl();
@@ -33,22 +43,42 @@ class Client {
33
43
  }
34
44
  return this.dashboardsForQuery(domain, query);
35
45
  }
46
+ async fetchSomeDashboards(options) {
47
+ const query = `/api/search?type=dash-db&limit=${options.limit}&page=${options.page}${options.tag !== void 0 ? `&tag=${options.tag}` : ""}`;
48
+ const response = await this.fetch(query);
49
+ return this.fullyQualifiedDashboardMetadata(options.domain, response);
50
+ }
51
+ // Grafana Search API does not have pagination metadata in the response body or headers
52
+ // so we have to guess if we are at the end based on number of items in the result
53
+ // https://grafana.com/docs/grafana/latest/developers/http_api/folder_dashboard_search/
54
+ // The API also does not use continuation tokens, so there is no guarantee
55
+ // that dashboards have not been added or deleted since listing the previous
56
+ // page.
57
+ async fetchAllDashboards(options) {
58
+ let page = 0;
59
+ const allDashboards = [];
60
+ let more = true;
61
+ do {
62
+ const dashboards = await this.fetchSomeDashboards({
63
+ domain: options.domain,
64
+ page: page++,
65
+ limit: this.grafanaDashboardSearchLimit,
66
+ tag: options.tag
67
+ });
68
+ allDashboards.push(...dashboards);
69
+ more = dashboards.length >= this.grafanaDashboardSearchLimit && page < this.grafanaDashboardMaxPages;
70
+ } while (more);
71
+ return allDashboards;
72
+ }
36
73
  async dashboardsForQuery(domain, query) {
37
74
  const parsedQuery = this.queryEvaluator.parse(query);
38
- const response = await this.fetch(`/api/search?type=dash-db`);
39
- const allDashboards = this.fullyQualifiedDashboardMetadata(
40
- domain,
41
- response
42
- );
75
+ const allDashboards = await this.fetchAllDashboards({ domain });
43
76
  return allDashboards.filter((dashboard) => {
44
77
  return this.queryEvaluator.evaluate(parsedQuery, dashboard) === true;
45
78
  });
46
79
  }
47
80
  async dashboardsByTag(domain, tag) {
48
- const response = await this.fetch(
49
- `/api/search?type=dash-db&tag=${tag}`
50
- );
51
- return this.fullyQualifiedDashboardMetadata(domain, response);
81
+ return this.fetchAllDashboards({ domain, tag });
52
82
  }
53
83
  fullyQualifiedDashboardMetadata(domain, dashboards) {
54
84
  return dashboards.map((dashboard) => ({
@@ -1 +1 @@
1
- {"version":3,"file":"api.esm.js","sources":["../src/api.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n createApiRef,\n DiscoveryApi,\n FetchApi,\n} from '@backstage/frontend-plugin-api';\nimport { QueryEvaluator } from './query';\nimport { Alert, Dashboard } from './types';\n\n/**\n * Interface for the Grafana API\n * @public\n */\nexport interface GrafanaApi {\n /**\n * Returns the found dashboards in Grafana with the defined query\n * @param query - The query used to list the dashboards\n */\n listDashboards(query: string): Promise<Dashboard[]>;\n /**\n * Returns a list of alerts found in Grafana that have any of the defined alert selectors\n * @param selectors - One or multiple alert selectors\n */\n alertsForSelector(selectors: string | string[]): Promise<Alert[]>;\n}\n\ninterface AggregatedAlertState {\n Normal: number;\n Pending: number;\n Alerting: number;\n NoData: number;\n Error: number;\n Invalid: number;\n}\n\ntype AlertState =\n | 'Normal'\n | 'Pending'\n | 'Alerting'\n | 'NoData'\n | 'Error'\n | 'n/a';\n\ninterface AlertInstance {\n labels: Record<string, string>;\n state: AlertState;\n}\n\ninterface AlertsData {\n data: { alerts: AlertInstance[] };\n}\n\ninterface AlertRuleGroupConfig {\n name: string;\n rules: AlertRule[];\n}\n\ninterface GrafanaAlert {\n id: number;\n panelId: number;\n name: string;\n state: string;\n url: string;\n}\n\ninterface UnifiedGrafanaAlert {\n uid: string;\n title: string;\n}\n\ninterface AlertRule {\n labels: Record<string, string>;\n grafana_alert: UnifiedGrafanaAlert;\n}\n\n/**\n * The grafana API reference\n * @public\n */\nexport const grafanaApiRef = createApiRef<GrafanaApi>({\n id: 'plugin.grafana.service',\n});\n\nexport type Options = {\n discoveryApi: DiscoveryApi;\n fetchApi: FetchApi;\n\n /**\n * Domain used by users to access Grafana web UI.\n * Example: https://monitoring.my-company.com/\n */\n domain: string;\n\n /**\n * Path to use for requests via the proxy, defaults to /grafana/api\n */\n proxyPath?: string;\n};\n\nconst DEFAULT_PROXY_PATH = '/grafana/api';\n\nconst isSingleWord = (input: string): boolean => {\n return input.match(/^[\\w-]+$/g) !== null;\n};\n\nclass Client {\n private readonly discoveryApi: DiscoveryApi;\n private readonly fetchApi: FetchApi;\n private readonly proxyPath: string;\n private readonly queryEvaluator: QueryEvaluator;\n\n constructor(opts: Options) {\n this.discoveryApi = opts.discoveryApi;\n this.fetchApi = opts.fetchApi;\n this.proxyPath = opts.proxyPath ?? DEFAULT_PROXY_PATH;\n this.queryEvaluator = new QueryEvaluator();\n }\n\n public async fetch<T = any>(input: string, init?: RequestInit): Promise<T> {\n const apiUrl = await this.apiUrl();\n const resp = await this.fetchApi.fetch(`${apiUrl}${input}`, init);\n if (!resp.ok) {\n throw new Error(`Request failed with ${resp.status} ${resp.statusText}`);\n }\n\n return await resp.json();\n }\n\n async listDashboards(domain: string, query: string): Promise<Dashboard[]> {\n if (isSingleWord(query)) {\n return this.dashboardsByTag(domain, query);\n }\n\n return this.dashboardsForQuery(domain, query);\n }\n\n async dashboardsForQuery(\n domain: string,\n query: string,\n ): Promise<Dashboard[]> {\n const parsedQuery = this.queryEvaluator.parse(query);\n const response = await this.fetch<Dashboard[]>(`/api/search?type=dash-db`);\n const allDashboards = this.fullyQualifiedDashboardMetadata(\n domain,\n response,\n );\n\n return allDashboards.filter(dashboard => {\n return this.queryEvaluator.evaluate(parsedQuery, dashboard) === true;\n });\n }\n\n async dashboardsByTag(domain: string, tag: string): Promise<Dashboard[]> {\n const response = await this.fetch<Dashboard[]>(\n `/api/search?type=dash-db&tag=${tag}`,\n );\n\n return this.fullyQualifiedDashboardMetadata(domain, response);\n }\n\n private fullyQualifiedDashboardMetadata(\n domain: string,\n dashboards: Dashboard[],\n ): Dashboard[] {\n return dashboards.map(dashboard => ({\n ...dashboard,\n url: domain + dashboard.url,\n folderTitle: dashboard.folderTitle ?? '',\n folderUrl: domain + dashboard.folderUrl,\n }));\n }\n\n private async apiUrl() {\n const proxyUrl = await this.discoveryApi.getBaseUrl('proxy');\n return proxyUrl + this.proxyPath;\n }\n}\n\nexport class GrafanaApiClient implements GrafanaApi {\n private readonly domain: string;\n private readonly client: Client;\n\n constructor(opts: Options) {\n this.domain = opts.domain;\n this.client = new Client(opts);\n }\n\n async listDashboards(query: string): Promise<Dashboard[]> {\n return this.client.listDashboards(this.domain, query);\n }\n\n async alertsForSelector(dashboardTag: string): Promise<Alert[]> {\n const response = await this.client.fetch<GrafanaAlert[]>(\n `/api/alerts?dashboardTag=${dashboardTag}`,\n );\n\n return response.map(alert => ({\n name: alert.name,\n state: alert.state,\n matchingSelector: dashboardTag,\n url: `${this.domain}${alert.url}?panelId=${alert.panelId}&fullscreen&refresh=30s`,\n }));\n }\n}\n\nexport class UnifiedAlertingGrafanaApiClient implements GrafanaApi {\n private readonly domain: string;\n private readonly client: Client;\n\n constructor(opts: Options) {\n this.domain = opts.domain;\n this.client = new Client(opts);\n }\n\n async listDashboards(query: string): Promise<Dashboard[]> {\n return this.client.listDashboards(this.domain, query);\n }\n\n async alertsForSelector(selectors: string | string[]): Promise<Alert[]> {\n let labelSelectors: string[] = [];\n if (typeof selectors === 'string') {\n labelSelectors = [selectors];\n } else {\n labelSelectors = selectors;\n }\n\n const rulesResponse = await this.client.fetch<\n Record<string, AlertRuleGroupConfig[]>\n >('/api/ruler/grafana/api/v1/rules');\n const rules = Object.values(rulesResponse)\n .flat()\n .map(ruleGroup => ruleGroup.rules)\n .flat();\n const alertsResponse = await this.client.fetch<AlertsData>(\n '/api/prometheus/grafana/api/v1/alerts',\n );\n\n return labelSelectors\n .map(selector => {\n const [label, labelValue] = selector.split('=');\n\n const matchingRules = rules.filter(\n rule => rule.labels && rule.labels[label] === labelValue,\n );\n const alertInstances = alertsResponse.data.alerts.filter(\n alertInstance => alertInstance.labels[label] === labelValue,\n );\n\n return matchingRules.map(rule => {\n const matchingAlertInstances = alertInstances.filter(\n alertInstance =>\n alertInstance.labels.alertname === rule.grafana_alert.title,\n );\n\n const aggregatedAlertStates: AggregatedAlertState =\n matchingAlertInstances.reduce(\n (previous, alert) => {\n switch (alert.state) {\n case 'Normal':\n previous.Normal += 1;\n break;\n case 'Pending':\n previous.Pending += 1;\n break;\n case 'Alerting':\n previous.Alerting += 1;\n break;\n case 'NoData':\n previous.NoData += 1;\n break;\n case 'Error':\n previous.Error += 1;\n break;\n default:\n previous.Invalid += 1;\n }\n\n return previous;\n },\n {\n Normal: 0,\n Pending: 0,\n Alerting: 0,\n NoData: 0,\n Error: 0,\n Invalid: 0,\n },\n );\n\n return {\n name: rule.grafana_alert.title,\n url: `${this.domain}/alerting/grafana/${rule.grafana_alert.uid}/view`,\n matchingSelector: selector,\n state: this.getState(\n aggregatedAlertStates,\n matchingAlertInstances.length,\n ),\n };\n });\n })\n .flat();\n }\n\n private getState(\n states: AggregatedAlertState,\n totalAlerts: number,\n ): AlertState {\n if (states.Alerting > 0) {\n return 'Alerting';\n } else if (states.Error > 0) {\n return 'Error';\n } else if (states.Pending > 0) {\n return 'Pending';\n }\n if (states.NoData === totalAlerts) {\n return 'NoData';\n } else if (\n states.Normal === totalAlerts ||\n states.Normal + states.NoData === totalAlerts\n ) {\n return 'Normal';\n }\n\n return 'n/a';\n }\n}\n"],"names":[],"mappings":";;;AA8FO,MAAM,gBAAgB,YAAyB,CAAA;AAAA,EACpD,EAAI,EAAA;AACN,CAAC;AAkBD,MAAM,kBAAqB,GAAA,cAAA;AAE3B,MAAM,YAAA,GAAe,CAAC,KAA2B,KAAA;AAC/C,EAAO,OAAA,KAAA,CAAM,KAAM,CAAA,WAAW,CAAM,KAAA,IAAA;AACtC,CAAA;AAEA,MAAM,MAAO,CAAA;AAAA,EACM,YAAA;AAAA,EACA,QAAA;AAAA,EACA,SAAA;AAAA,EACA,cAAA;AAAA,EAEjB,YAAY,IAAe,EAAA;AACzB,IAAA,IAAA,CAAK,eAAe,IAAK,CAAA,YAAA;AACzB,IAAA,IAAA,CAAK,WAAW,IAAK,CAAA,QAAA;AACrB,IAAK,IAAA,CAAA,SAAA,GAAY,KAAK,SAAa,IAAA,kBAAA;AACnC,IAAK,IAAA,CAAA,cAAA,GAAiB,IAAI,cAAe,EAAA;AAAA;AAC3C,EAEA,MAAa,KAAe,CAAA,KAAA,EAAe,IAAgC,EAAA;AACzE,IAAM,MAAA,MAAA,GAAS,MAAM,IAAA,CAAK,MAAO,EAAA;AACjC,IAAM,MAAA,IAAA,GAAO,MAAM,IAAA,CAAK,QAAS,CAAA,KAAA,CAAM,GAAG,MAAM,CAAA,EAAG,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA;AAChE,IAAI,IAAA,CAAC,KAAK,EAAI,EAAA;AACZ,MAAM,MAAA,IAAI,MAAM,CAAuB,oBAAA,EAAA,IAAA,CAAK,MAAM,CAAI,CAAA,EAAA,IAAA,CAAK,UAAU,CAAE,CAAA,CAAA;AAAA;AAGzE,IAAO,OAAA,MAAM,KAAK,IAAK,EAAA;AAAA;AACzB,EAEA,MAAM,cAAe,CAAA,MAAA,EAAgB,KAAqC,EAAA;AACxE,IAAI,IAAA,YAAA,CAAa,KAAK,CAAG,EAAA;AACvB,MAAO,OAAA,IAAA,CAAK,eAAgB,CAAA,MAAA,EAAQ,KAAK,CAAA;AAAA;AAG3C,IAAO,OAAA,IAAA,CAAK,kBAAmB,CAAA,MAAA,EAAQ,KAAK,CAAA;AAAA;AAC9C,EAEA,MAAM,kBACJ,CAAA,MAAA,EACA,KACsB,EAAA;AACtB,IAAA,MAAM,WAAc,GAAA,IAAA,CAAK,cAAe,CAAA,KAAA,CAAM,KAAK,CAAA;AACnD,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,KAAA,CAAmB,CAA0B,wBAAA,CAAA,CAAA;AACzE,IAAA,MAAM,gBAAgB,IAAK,CAAA,+BAAA;AAAA,MACzB,MAAA;AAAA,MACA;AAAA,KACF;AAEA,IAAO,OAAA,aAAA,CAAc,OAAO,CAAa,SAAA,KAAA;AACvC,MAAA,OAAO,IAAK,CAAA,cAAA,CAAe,QAAS,CAAA,WAAA,EAAa,SAAS,CAAM,KAAA,IAAA;AAAA,KACjE,CAAA;AAAA;AACH,EAEA,MAAM,eAAgB,CAAA,MAAA,EAAgB,GAAmC,EAAA;AACvE,IAAM,MAAA,QAAA,GAAW,MAAM,IAAK,CAAA,KAAA;AAAA,MAC1B,gCAAgC,GAAG,CAAA;AAAA,KACrC;AAEA,IAAO,OAAA,IAAA,CAAK,+BAAgC,CAAA,MAAA,EAAQ,QAAQ,CAAA;AAAA;AAC9D,EAEQ,+BAAA,CACN,QACA,UACa,EAAA;AACb,IAAO,OAAA,UAAA,CAAW,IAAI,CAAc,SAAA,MAAA;AAAA,MAClC,GAAG,SAAA;AAAA,MACH,GAAA,EAAK,SAAS,SAAU,CAAA,GAAA;AAAA,MACxB,WAAA,EAAa,UAAU,WAAe,IAAA,EAAA;AAAA,MACtC,SAAA,EAAW,SAAS,SAAU,CAAA;AAAA,KAC9B,CAAA,CAAA;AAAA;AACJ,EAEA,MAAc,MAAS,GAAA;AACrB,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,WAAW,OAAO,CAAA;AAC3D,IAAA,OAAO,WAAW,IAAK,CAAA,SAAA;AAAA;AAE3B;AAEO,MAAM,gBAAuC,CAAA;AAAA,EACjC,MAAA;AAAA,EACA,MAAA;AAAA,EAEjB,YAAY,IAAe,EAAA;AACzB,IAAA,IAAA,CAAK,SAAS,IAAK,CAAA,MAAA;AACnB,IAAK,IAAA,CAAA,MAAA,GAAS,IAAI,MAAA,CAAO,IAAI,CAAA;AAAA;AAC/B,EAEA,MAAM,eAAe,KAAqC,EAAA;AACxD,IAAA,OAAO,IAAK,CAAA,MAAA,CAAO,cAAe,CAAA,IAAA,CAAK,QAAQ,KAAK,CAAA;AAAA;AACtD,EAEA,MAAM,kBAAkB,YAAwC,EAAA;AAC9D,IAAM,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACjC,4BAA4B,YAAY,CAAA;AAAA,KAC1C;AAEA,IAAO,OAAA,QAAA,CAAS,IAAI,CAAU,KAAA,MAAA;AAAA,MAC5B,MAAM,KAAM,CAAA,IAAA;AAAA,MACZ,OAAO,KAAM,CAAA,KAAA;AAAA,MACb,gBAAkB,EAAA,YAAA;AAAA,MAClB,GAAA,EAAK,GAAG,IAAK,CAAA,MAAM,GAAG,KAAM,CAAA,GAAG,CAAY,SAAA,EAAA,KAAA,CAAM,OAAO,CAAA,uBAAA;AAAA,KACxD,CAAA,CAAA;AAAA;AAEN;AAEO,MAAM,+BAAsD,CAAA;AAAA,EAChD,MAAA;AAAA,EACA,MAAA;AAAA,EAEjB,YAAY,IAAe,EAAA;AACzB,IAAA,IAAA,CAAK,SAAS,IAAK,CAAA,MAAA;AACnB,IAAK,IAAA,CAAA,MAAA,GAAS,IAAI,MAAA,CAAO,IAAI,CAAA;AAAA;AAC/B,EAEA,MAAM,eAAe,KAAqC,EAAA;AACxD,IAAA,OAAO,IAAK,CAAA,MAAA,CAAO,cAAe,CAAA,IAAA,CAAK,QAAQ,KAAK,CAAA;AAAA;AACtD,EAEA,MAAM,kBAAkB,SAAgD,EAAA;AACtE,IAAA,IAAI,iBAA2B,EAAC;AAChC,IAAI,IAAA,OAAO,cAAc,QAAU,EAAA;AACjC,MAAA,cAAA,GAAiB,CAAC,SAAS,CAAA;AAAA,KACtB,MAAA;AACL,MAAiB,cAAA,GAAA,SAAA;AAAA;AAGnB,IAAA,MAAM,aAAgB,GAAA,MAAM,IAAK,CAAA,MAAA,CAAO,MAEtC,iCAAiC,CAAA;AACnC,IAAA,MAAM,KAAQ,GAAA,MAAA,CAAO,MAAO,CAAA,aAAa,CACtC,CAAA,IAAA,EACA,CAAA,GAAA,CAAI,CAAa,SAAA,KAAA,SAAA,CAAU,KAAK,CAAA,CAChC,IAAK,EAAA;AACR,IAAM,MAAA,cAAA,GAAiB,MAAM,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACvC;AAAA,KACF;AAEA,IAAO,OAAA,cAAA,CACJ,IAAI,CAAY,QAAA,KAAA;AACf,MAAA,MAAM,CAAC,KAAO,EAAA,UAAU,CAAI,GAAA,QAAA,CAAS,MAAM,GAAG,CAAA;AAE9C,MAAA,MAAM,gBAAgB,KAAM,CAAA,MAAA;AAAA,QAC1B,UAAQ,IAAK,CAAA,MAAA,IAAU,IAAK,CAAA,MAAA,CAAO,KAAK,CAAM,KAAA;AAAA,OAChD;AACA,MAAM,MAAA,cAAA,GAAiB,cAAe,CAAA,IAAA,CAAK,MAAO,CAAA,MAAA;AAAA,QAChD,CAAiB,aAAA,KAAA,aAAA,CAAc,MAAO,CAAA,KAAK,CAAM,KAAA;AAAA,OACnD;AAEA,MAAO,OAAA,aAAA,CAAc,IAAI,CAAQ,IAAA,KAAA;AAC/B,QAAA,MAAM,yBAAyB,cAAe,CAAA,MAAA;AAAA,UAC5C,CACE,aAAA,KAAA,aAAA,CAAc,MAAO,CAAA,SAAA,KAAc,KAAK,aAAc,CAAA;AAAA,SAC1D;AAEA,QAAA,MAAM,wBACJ,sBAAuB,CAAA,MAAA;AAAA,UACrB,CAAC,UAAU,KAAU,KAAA;AACnB,YAAA,QAAQ,MAAM,KAAO;AAAA,cACnB,KAAK,QAAA;AACH,gBAAA,QAAA,CAAS,MAAU,IAAA,CAAA;AACnB,gBAAA;AAAA,cACF,KAAK,SAAA;AACH,gBAAA,QAAA,CAAS,OAAW,IAAA,CAAA;AACpB,gBAAA;AAAA,cACF,KAAK,UAAA;AACH,gBAAA,QAAA,CAAS,QAAY,IAAA,CAAA;AACrB,gBAAA;AAAA,cACF,KAAK,QAAA;AACH,gBAAA,QAAA,CAAS,MAAU,IAAA,CAAA;AACnB,gBAAA;AAAA,cACF,KAAK,OAAA;AACH,gBAAA,QAAA,CAAS,KAAS,IAAA,CAAA;AAClB,gBAAA;AAAA,cACF;AACE,gBAAA,QAAA,CAAS,OAAW,IAAA,CAAA;AAAA;AAGxB,YAAO,OAAA,QAAA;AAAA,WACT;AAAA,UACA;AAAA,YACE,MAAQ,EAAA,CAAA;AAAA,YACR,OAAS,EAAA,CAAA;AAAA,YACT,QAAU,EAAA,CAAA;AAAA,YACV,MAAQ,EAAA,CAAA;AAAA,YACR,KAAO,EAAA,CAAA;AAAA,YACP,OAAS,EAAA;AAAA;AACX,SACF;AAEF,QAAO,OAAA;AAAA,UACL,IAAA,EAAM,KAAK,aAAc,CAAA,KAAA;AAAA,UACzB,KAAK,CAAG,EAAA,IAAA,CAAK,MAAM,CAAqB,kBAAA,EAAA,IAAA,CAAK,cAAc,GAAG,CAAA,KAAA,CAAA;AAAA,UAC9D,gBAAkB,EAAA,QAAA;AAAA,UAClB,OAAO,IAAK,CAAA,QAAA;AAAA,YACV,qBAAA;AAAA,YACA,sBAAuB,CAAA;AAAA;AACzB,SACF;AAAA,OACD,CAAA;AAAA,KACF,EACA,IAAK,EAAA;AAAA;AACV,EAEQ,QAAA,CACN,QACA,WACY,EAAA;AACZ,IAAI,IAAA,MAAA,CAAO,WAAW,CAAG,EAAA;AACvB,MAAO,OAAA,UAAA;AAAA,KACT,MAAA,IAAW,MAAO,CAAA,KAAA,GAAQ,CAAG,EAAA;AAC3B,MAAO,OAAA,OAAA;AAAA,KACT,MAAA,IAAW,MAAO,CAAA,OAAA,GAAU,CAAG,EAAA;AAC7B,MAAO,OAAA,SAAA;AAAA;AAET,IAAI,IAAA,MAAA,CAAO,WAAW,WAAa,EAAA;AACjC,MAAO,OAAA,QAAA;AAAA,KACT,MAAA,IACE,OAAO,MAAW,KAAA,WAAA,IAClB,OAAO,MAAS,GAAA,MAAA,CAAO,WAAW,WAClC,EAAA;AACA,MAAO,OAAA,QAAA;AAAA;AAGT,IAAO,OAAA,KAAA;AAAA;AAEX;;;;"}
1
+ {"version":3,"file":"api.esm.js","sources":["../src/api.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n createApiRef,\n DiscoveryApi,\n FetchApi,\n} from '@backstage/frontend-plugin-api';\nimport { QueryEvaluator } from './query';\nimport { Alert, Dashboard } from './types';\n\n/**\n * Interface for the Grafana API\n * @public\n */\nexport interface GrafanaApi {\n /**\n * Returns the found dashboards in Grafana with the defined query\n * @param query - The query used to list the dashboards\n */\n listDashboards(query: string): Promise<Dashboard[]>;\n /**\n * Returns a list of alerts found in Grafana that have any of the defined alert selectors\n * @param selectors - One or multiple alert selectors\n */\n alertsForSelector(selectors: string | string[]): Promise<Alert[]>;\n}\n\ninterface AggregatedAlertState {\n Normal: number;\n Pending: number;\n Alerting: number;\n NoData: number;\n Error: number;\n Invalid: number;\n}\n\ntype AlertState =\n | 'Normal'\n | 'Pending'\n | 'Alerting'\n | 'NoData'\n | 'Error'\n | 'n/a';\n\ninterface AlertInstance {\n labels: Record<string, string>;\n state: AlertState;\n}\n\ninterface AlertsData {\n data: { alerts: AlertInstance[] };\n}\n\ninterface AlertRuleGroupConfig {\n name: string;\n rules: AlertRule[];\n}\n\ninterface GrafanaAlert {\n id: number;\n panelId: number;\n name: string;\n state: string;\n url: string;\n}\n\ninterface UnifiedGrafanaAlert {\n uid: string;\n title: string;\n}\n\ninterface AlertRule {\n labels: Record<string, string>;\n grafana_alert: UnifiedGrafanaAlert;\n}\n\n/**\n * The grafana API reference\n * @public\n */\nexport const grafanaApiRef = createApiRef<GrafanaApi>({\n id: 'plugin.grafana.service',\n});\n\nexport type Options = {\n discoveryApi: DiscoveryApi;\n fetchApi: FetchApi;\n\n /**\n * Domain used by users to access Grafana web UI.\n * Example: https://monitoring.my-company.com/\n */\n domain: string;\n\n /**\n * Path to use for requests via the proxy, defaults to /grafana/api\n */\n proxyPath?: string;\n\n /**\n * Limit value to pass in Grafana Dashboard search query.\n */\n grafanaDashboardSearchLimit?: number;\n\n /**\n * Max pages of Grafana Dashboard search query to fetch.\n */\n grafanaDashboardMaxPages?: number;\n};\n\nconst DEFAULT_PROXY_PATH = '/grafana/api';\n// upstream default if no limit is specified.\nconst DEFAULT_DASHBOARDS_LIMIT: number = 1000;\nconst DEFAULT_PAGES_LIMIT: number = 1;\n// upstream limit: https://github.com/grafana/grafana/blob/2ee956192064343c73009ffe106178bf4e983844/pkg/api/search.go#L43\nconst UPSTREAM_DASHBOARDS_LIMIT_MAX: number = 5000;\n\nconst isSingleWord = (input: string): boolean => {\n return input.match(/^[\\w-]+$/g) !== null;\n};\n\nclass Client {\n private readonly discoveryApi: DiscoveryApi;\n private readonly fetchApi: FetchApi;\n private readonly proxyPath: string;\n private readonly queryEvaluator: QueryEvaluator;\n private readonly grafanaDashboardSearchLimit: number;\n private readonly grafanaDashboardMaxPages: number;\n\n constructor(opts: Options) {\n this.discoveryApi = opts.discoveryApi;\n this.fetchApi = opts.fetchApi;\n this.proxyPath = opts.proxyPath ?? DEFAULT_PROXY_PATH;\n this.queryEvaluator = new QueryEvaluator();\n this.grafanaDashboardSearchLimit = Math.min(\n opts.grafanaDashboardSearchLimit ?? DEFAULT_DASHBOARDS_LIMIT,\n UPSTREAM_DASHBOARDS_LIMIT_MAX,\n );\n this.grafanaDashboardMaxPages =\n opts.grafanaDashboardMaxPages ?? DEFAULT_PAGES_LIMIT;\n }\n\n public async fetch<T = any>(input: string, init?: RequestInit): Promise<T> {\n const apiUrl = await this.apiUrl();\n const resp = await this.fetchApi.fetch(`${apiUrl}${input}`, init);\n if (!resp.ok) {\n throw new Error(`Request failed with ${resp.status} ${resp.statusText}`);\n }\n\n return await resp.json();\n }\n\n async listDashboards(domain: string, query: string): Promise<Dashboard[]> {\n if (isSingleWord(query)) {\n return this.dashboardsByTag(domain, query);\n }\n\n return this.dashboardsForQuery(domain, query);\n }\n\n private async fetchSomeDashboards(options: {\n domain: string;\n page: number;\n limit: number;\n tag?: string;\n }): Promise<Dashboard[]> {\n const query = `/api/search?type=dash-db&limit=${options.limit}&page=${\n options.page\n }${options.tag !== undefined ? `&tag=${options.tag}` : ''}`;\n const response = await this.fetch<Dashboard[]>(query);\n return this.fullyQualifiedDashboardMetadata(options.domain, response);\n }\n\n // Grafana Search API does not have pagination metadata in the response body or headers\n // so we have to guess if we are at the end based on number of items in the result\n // https://grafana.com/docs/grafana/latest/developers/http_api/folder_dashboard_search/\n // The API also does not use continuation tokens, so there is no guarantee\n // that dashboards have not been added or deleted since listing the previous\n // page.\n private async fetchAllDashboards(options: {\n domain: string;\n tag?: string;\n }): Promise<Dashboard[]> {\n let page: number = 0;\n const allDashboards: Dashboard[] = [];\n let more: boolean = true;\n do {\n const dashboards: Dashboard[] = await this.fetchSomeDashboards({\n domain: options.domain,\n page: page++,\n limit: this.grafanaDashboardSearchLimit,\n tag: options.tag,\n });\n allDashboards.push(...dashboards);\n // pages limit exists to prevent accidental infinite loops from Grafana\n more =\n dashboards.length >= this.grafanaDashboardSearchLimit &&\n page < this.grafanaDashboardMaxPages;\n } while (more);\n return allDashboards;\n }\n\n async dashboardsForQuery(\n domain: string,\n query: string,\n ): Promise<Dashboard[]> {\n const parsedQuery = this.queryEvaluator.parse(query);\n const allDashboards = await this.fetchAllDashboards({ domain: domain });\n return allDashboards.filter(dashboard => {\n return this.queryEvaluator.evaluate(parsedQuery, dashboard) === true;\n });\n }\n\n async dashboardsByTag(domain: string, tag: string): Promise<Dashboard[]> {\n return this.fetchAllDashboards({ domain: domain, tag: tag });\n }\n\n private fullyQualifiedDashboardMetadata(\n domain: string,\n dashboards: Dashboard[],\n ): Dashboard[] {\n return dashboards.map(dashboard => ({\n ...dashboard,\n url: domain + dashboard.url,\n folderTitle: dashboard.folderTitle ?? '',\n folderUrl: domain + dashboard.folderUrl,\n }));\n }\n\n private async apiUrl() {\n const proxyUrl = await this.discoveryApi.getBaseUrl('proxy');\n return proxyUrl + this.proxyPath;\n }\n}\n\nexport class GrafanaApiClient implements GrafanaApi {\n private readonly domain: string;\n private readonly client: Client;\n\n constructor(opts: Options) {\n this.domain = opts.domain;\n this.client = new Client(opts);\n }\n\n async listDashboards(query: string): Promise<Dashboard[]> {\n return this.client.listDashboards(this.domain, query);\n }\n\n async alertsForSelector(dashboardTag: string): Promise<Alert[]> {\n const response = await this.client.fetch<GrafanaAlert[]>(\n `/api/alerts?dashboardTag=${dashboardTag}`,\n );\n\n return response.map(alert => ({\n name: alert.name,\n state: alert.state,\n matchingSelector: dashboardTag,\n url: `${this.domain}${alert.url}?panelId=${alert.panelId}&fullscreen&refresh=30s`,\n }));\n }\n}\n\nexport class UnifiedAlertingGrafanaApiClient implements GrafanaApi {\n private readonly domain: string;\n private readonly client: Client;\n\n constructor(opts: Options) {\n this.domain = opts.domain;\n this.client = new Client(opts);\n }\n\n async listDashboards(query: string): Promise<Dashboard[]> {\n return this.client.listDashboards(this.domain, query);\n }\n\n async alertsForSelector(selectors: string | string[]): Promise<Alert[]> {\n let labelSelectors: string[] = [];\n if (typeof selectors === 'string') {\n labelSelectors = [selectors];\n } else {\n labelSelectors = selectors;\n }\n\n const rulesResponse = await this.client.fetch<\n Record<string, AlertRuleGroupConfig[]>\n >('/api/ruler/grafana/api/v1/rules');\n const rules = Object.values(rulesResponse)\n .flat()\n .map(ruleGroup => ruleGroup.rules)\n .flat();\n const alertsResponse = await this.client.fetch<AlertsData>(\n '/api/prometheus/grafana/api/v1/alerts',\n );\n\n return labelSelectors\n .map(selector => {\n const [label, labelValue] = selector.split('=');\n\n const matchingRules = rules.filter(\n rule => rule.labels && rule.labels[label] === labelValue,\n );\n const alertInstances = alertsResponse.data.alerts.filter(\n alertInstance => alertInstance.labels[label] === labelValue,\n );\n\n return matchingRules.map(rule => {\n const matchingAlertInstances = alertInstances.filter(\n alertInstance =>\n alertInstance.labels.alertname === rule.grafana_alert.title,\n );\n\n const aggregatedAlertStates: AggregatedAlertState =\n matchingAlertInstances.reduce(\n (previous, alert) => {\n switch (alert.state) {\n case 'Normal':\n previous.Normal += 1;\n break;\n case 'Pending':\n previous.Pending += 1;\n break;\n case 'Alerting':\n previous.Alerting += 1;\n break;\n case 'NoData':\n previous.NoData += 1;\n break;\n case 'Error':\n previous.Error += 1;\n break;\n default:\n previous.Invalid += 1;\n }\n\n return previous;\n },\n {\n Normal: 0,\n Pending: 0,\n Alerting: 0,\n NoData: 0,\n Error: 0,\n Invalid: 0,\n },\n );\n\n return {\n name: rule.grafana_alert.title,\n url: `${this.domain}/alerting/grafana/${rule.grafana_alert.uid}/view`,\n matchingSelector: selector,\n state: this.getState(\n aggregatedAlertStates,\n matchingAlertInstances.length,\n ),\n };\n });\n })\n .flat();\n }\n\n private getState(\n states: AggregatedAlertState,\n totalAlerts: number,\n ): AlertState {\n if (states.Alerting > 0) {\n return 'Alerting';\n } else if (states.Error > 0) {\n return 'Error';\n } else if (states.Pending > 0) {\n return 'Pending';\n }\n if (states.NoData === totalAlerts) {\n return 'NoData';\n } else if (\n states.Normal === totalAlerts ||\n states.Normal + states.NoData === totalAlerts\n ) {\n return 'Normal';\n }\n\n return 'n/a';\n }\n}\n"],"names":[],"mappings":";;;AA8FO,MAAM,gBAAgB,YAAyB,CAAA;AAAA,EACpD,EAAI,EAAA;AACN,CAAC;AA4BD,MAAM,kBAAqB,GAAA,cAAA;AAE3B,MAAM,wBAAmC,GAAA,GAAA;AACzC,MAAM,mBAA8B,GAAA,CAAA;AAEpC,MAAM,6BAAwC,GAAA,GAAA;AAE9C,MAAM,YAAA,GAAe,CAAC,KAA2B,KAAA;AAC/C,EAAO,OAAA,KAAA,CAAM,KAAM,CAAA,WAAW,CAAM,KAAA,IAAA;AACtC,CAAA;AAEA,MAAM,MAAO,CAAA;AAAA,EACM,YAAA;AAAA,EACA,QAAA;AAAA,EACA,SAAA;AAAA,EACA,cAAA;AAAA,EACA,2BAAA;AAAA,EACA,wBAAA;AAAA,EAEjB,YAAY,IAAe,EAAA;AACzB,IAAA,IAAA,CAAK,eAAe,IAAK,CAAA,YAAA;AACzB,IAAA,IAAA,CAAK,WAAW,IAAK,CAAA,QAAA;AACrB,IAAK,IAAA,CAAA,SAAA,GAAY,KAAK,SAAa,IAAA,kBAAA;AACnC,IAAK,IAAA,CAAA,cAAA,GAAiB,IAAI,cAAe,EAAA;AACzC,IAAA,IAAA,CAAK,8BAA8B,IAAK,CAAA,GAAA;AAAA,MACtC,KAAK,2BAA+B,IAAA,wBAAA;AAAA,MACpC;AAAA,KACF;AACA,IAAK,IAAA,CAAA,wBAAA,GACH,KAAK,wBAA4B,IAAA,mBAAA;AAAA;AACrC,EAEA,MAAa,KAAe,CAAA,KAAA,EAAe,IAAgC,EAAA;AACzE,IAAM,MAAA,MAAA,GAAS,MAAM,IAAA,CAAK,MAAO,EAAA;AACjC,IAAM,MAAA,IAAA,GAAO,MAAM,IAAA,CAAK,QAAS,CAAA,KAAA,CAAM,GAAG,MAAM,CAAA,EAAG,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA;AAChE,IAAI,IAAA,CAAC,KAAK,EAAI,EAAA;AACZ,MAAM,MAAA,IAAI,MAAM,CAAuB,oBAAA,EAAA,IAAA,CAAK,MAAM,CAAI,CAAA,EAAA,IAAA,CAAK,UAAU,CAAE,CAAA,CAAA;AAAA;AAGzE,IAAO,OAAA,MAAM,KAAK,IAAK,EAAA;AAAA;AACzB,EAEA,MAAM,cAAe,CAAA,MAAA,EAAgB,KAAqC,EAAA;AACxE,IAAI,IAAA,YAAA,CAAa,KAAK,CAAG,EAAA;AACvB,MAAO,OAAA,IAAA,CAAK,eAAgB,CAAA,MAAA,EAAQ,KAAK,CAAA;AAAA;AAG3C,IAAO,OAAA,IAAA,CAAK,kBAAmB,CAAA,MAAA,EAAQ,KAAK,CAAA;AAAA;AAC9C,EAEA,MAAc,oBAAoB,OAKT,EAAA;AACvB,IAAA,MAAM,KAAQ,GAAA,CAAA,+BAAA,EAAkC,OAAQ,CAAA,KAAK,SAC3D,OAAQ,CAAA,IACV,CAAG,EAAA,OAAA,CAAQ,QAAQ,KAAY,CAAA,GAAA,CAAA,KAAA,EAAQ,OAAQ,CAAA,GAAG,KAAK,EAAE,CAAA,CAAA;AACzD,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,KAAA,CAAmB,KAAK,CAAA;AACpD,IAAA,OAAO,IAAK,CAAA,+BAAA,CAAgC,OAAQ,CAAA,MAAA,EAAQ,QAAQ,CAAA;AAAA;AACtE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAc,mBAAmB,OAGR,EAAA;AACvB,IAAA,IAAI,IAAe,GAAA,CAAA;AACnB,IAAA,MAAM,gBAA6B,EAAC;AACpC,IAAA,IAAI,IAAgB,GAAA,IAAA;AACpB,IAAG,GAAA;AACD,MAAM,MAAA,UAAA,GAA0B,MAAM,IAAA,CAAK,mBAAoB,CAAA;AAAA,QAC7D,QAAQ,OAAQ,CAAA,MAAA;AAAA,QAChB,IAAM,EAAA,IAAA,EAAA;AAAA,QACN,OAAO,IAAK,CAAA,2BAAA;AAAA,QACZ,KAAK,OAAQ,CAAA;AAAA,OACd,CAAA;AACD,MAAc,aAAA,CAAA,IAAA,CAAK,GAAG,UAAU,CAAA;AAEhC,MAAA,IAAA,GACE,UAAW,CAAA,MAAA,IAAU,IAAK,CAAA,2BAAA,IAC1B,OAAO,IAAK,CAAA,wBAAA;AAAA,KACP,QAAA,IAAA;AACT,IAAO,OAAA,aAAA;AAAA;AACT,EAEA,MAAM,kBACJ,CAAA,MAAA,EACA,KACsB,EAAA;AACtB,IAAA,MAAM,WAAc,GAAA,IAAA,CAAK,cAAe,CAAA,KAAA,CAAM,KAAK,CAAA;AACnD,IAAA,MAAM,gBAAgB,MAAM,IAAA,CAAK,kBAAmB,CAAA,EAAE,QAAgB,CAAA;AACtE,IAAO,OAAA,aAAA,CAAc,OAAO,CAAa,SAAA,KAAA;AACvC,MAAA,OAAO,IAAK,CAAA,cAAA,CAAe,QAAS,CAAA,WAAA,EAAa,SAAS,CAAM,KAAA,IAAA;AAAA,KACjE,CAAA;AAAA;AACH,EAEA,MAAM,eAAgB,CAAA,MAAA,EAAgB,GAAmC,EAAA;AACvE,IAAA,OAAO,IAAK,CAAA,kBAAA,CAAmB,EAAE,MAAA,EAAgB,KAAU,CAAA;AAAA;AAC7D,EAEQ,+BAAA,CACN,QACA,UACa,EAAA;AACb,IAAO,OAAA,UAAA,CAAW,IAAI,CAAc,SAAA,MAAA;AAAA,MAClC,GAAG,SAAA;AAAA,MACH,GAAA,EAAK,SAAS,SAAU,CAAA,GAAA;AAAA,MACxB,WAAA,EAAa,UAAU,WAAe,IAAA,EAAA;AAAA,MACtC,SAAA,EAAW,SAAS,SAAU,CAAA;AAAA,KAC9B,CAAA,CAAA;AAAA;AACJ,EAEA,MAAc,MAAS,GAAA;AACrB,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,WAAW,OAAO,CAAA;AAC3D,IAAA,OAAO,WAAW,IAAK,CAAA,SAAA;AAAA;AAE3B;AAEO,MAAM,gBAAuC,CAAA;AAAA,EACjC,MAAA;AAAA,EACA,MAAA;AAAA,EAEjB,YAAY,IAAe,EAAA;AACzB,IAAA,IAAA,CAAK,SAAS,IAAK,CAAA,MAAA;AACnB,IAAK,IAAA,CAAA,MAAA,GAAS,IAAI,MAAA,CAAO,IAAI,CAAA;AAAA;AAC/B,EAEA,MAAM,eAAe,KAAqC,EAAA;AACxD,IAAA,OAAO,IAAK,CAAA,MAAA,CAAO,cAAe,CAAA,IAAA,CAAK,QAAQ,KAAK,CAAA;AAAA;AACtD,EAEA,MAAM,kBAAkB,YAAwC,EAAA;AAC9D,IAAM,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACjC,4BAA4B,YAAY,CAAA;AAAA,KAC1C;AAEA,IAAO,OAAA,QAAA,CAAS,IAAI,CAAU,KAAA,MAAA;AAAA,MAC5B,MAAM,KAAM,CAAA,IAAA;AAAA,MACZ,OAAO,KAAM,CAAA,KAAA;AAAA,MACb,gBAAkB,EAAA,YAAA;AAAA,MAClB,GAAA,EAAK,GAAG,IAAK,CAAA,MAAM,GAAG,KAAM,CAAA,GAAG,CAAY,SAAA,EAAA,KAAA,CAAM,OAAO,CAAA,uBAAA;AAAA,KACxD,CAAA,CAAA;AAAA;AAEN;AAEO,MAAM,+BAAsD,CAAA;AAAA,EAChD,MAAA;AAAA,EACA,MAAA;AAAA,EAEjB,YAAY,IAAe,EAAA;AACzB,IAAA,IAAA,CAAK,SAAS,IAAK,CAAA,MAAA;AACnB,IAAK,IAAA,CAAA,MAAA,GAAS,IAAI,MAAA,CAAO,IAAI,CAAA;AAAA;AAC/B,EAEA,MAAM,eAAe,KAAqC,EAAA;AACxD,IAAA,OAAO,IAAK,CAAA,MAAA,CAAO,cAAe,CAAA,IAAA,CAAK,QAAQ,KAAK,CAAA;AAAA;AACtD,EAEA,MAAM,kBAAkB,SAAgD,EAAA;AACtE,IAAA,IAAI,iBAA2B,EAAC;AAChC,IAAI,IAAA,OAAO,cAAc,QAAU,EAAA;AACjC,MAAA,cAAA,GAAiB,CAAC,SAAS,CAAA;AAAA,KACtB,MAAA;AACL,MAAiB,cAAA,GAAA,SAAA;AAAA;AAGnB,IAAA,MAAM,aAAgB,GAAA,MAAM,IAAK,CAAA,MAAA,CAAO,MAEtC,iCAAiC,CAAA;AACnC,IAAA,MAAM,KAAQ,GAAA,MAAA,CAAO,MAAO,CAAA,aAAa,CACtC,CAAA,IAAA,EACA,CAAA,GAAA,CAAI,CAAa,SAAA,KAAA,SAAA,CAAU,KAAK,CAAA,CAChC,IAAK,EAAA;AACR,IAAM,MAAA,cAAA,GAAiB,MAAM,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACvC;AAAA,KACF;AAEA,IAAO,OAAA,cAAA,CACJ,IAAI,CAAY,QAAA,KAAA;AACf,MAAA,MAAM,CAAC,KAAO,EAAA,UAAU,CAAI,GAAA,QAAA,CAAS,MAAM,GAAG,CAAA;AAE9C,MAAA,MAAM,gBAAgB,KAAM,CAAA,MAAA;AAAA,QAC1B,UAAQ,IAAK,CAAA,MAAA,IAAU,IAAK,CAAA,MAAA,CAAO,KAAK,CAAM,KAAA;AAAA,OAChD;AACA,MAAM,MAAA,cAAA,GAAiB,cAAe,CAAA,IAAA,CAAK,MAAO,CAAA,MAAA;AAAA,QAChD,CAAiB,aAAA,KAAA,aAAA,CAAc,MAAO,CAAA,KAAK,CAAM,KAAA;AAAA,OACnD;AAEA,MAAO,OAAA,aAAA,CAAc,IAAI,CAAQ,IAAA,KAAA;AAC/B,QAAA,MAAM,yBAAyB,cAAe,CAAA,MAAA;AAAA,UAC5C,CACE,aAAA,KAAA,aAAA,CAAc,MAAO,CAAA,SAAA,KAAc,KAAK,aAAc,CAAA;AAAA,SAC1D;AAEA,QAAA,MAAM,wBACJ,sBAAuB,CAAA,MAAA;AAAA,UACrB,CAAC,UAAU,KAAU,KAAA;AACnB,YAAA,QAAQ,MAAM,KAAO;AAAA,cACnB,KAAK,QAAA;AACH,gBAAA,QAAA,CAAS,MAAU,IAAA,CAAA;AACnB,gBAAA;AAAA,cACF,KAAK,SAAA;AACH,gBAAA,QAAA,CAAS,OAAW,IAAA,CAAA;AACpB,gBAAA;AAAA,cACF,KAAK,UAAA;AACH,gBAAA,QAAA,CAAS,QAAY,IAAA,CAAA;AACrB,gBAAA;AAAA,cACF,KAAK,QAAA;AACH,gBAAA,QAAA,CAAS,MAAU,IAAA,CAAA;AACnB,gBAAA;AAAA,cACF,KAAK,OAAA;AACH,gBAAA,QAAA,CAAS,KAAS,IAAA,CAAA;AAClB,gBAAA;AAAA,cACF;AACE,gBAAA,QAAA,CAAS,OAAW,IAAA,CAAA;AAAA;AAGxB,YAAO,OAAA,QAAA;AAAA,WACT;AAAA,UACA;AAAA,YACE,MAAQ,EAAA,CAAA;AAAA,YACR,OAAS,EAAA,CAAA;AAAA,YACT,QAAU,EAAA,CAAA;AAAA,YACV,MAAQ,EAAA,CAAA;AAAA,YACR,KAAO,EAAA,CAAA;AAAA,YACP,OAAS,EAAA;AAAA;AACX,SACF;AAEF,QAAO,OAAA;AAAA,UACL,IAAA,EAAM,KAAK,aAAc,CAAA,KAAA;AAAA,UACzB,KAAK,CAAG,EAAA,IAAA,CAAK,MAAM,CAAqB,kBAAA,EAAA,IAAA,CAAK,cAAc,GAAG,CAAA,KAAA,CAAA;AAAA,UAC9D,gBAAkB,EAAA,QAAA;AAAA,UAClB,OAAO,IAAK,CAAA,QAAA;AAAA,YACV,qBAAA;AAAA,YACA,sBAAuB,CAAA;AAAA;AACzB,SACF;AAAA,OACD,CAAA;AAAA,KACF,EACA,IAAK,EAAA;AAAA;AACV,EAEQ,QAAA,CACN,QACA,WACY,EAAA;AACZ,IAAI,IAAA,MAAA,CAAO,WAAW,CAAG,EAAA;AACvB,MAAO,OAAA,UAAA;AAAA,KACT,MAAA,IAAW,MAAO,CAAA,KAAA,GAAQ,CAAG,EAAA;AAC3B,MAAO,OAAA,OAAA;AAAA,KACT,MAAA,IAAW,MAAO,CAAA,OAAA,GAAU,CAAG,EAAA;AAC7B,MAAO,OAAA,SAAA;AAAA;AAET,IAAI,IAAA,MAAA,CAAO,WAAW,WAAa,EAAA;AACjC,MAAO,OAAA,QAAA;AAAA,KACT,MAAA,IACE,OAAO,MAAW,KAAA,WAAA,IAClB,OAAO,MAAS,GAAA,MAAA,CAAO,WAAW,WAClC,EAAA;AACA,MAAO,OAAA,QAAA;AAAA;AAGT,IAAO,OAAA,KAAA;AAAA;AAEX;;;;"}
@@ -18,14 +18,26 @@ const grafanaPlugin = createPlugin({
18
18
  discoveryApi,
19
19
  fetchApi,
20
20
  domain: configApi.getString("grafana.domain"),
21
- proxyPath: configApi.getOptionalString("grafana.proxyPath")
21
+ proxyPath: configApi.getOptionalString("grafana.proxyPath"),
22
+ grafanaDashboardSearchLimit: configApi.getOptionalNumber(
23
+ "grafana.grafanaDashboardSearchLimit"
24
+ ),
25
+ grafanaDashboardMaxPages: configApi.getOptionalNumber(
26
+ "grafana.grafanaDashboardMaxPages"
27
+ )
22
28
  });
23
29
  }
24
30
  return new UnifiedAlertingGrafanaApiClient({
25
31
  discoveryApi,
26
32
  fetchApi,
27
33
  domain: configApi.getString("grafana.domain"),
28
- proxyPath: configApi.getOptionalString("grafana.proxyPath")
34
+ proxyPath: configApi.getOptionalString("grafana.proxyPath"),
35
+ grafanaDashboardSearchLimit: configApi.getOptionalNumber(
36
+ "grafana.grafanaDashboardSearchLimit"
37
+ ),
38
+ grafanaDashboardMaxPages: configApi.getOptionalNumber(
39
+ "grafana.grafanaDashboardMaxPages"
40
+ )
29
41
  });
30
42
  }
31
43
  })
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.esm.js","sources":["../src/plugin.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n configApiRef,\n createApiFactory,\n createComponentExtension,\n createPlugin,\n discoveryApiRef,\n fetchApiRef,\n} from '@backstage/core-plugin-api';\nimport {\n UnifiedAlertingGrafanaApiClient,\n grafanaApiRef,\n GrafanaApiClient,\n} from './api';\n\n/**\n * The grafana plugin.\n * @public\n */\nexport const grafanaPlugin = createPlugin({\n id: 'grafana',\n apis: [\n createApiFactory({\n api: grafanaApiRef,\n deps: {\n discoveryApi: discoveryApiRef,\n fetchApi: fetchApiRef,\n configApi: configApiRef,\n },\n factory: ({ discoveryApi, fetchApi, configApi }) => {\n const unifiedAlertingEnabled =\n configApi.getOptionalBoolean('grafana.unifiedAlerting') || false;\n\n if (!unifiedAlertingEnabled) {\n return new GrafanaApiClient({\n discoveryApi,\n fetchApi,\n domain: configApi.getString('grafana.domain'),\n proxyPath: configApi.getOptionalString('grafana.proxyPath'),\n });\n }\n\n return new UnifiedAlertingGrafanaApiClient({\n discoveryApi,\n fetchApi,\n domain: configApi.getString('grafana.domain'),\n proxyPath: configApi.getOptionalString('grafana.proxyPath'),\n });\n },\n }),\n ],\n});\n\n/**\n * Component which displays the grafana dashboards found for an entity\n * @public\n */\nexport const EntityGrafanaDashboardsCard = grafanaPlugin.provide(\n createComponentExtension({\n name: 'EntityGrafanaDashboardsCard',\n component: {\n lazy: () =>\n import('./components/DashboardsCard').then(m => m.DashboardsCard),\n },\n }),\n);\n\n/**\n * Component which displays the grafana alerts found for an entity\n * @public\n */\nexport const EntityGrafanaAlertsCard = grafanaPlugin.provide(\n createComponentExtension({\n name: 'EntityGrafanaAlertsCard',\n component: {\n lazy: () => import('./components/AlertsCard').then(m => m.AlertsCard),\n },\n }),\n);\n\n/**\n * Component which displays the defined grafana dashboard for an entity\n * @public\n */\nexport const EntityOverviewDashboardViewer = grafanaPlugin.provide(\n createComponentExtension({\n name: 'EntityOverviewDashboardViewer',\n component: {\n lazy: () =>\n import('./components/DashboardViewer').then(\n m => m.EntityDashboardViewer,\n ),\n },\n }),\n);\n"],"names":[],"mappings":";;;AAkCO,MAAM,gBAAgB,YAAa,CAAA;AAAA,EACxC,EAAI,EAAA,SAAA;AAAA,EACJ,IAAM,EAAA;AAAA,IACJ,gBAAiB,CAAA;AAAA,MACf,GAAK,EAAA,aAAA;AAAA,MACL,IAAM,EAAA;AAAA,QACJ,YAAc,EAAA,eAAA;AAAA,QACd,QAAU,EAAA,WAAA;AAAA,QACV,SAAW,EAAA;AAAA,OACb;AAAA,MACA,SAAS,CAAC,EAAE,YAAc,EAAA,QAAA,EAAU,WAAgB,KAAA;AAClD,QAAA,MAAM,sBACJ,GAAA,SAAA,CAAU,kBAAmB,CAAA,yBAAyB,CAAK,IAAA,KAAA;AAE7D,QAAA,IAAI,CAAC,sBAAwB,EAAA;AAC3B,UAAA,OAAO,IAAI,gBAAiB,CAAA;AAAA,YAC1B,YAAA;AAAA,YACA,QAAA;AAAA,YACA,MAAA,EAAQ,SAAU,CAAA,SAAA,CAAU,gBAAgB,CAAA;AAAA,YAC5C,SAAA,EAAW,SAAU,CAAA,iBAAA,CAAkB,mBAAmB;AAAA,WAC3D,CAAA;AAAA;AAGH,QAAA,OAAO,IAAI,+BAAgC,CAAA;AAAA,UACzC,YAAA;AAAA,UACA,QAAA;AAAA,UACA,MAAA,EAAQ,SAAU,CAAA,SAAA,CAAU,gBAAgB,CAAA;AAAA,UAC5C,SAAA,EAAW,SAAU,CAAA,iBAAA,CAAkB,mBAAmB;AAAA,SAC3D,CAAA;AAAA;AACH,KACD;AAAA;AAEL,CAAC;AAMM,MAAM,8BAA8B,aAAc,CAAA,OAAA;AAAA,EACvD,wBAAyB,CAAA;AAAA,IACvB,IAAM,EAAA,6BAAA;AAAA,IACN,SAAW,EAAA;AAAA,MACT,IAAA,EAAM,MACJ,OAAO,0CAA6B,EAAE,IAAK,CAAA,CAAA,CAAA,KAAK,EAAE,cAAc;AAAA;AACpE,GACD;AACH;AAMO,MAAM,0BAA0B,aAAc,CAAA,OAAA;AAAA,EACnD,wBAAyB,CAAA;AAAA,IACvB,IAAM,EAAA,yBAAA;AAAA,IACN,SAAW,EAAA;AAAA,MACT,IAAA,EAAM,MAAM,OAAO,sCAAyB,EAAE,IAAK,CAAA,CAAA,CAAA,KAAK,EAAE,UAAU;AAAA;AACtE,GACD;AACH;AAMO,MAAM,gCAAgC,aAAc,CAAA,OAAA;AAAA,EACzD,wBAAyB,CAAA;AAAA,IACvB,IAAM,EAAA,+BAAA;AAAA,IACN,SAAW,EAAA;AAAA,MACT,IAAM,EAAA,MACJ,OAAO,2CAA8B,CAAE,CAAA,IAAA;AAAA,QACrC,OAAK,CAAE,CAAA;AAAA;AACT;AACJ,GACD;AACH;;;;"}
1
+ {"version":3,"file":"plugin.esm.js","sources":["../src/plugin.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n configApiRef,\n createApiFactory,\n createComponentExtension,\n createPlugin,\n discoveryApiRef,\n fetchApiRef,\n} from '@backstage/core-plugin-api';\nimport {\n UnifiedAlertingGrafanaApiClient,\n grafanaApiRef,\n GrafanaApiClient,\n} from './api';\n\n/**\n * The grafana plugin.\n * @public\n */\nexport const grafanaPlugin = createPlugin({\n id: 'grafana',\n apis: [\n createApiFactory({\n api: grafanaApiRef,\n deps: {\n discoveryApi: discoveryApiRef,\n fetchApi: fetchApiRef,\n configApi: configApiRef,\n },\n factory: ({ discoveryApi, fetchApi, configApi }) => {\n const unifiedAlertingEnabled =\n configApi.getOptionalBoolean('grafana.unifiedAlerting') || false;\n\n if (!unifiedAlertingEnabled) {\n return new GrafanaApiClient({\n discoveryApi,\n fetchApi,\n domain: configApi.getString('grafana.domain'),\n proxyPath: configApi.getOptionalString('grafana.proxyPath'),\n grafanaDashboardSearchLimit: configApi.getOptionalNumber(\n 'grafana.grafanaDashboardSearchLimit',\n ),\n grafanaDashboardMaxPages: configApi.getOptionalNumber(\n 'grafana.grafanaDashboardMaxPages',\n ),\n });\n }\n\n return new UnifiedAlertingGrafanaApiClient({\n discoveryApi,\n fetchApi,\n domain: configApi.getString('grafana.domain'),\n proxyPath: configApi.getOptionalString('grafana.proxyPath'),\n grafanaDashboardSearchLimit: configApi.getOptionalNumber(\n 'grafana.grafanaDashboardSearchLimit',\n ),\n grafanaDashboardMaxPages: configApi.getOptionalNumber(\n 'grafana.grafanaDashboardMaxPages',\n ),\n });\n },\n }),\n ],\n});\n\n/**\n * Component which displays the grafana dashboards found for an entity\n * @public\n */\nexport const EntityGrafanaDashboardsCard = grafanaPlugin.provide(\n createComponentExtension({\n name: 'EntityGrafanaDashboardsCard',\n component: {\n lazy: () =>\n import('./components/DashboardsCard').then(m => m.DashboardsCard),\n },\n }),\n);\n\n/**\n * Component which displays the grafana alerts found for an entity\n * @public\n */\nexport const EntityGrafanaAlertsCard = grafanaPlugin.provide(\n createComponentExtension({\n name: 'EntityGrafanaAlertsCard',\n component: {\n lazy: () => import('./components/AlertsCard').then(m => m.AlertsCard),\n },\n }),\n);\n\n/**\n * Component which displays the defined grafana dashboard for an entity\n * @public\n */\nexport const EntityOverviewDashboardViewer = grafanaPlugin.provide(\n createComponentExtension({\n name: 'EntityOverviewDashboardViewer',\n component: {\n lazy: () =>\n import('./components/DashboardViewer').then(\n m => m.EntityDashboardViewer,\n ),\n },\n }),\n);\n"],"names":[],"mappings":";;;AAkCO,MAAM,gBAAgB,YAAa,CAAA;AAAA,EACxC,EAAI,EAAA,SAAA;AAAA,EACJ,IAAM,EAAA;AAAA,IACJ,gBAAiB,CAAA;AAAA,MACf,GAAK,EAAA,aAAA;AAAA,MACL,IAAM,EAAA;AAAA,QACJ,YAAc,EAAA,eAAA;AAAA,QACd,QAAU,EAAA,WAAA;AAAA,QACV,SAAW,EAAA;AAAA,OACb;AAAA,MACA,SAAS,CAAC,EAAE,YAAc,EAAA,QAAA,EAAU,WAAgB,KAAA;AAClD,QAAA,MAAM,sBACJ,GAAA,SAAA,CAAU,kBAAmB,CAAA,yBAAyB,CAAK,IAAA,KAAA;AAE7D,QAAA,IAAI,CAAC,sBAAwB,EAAA;AAC3B,UAAA,OAAO,IAAI,gBAAiB,CAAA;AAAA,YAC1B,YAAA;AAAA,YACA,QAAA;AAAA,YACA,MAAA,EAAQ,SAAU,CAAA,SAAA,CAAU,gBAAgB,CAAA;AAAA,YAC5C,SAAA,EAAW,SAAU,CAAA,iBAAA,CAAkB,mBAAmB,CAAA;AAAA,YAC1D,6BAA6B,SAAU,CAAA,iBAAA;AAAA,cACrC;AAAA,aACF;AAAA,YACA,0BAA0B,SAAU,CAAA,iBAAA;AAAA,cAClC;AAAA;AACF,WACD,CAAA;AAAA;AAGH,QAAA,OAAO,IAAI,+BAAgC,CAAA;AAAA,UACzC,YAAA;AAAA,UACA,QAAA;AAAA,UACA,MAAA,EAAQ,SAAU,CAAA,SAAA,CAAU,gBAAgB,CAAA;AAAA,UAC5C,SAAA,EAAW,SAAU,CAAA,iBAAA,CAAkB,mBAAmB,CAAA;AAAA,UAC1D,6BAA6B,SAAU,CAAA,iBAAA;AAAA,YACrC;AAAA,WACF;AAAA,UACA,0BAA0B,SAAU,CAAA,iBAAA;AAAA,YAClC;AAAA;AACF,SACD,CAAA;AAAA;AACH,KACD;AAAA;AAEL,CAAC;AAMM,MAAM,8BAA8B,aAAc,CAAA,OAAA;AAAA,EACvD,wBAAyB,CAAA;AAAA,IACvB,IAAM,EAAA,6BAAA;AAAA,IACN,SAAW,EAAA;AAAA,MACT,IAAA,EAAM,MACJ,OAAO,0CAA6B,EAAE,IAAK,CAAA,CAAA,CAAA,KAAK,EAAE,cAAc;AAAA;AACpE,GACD;AACH;AAMO,MAAM,0BAA0B,aAAc,CAAA,OAAA;AAAA,EACnD,wBAAyB,CAAA;AAAA,IACvB,IAAM,EAAA,yBAAA;AAAA,IACN,SAAW,EAAA;AAAA,MACT,IAAA,EAAM,MAAM,OAAO,sCAAyB,EAAE,IAAK,CAAA,CAAA,CAAA,KAAK,EAAE,UAAU;AAAA;AACtE,GACD;AACH;AAMO,MAAM,gCAAgC,aAAc,CAAA,OAAA;AAAA,EACzD,wBAAyB,CAAA;AAAA,IACvB,IAAM,EAAA,+BAAA;AAAA,IACN,SAAW,EAAA;AAAA,MACT,IAAM,EAAA,MACJ,OAAO,2CAA8B,CAAE,CAAA,IAAA;AAAA,QACrC,OAAK,CAAE,CAAA;AAAA;AACT;AACJ,GACD;AACH;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage-community/plugin-grafana",
3
- "version": "0.10.1",
3
+ "version": "0.12.0",
4
4
  "description": "A Backstage backend plugin that integrates towards Grafana",
5
5
  "main": "./dist/index.esm.js",
6
6
  "types": "./dist/index.d.ts",
@@ -62,11 +62,11 @@
62
62
  "postpack": "backstage-cli package postpack"
63
63
  },
64
64
  "dependencies": {
65
- "@backstage/catalog-model": "^1.7.5",
66
- "@backstage/core-components": "^0.18.2",
67
- "@backstage/core-plugin-api": "^1.11.1",
68
- "@backstage/frontend-plugin-api": "^0.12.1",
69
- "@backstage/plugin-catalog-react": "^1.21.2",
65
+ "@backstage/catalog-model": "^1.7.6",
66
+ "@backstage/core-components": "^0.18.3",
67
+ "@backstage/core-plugin-api": "^1.12.0",
68
+ "@backstage/frontend-plugin-api": "^0.13.1",
69
+ "@backstage/plugin-catalog-react": "^1.21.3",
70
70
  "@material-ui/core": "^4.12.2",
71
71
  "@material-ui/lab": "4.0.0-alpha.61",
72
72
  "cross-fetch": "^4.0.0",
@@ -79,11 +79,11 @@
79
79
  "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
80
80
  },
81
81
  "devDependencies": {
82
- "@backstage/cli": "^0.34.4",
83
- "@backstage/core-app-api": "^1.19.1",
84
- "@backstage/dev-utils": "^1.1.15",
85
- "@backstage/frontend-test-utils": "^0.4.0",
86
- "@backstage/test-utils": "^1.7.12",
82
+ "@backstage/cli": "^0.34.5",
83
+ "@backstage/core-app-api": "^1.19.2",
84
+ "@backstage/dev-utils": "^1.1.17",
85
+ "@backstage/frontend-test-utils": "^0.4.1",
86
+ "@backstage/test-utils": "^1.7.13",
87
87
  "@testing-library/dom": "^10.0.0",
88
88
  "@testing-library/jest-dom": "^6.0.0",
89
89
  "@testing-library/react": "^15.0.0",