@backstage-community/plugin-grafana 0.10.0 → 0.11.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.
Files changed (4) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +27 -0
  3. package/dist/alpha.d.ts +4 -4
  4. package/package.json +11 -11
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @backstage-community/plugin-grafana
2
2
 
3
+ ## 0.11.0
4
+
5
+ ### Minor Changes
6
+
7
+ - bc8d728: Backstage version bump to v1.45.1
8
+
9
+ ## 0.10.1
10
+
11
+ ### Patch Changes
12
+
13
+ - 45ce0ac: Added documentation for the New Frontend System
14
+
3
15
  ## 0.10.0
4
16
 
5
17
  ### Minor Changes
package/README.md CHANGED
@@ -21,6 +21,33 @@ Entity dashboards card:
21
21
 
22
22
  ![Dashboards card](./docs/dashboards_card.png)
23
23
 
24
+ ## New Frontend System
25
+
26
+ ### Setup
27
+
28
+ If you're using [feature discovery](https://backstage.io/docs/frontend-system/architecture/app/#feature-discovery), the plugin should be automatically discovered and enabled. Otherwise, you can manually enable the plugin by adding it to your app:
29
+
30
+ ```tsx
31
+ // packages/app/src/App.tsx
32
+ import grafanaPlugin from '@backstage-community/plugin-grafana/alpha';
33
+
34
+ const app = createApp({
35
+ features: [
36
+ // ...
37
+ grafanaPlugin,
38
+ ],
39
+ });
40
+ ```
41
+
42
+ ### Extensions
43
+
44
+ The following extensions are available in the plugin:
45
+
46
+ - `api:grafana`
47
+ - `entity-card:grafana/dashboards`
48
+ - `entity-card:grafana/alerts`
49
+ - `entity-card:grafana/overview-dashboard`
50
+
24
51
  ## Special thanks & Disclaimer
25
52
 
26
53
  Thanks to K-Phoen for creating the grafana plugin found [here](https://github.com/K-Phoen/backstage-plugin-grafana). As an outcome
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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage-community/plugin-grafana",
3
- "version": "0.10.0",
3
+ "version": "0.11.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",