all: rename plugin IDs from pcp-*-* to performancecopilot-*-*

andreasgerstmayr · andreasgerstmayr · commit 70ca5cc307e2 · 2022-06-30T15:42:11.000+02:00
All nested plugins need to conform to the Grafana plugin naming
guidelines.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,13 +2,28 @@
 
 ## 5.0.0 (2022-06-30)
 
+### Important: Upgrade instructions
+Due to a breaking change (see section below), the following instructions are required before upgrading to grafana-pcp v5:
+* Go to Configuration -> Data sources and delete any PCP Redis, PCP Vector or PCP bpftrace data sources
+* Go to Configuration -> Plugins, select the Performance Co-Pilot app and click the Disable button
+* Go to Dashboards -> Browse and delete any remaining dashboards installed by grafana-pcp
+* If you installed grafana-pcp through the RPM package, open the `/etc/grafana/grafana.ini` configuration file and update the following setting: `allow_loading_unsigned_plugins = performancecopilot-pcp-app,performancecopilot-redis-datasource,performancecopilot-vector-datasource,performancecopilot-bpftrace-datasource,performancecopilot-flamegraph-panel,performancecopilot-breadcrumbs-panel,performancecopilot-troubleshooting-panel`
+* Perform the upgrade to grafana-pcp v5
+* Enable the plugin, setup all data sources and import all dashboards again
+* If you have custom dashboards, update all panels with the correct data source
+
+### Enhancements / Bug Fixes
+- **all**: rename plugin IDs from `pcp-*-*` to `performancecopilot-*-*`
 - **all**: remove `window.setGrafanaPcpLogLevel()` debug function
 - **chore**: remove deprecated `dependencies.grafanaVersion` field from plugin metadata
 
+### Breaking Changes
+- the internal plugin IDs of the data source and panel plugins were renamed from `pcp-X-Y` to `performancecopilot-X-Y`, for example `pcp-redis-datasource` was renamed to `performancecopilot-redis-datasource` in order to conform to the Grafana plugin id naming conventions
+
+
 ## 4.0.0 (2022-06-29)
 
 ### Enhancements / Bug Fixes
-
 - **redis, vector**: add buttons to disable rate conversation and time utilization conversation
 - **redis**: use LRU cache for series metadata
 - **redis**: fix label_names() function to return all label names if no parameter is specified (now the label name auto-completion in the query editor works again)
diff --git a/Makefile b/Makefile
@@ -107,13 +107,13 @@ test-ui-start-pod: ## Start PCP and Redis in a pod
 
 test-ui-start-grafana-dist: ## Start Grafana with grafana-pcp from the dist/ folder
 	podman run --pod grafana-pcp-tests --name grafana-pcp-tests-grafana -d --replace \
-		-e GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS="performancecopilot-pcp-app,pcp-redis-datasource,pcp-vector-datasource,pcp-bpftrace-datasource,pcp-flamegraph-panel,pcp-breadcrumbs-panel,pcp-troubleshooting-panel" \
+		-e GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS="performancecopilot-pcp-app,performancecopilot-redis-datasource,performancecopilot-vector-datasource,performancecopilot-bpftrace-datasource,performancecopilot-flamegraph-panel,performancecopilot-breadcrumbs-panel,performancecopilot-troubleshooting-panel" \
 		-v $$(pwd)/dist:/var/lib/grafana/plugins/performancecopilot-pcp-app \
 		$(GRAFANA_IMAGE)
 
 test-ui-start-grafana-build: ## Start Grafana with grafana-pcp from build/performancecopilot-pcp-app-*.zip
 	podman run --pod grafana-pcp-tests --name grafana-pcp-tests-grafana -d --replace \
-		-e GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS="performancecopilot-pcp-app,pcp-redis-datasource,pcp-vector-datasource,pcp-bpftrace-datasource,pcp-flamegraph-panel,pcp-breadcrumbs-panel,pcp-troubleshooting-panel" \
+		-e GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS="performancecopilot-pcp-app,performancecopilot-redis-datasource,performancecopilot-vector-datasource,performancecopilot-bpftrace-datasource,performancecopilot-flamegraph-panel,performancecopilot-breadcrumbs-panel,performancecopilot-troubleshooting-panel" \
 		-e GF_INSTALL_PLUGINS="/tmp/plugin.zip;performancecopilot-pcp-app" \
 		-v $$(pwd)/build/$$(basename build/performancecopilot-pcp-app-*.zip):/tmp/plugin.zip \
 		$(GRAFANA_IMAGE)
diff --git a/cypress/integration/checklist.spec.ts b/cypress/integration/checklist.spec.ts
@@ -3,7 +3,7 @@ describe('PCP Vector Checklist', () => {
         cy.task('grafana:reset');
         cy.login();
         cy.enablePlugin();
-        cy.addDatasource('pcp-vector-datasource', 'PCP Vector datasource');
+        cy.addDatasource('performancecopilot-vector-datasource', 'PCP Vector datasource');
     });
 
     beforeEach(() => {
diff --git a/cypress/integration/datasources/redis.spec.ts b/cypress/integration/datasources/redis.spec.ts
@@ -3,7 +3,7 @@ describe('PCP Redis datasource', () => {
         cy.task('grafana:reset');
         cy.login();
         cy.enablePlugin();
-        cy.addDatasource('pcp-redis-datasource', 'PCP Redis datasource');
+        cy.addDatasource('performancecopilot-redis-datasource', 'PCP Redis datasource');
     });
 
     beforeEach(() => {
diff --git a/cypress/integration/datasources/vector.spec.ts b/cypress/integration/datasources/vector.spec.ts
@@ -3,7 +3,7 @@ describe('PCP Vector datasource', () => {
         cy.task('grafana:reset');
         cy.login();
         cy.enablePlugin();
-        cy.addDatasource('pcp-vector-datasource', 'PCP Vector datasource');
+        cy.addDatasource('performancecopilot-vector-datasource', 'PCP Vector datasource');
     });
 
     beforeEach(() => {
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -37,7 +37,6 @@ Replace X.Y.Z with the version of grafana-pcp you wish to install.
 
     $ wget https://github.com/performancecopilot/grafana-pcp/releases/download/vX.Y.Z/performancecopilot-pcp-app-X.Y.Z.zip
     $ sudo unzip -d /var/lib/grafana/plugins performancecopilot-pcp-app-X.Y.Z.zip
-    $ sudo sed -i 's/;allow_loading_unsigned_plugins =/allow_loading_unsigned_plugins = performancecopilot-pcp-app,pcp-redis-datasource,pcp-vector-datasource,pcp-bpftrace-datasource,pcp-flamegraph-panel,pcp-breadcrumbs-panel,pcp-troubleshooting-panel/' /etc/grafana/grafana.ini
     $ sudo systemctl restart grafana-server
 
 
@@ -52,15 +51,13 @@ Replace X.Y.Z with the version of grafana-pcp you wish to install.
 
     $ podman run \
         -e GF_INSTALL_PLUGINS="https://github.com/performancecopilot/grafana-pcp/releases/download/vX.Y.Z/performancecopilot-pcp-app-X.Y.Z.zip;performancecopilot-pcp-app" \
-        -e GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS="performancecopilot-pcp-app,pcp-redis-datasource,pcp-vector-datasource,pcp-bpftrace-datasource,pcp-flamegraph-panel,pcp-breadcrumbs-panel,pcp-troubleshooting-panel" \
         -p 3000:3000 \
         docker.io/grafana/grafana
 
 .. code-block:: shell
 
     $ docker run \
         -e GF_INSTALL_PLUGINS="https://github.com/performancecopilot/grafana-pcp/releases/download/vX.Y.Z/performancecopilot-pcp-app-X.Y.Z.zip;performancecopilot-pcp-app" \
-        -e GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS="performancecopilot-pcp-app,pcp-redis-datasource,pcp-vector-datasource,pcp-bpftrace-datasource,pcp-flamegraph-panel,pcp-breadcrumbs-panel,pcp-troubleshooting-panel" \
         -p 3000:3000 \
         grafana/grafana
 
@@ -75,7 +72,7 @@ The `yarn package manager <https://yarnpkg.com>`_, `Go compiler <https://golang.
     $ git clone https://github.com/performancecopilot/grafana-pcp.git
     $ make build
     $ sudo ln -s $(pwd) /var/lib/grafana/plugins
-    $ sudo sed -i 's/;allow_loading_unsigned_plugins =/allow_loading_unsigned_plugins = performancecopilot-pcp-app,pcp-redis-datasource,pcp-vector-datasource,pcp-bpftrace-datasource,pcp-flamegraph-panel,pcp-breadcrumbs-panel,pcp-troubleshooting-panel/' /etc/grafana/grafana.ini
+    $ sudo sed -i 's/;allow_loading_unsigned_plugins =/allow_loading_unsigned_plugins = performancecopilot-pcp-app,performancecopilot-redis-datasource,performancecopilot-vector-datasource,performancecopilot-bpftrace-datasource,performancecopilot-flamegraph-panel,performancecopilot-breadcrumbs-panel,performancecopilot-troubleshooting-panel/' /etc/grafana/grafana.ini
     $ sudo systemctl restart grafana-server
 
 To list all available Makefile targets, run ``make help``.
diff --git a/src/dashboards/redis/preview/pcp-redis-metric-preview-graph.jsonnet b/src/dashboards/redis/preview/pcp-redis-metric-preview-graph.jsonnet
@@ -11,7 +11,7 @@ grafana.dashboard.new(
 .addTemplate(
   grafana.template.datasource(
     'datasource',
-    'pcp-redis-datasource',
+    'performancecopilot-redis-datasource',
     'PCP Redis',
     hide='variable',
   )
diff --git a/src/dashboards/redis/preview/pcp-redis-metric-preview-table.jsonnet b/src/dashboards/redis/preview/pcp-redis-metric-preview-table.jsonnet
@@ -11,7 +11,7 @@ grafana.dashboard.new(
 .addTemplate(
   grafana.template.datasource(
     'datasource',
-    'pcp-redis-datasource',
+    'performancecopilot-redis-datasource',
     'PCP Redis',
     hide='variable',
   )
diff --git a/src/dashboards/vector/checklist/_breadcrumbspanel.libsonnet b/src/dashboards/vector/checklist/_breadcrumbspanel.libsonnet
@@ -18,7 +18,7 @@
     items=[],
   ):: {
     title: title,
-    type: 'pcp-breadcrumbs-panel',
+    type: 'performancecopilot-breadcrumbs-panel',
     options: {
       items: items,
     },
diff --git a/src/dashboards/vector/checklist/_troubleshootingpanel.libsonnet b/src/dashboards/vector/checklist/_troubleshootingpanel.libsonnet
@@ -17,7 +17,7 @@
       unit=null
     ):: {
       title: title,
-      type: 'pcp-troubleshooting-panel',
+      type: 'performancecopilot-troubleshooting-panel',
       datasource: datasource,
       options: {
         troubleshooting: troubleshooting,
diff --git a/src/dashboards/vector/checklist/checklist.libsonnet b/src/dashboards/vector/checklist/checklist.libsonnet
@@ -231,7 +231,7 @@ local grafana = import 'grafonnet/grafana.libsonnet';
       .addTemplate(
         grafana.template.datasource(
           'datasource',
-          'pcp-vector-datasource',
+          'performancecopilot-vector-datasource',
           'PCP Vector',
         )
       )
diff --git a/src/datasources/bpftrace/dashboards/pcp-bpftrace-flame-graphs.jsonnet b/src/datasources/bpftrace/dashboards/pcp-bpftrace-flame-graphs.jsonnet
@@ -5,7 +5,7 @@ local flameGraph(
   datasource=null,
       ) = {
   title: title,
-  type: 'pcp-flamegraph-panel',
+  type: 'performancecopilot-flamegraph-panel',
   datasource: datasource,
 
   _nextTarget:: 0,
@@ -30,14 +30,14 @@ grafana.dashboard.new(
 .addTemplate(
   grafana.template.datasource(
     'bpftrace_datasource',
-    'pcp-bpftrace-datasource',
+    'performancecopilot-bpftrace-datasource',
     'PCP bpftrace',
   )
 )
 .addTemplate(
   grafana.template.datasource(
     'vector_datasource',
-    'pcp-vector-datasource',
+    'performancecopilot-vector-datasource',
     'PCP Vector',
   )
 )
diff --git a/src/datasources/bpftrace/dashboards/pcp-bpftrace-system-analysis.jsonnet b/src/datasources/bpftrace/dashboards/pcp-bpftrace-system-analysis.jsonnet
@@ -13,7 +13,7 @@ grafana.dashboard.new(
 .addTemplate(
   grafana.template.datasource(
     'datasource',
-    'pcp-bpftrace-datasource',
+    'performancecopilot-bpftrace-datasource',
     'PCP bpftrace',
   )
 )
diff --git a/src/datasources/bpftrace/plugin.json b/src/datasources/bpftrace/plugin.json
@@ -1,6 +1,6 @@
 {
     "name": "PCP bpftrace",
-    "id": "pcp-bpftrace-datasource",
+    "id": "performancecopilot-bpftrace-datasource",
     "type": "datasource",
     "category": "other",
     "metrics": true,
diff --git a/src/datasources/redis/dashboards/pcp-redis-host-overview.jsonnet b/src/datasources/redis/dashboards/pcp-redis-host-overview.jsonnet
@@ -10,7 +10,7 @@ grafana.dashboard.new(
 .addTemplate(
   grafana.template.datasource(
     'datasource',
-    'pcp-redis-datasource',
+    'performancecopilot-redis-datasource',
     'PCP Redis',
   )
 )
diff --git a/src/datasources/redis/dashboards/pcp-redis-mssql-server.jsonnet b/src/datasources/redis/dashboards/pcp-redis-mssql-server.jsonnet
@@ -10,7 +10,7 @@ grafana.dashboard.new(
 .addTemplate(
   grafana.template.datasource(
     'datasource',
-    'pcp-redis-datasource',
+    'performancecopilot-redis-datasource',
     'PCP Redis',
   )
 )
diff --git a/src/datasources/redis/plugin.json b/src/datasources/redis/plugin.json
@@ -1,6 +1,6 @@
 {
     "name": "PCP Redis",
-    "id": "pcp-redis-datasource",
+    "id": "performancecopilot-redis-datasource",
     "type": "datasource",
     "category": "tsdb",
     "metrics": true,
diff --git a/src/datasources/vector/dashboards/pcp-vector-bcc-overview.jsonnet b/src/datasources/vector/dashboards/pcp-vector-bcc-overview.jsonnet
@@ -13,7 +13,7 @@ grafana.dashboard.new(
 .addTemplate(
   grafana.template.datasource(
     'datasource',
-    'pcp-vector-datasource',
+    'performancecopilot-vector-datasource',
     'PCP Vector',
   )
 )
diff --git a/src/datasources/vector/dashboards/pcp-vector-container-overview-cgroups1.jsonnet b/src/datasources/vector/dashboards/pcp-vector-container-overview-cgroups1.jsonnet
@@ -13,7 +13,7 @@ grafana.dashboard.new(
 .addTemplate(
   grafana.template.datasource(
     'datasource',
-    'pcp-vector-datasource',
+    'performancecopilot-vector-datasource',
     'PCP Vector',
   )
 )
diff --git a/src/datasources/vector/dashboards/pcp-vector-container-overview-cgroups2.jsonnet b/src/datasources/vector/dashboards/pcp-vector-container-overview-cgroups2.jsonnet
@@ -13,7 +13,7 @@ grafana.dashboard.new(
 .addTemplate(
   grafana.template.datasource(
     'datasource',
-    'pcp-vector-datasource',
+    'performancecopilot-vector-datasource',
     'PCP Vector',
   )
 )
diff --git a/src/datasources/vector/dashboards/pcp-vector-host-overview.jsonnet b/src/datasources/vector/dashboards/pcp-vector-host-overview.jsonnet
@@ -13,7 +13,7 @@ grafana.dashboard.new(
 .addTemplate(
   grafana.template.datasource(
     'datasource',
-    'pcp-vector-datasource',
+    'performancecopilot-vector-datasource',
     'PCP Vector',
   )
 )
diff --git a/src/datasources/vector/dashboards/pcp-vector-mssql-server.jsonnet b/src/datasources/vector/dashboards/pcp-vector-mssql-server.jsonnet
@@ -10,7 +10,7 @@ grafana.dashboard.new(
 .addTemplate(
   grafana.template.datasource(
     'datasource',
-    'pcp-vector-datasource',
+    'performancecopilot-vector-datasource',
     'PCP Vector',
   )
 )
diff --git a/src/datasources/vector/plugin.json b/src/datasources/vector/plugin.json
@@ -1,6 +1,6 @@
 {
     "name": "PCP Vector",
-    "id": "pcp-vector-datasource",
+    "id": "performancecopilot-vector-datasource",
     "type": "datasource",
     "category": "tsdb",
     "metrics": true,
diff --git a/src/panels/breadcrumbs/plugin.json b/src/panels/breadcrumbs/plugin.json
@@ -1,7 +1,7 @@
 {
     "type": "panel",
     "name": "PCP Breadcrumbs",
-    "id": "pcp-breadcrumbs-panel",
+    "id": "performancecopilot-breadcrumbs-panel",
     "skipDataQuery": true,
     "info": {
         "description": "Grafana Panel for displaying breadcrumbs navigation in PCP checklist overview dashboards",
diff --git a/src/panels/flamegraph/plugin.json b/src/panels/flamegraph/plugin.json
@@ -1,7 +1,7 @@
 {
     "type": "panel",
     "name": "PCP Flame Graph",
-    "id": "pcp-flamegraph-panel",
+    "id": "performancecopilot-flamegraph-panel",
     "info": {
         "description": "Grafana Panel for displaying Flame Graphs",
         "logos": {
diff --git a/src/panels/troubleshooting/plugin.json b/src/panels/troubleshooting/plugin.json
@@ -1,7 +1,7 @@
 {
     "type": "panel",
     "name": "PCP Troubleshooting Panel",
-    "id": "pcp-troubleshooting-panel",
+    "id": "performancecopilot-troubleshooting-panel",
     "info": {
         "description": "Grafana Panel for displaying time series graphs with troubleshooting information in PCP Checklist dashboards",
         "logos": {

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ grafana.dashboard.new(`
`11`	`11`	`.addTemplate(`
`12`	`12`	`grafana.template.datasource(`
`13`	`13`	`'datasource',`
`14`		`- 'pcp-redis-datasource',`
	`14`	`+ 'performancecopilot-redis-datasource',`
`15`	`15`	`'PCP Redis',`
`16`	`16`	`hide='variable',`
`17`	`17`	`)`