Update plugin id (#253)

* update plugin id

* update changelog and update version in the package.json

* update README.md with recommendation

.config/webpack/constants.ts

@@ -1,3 +1,3 @@
 export const SOURCE_DIR = 'src';
-export const DIST_DIR = 'plugins/victoriametrics-datasource';
+export const DIST_DIR = 'plugins/victoriametrics-metrics-datasource';
 export const ENTRY_FILE = `${SOURCE_DIR}/module.ts`;

CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## tip
 
+⚠️ **Breaking Change: Plugin ID Updated**  
+**Update Note 1:**  
+In the new version of the plugin, the plugin ID has been updated. The new plugin ID is `victoriametrics-metrics-datasource`. **This is a breaking change**: Grafana will treat this as a new plugin.
+- You must update the `allow_loading_unsigned_plugins` field in the `grafana.ini` or `defaults.ini` configuration file.  
+  **Example:**
+    ```ini  
+    allow_loading_unsigned_plugins = victoriametrics-metrics-datasource  
+    ```
+- If you are using provisioning, update the `type` field to `victoriametrics-metrics-datasource` in your provisioning configuration.
+- After making these changes, you must restart the Grafana server for the updates to take effect.
+
+* FEATURE: update plugin id name to `victoriametrics-metrics-datasource` after the review while sign procedure. See [this issue](https://github.com/VictoriaMetrics/victoriametrics-datasource/issues/233).
+
 ## v0.11.1
 
 * BUGFIX: fix checksum calculation for release files.

Magefile.go

@@ -11,7 +11,7 @@ import (
 func init() {
 	build.SetBeforeBuildCallback(func(cfg build.Config) (build.Config, error) {
 		// Do something before building
-		cfg.OutputBinaryPath = "plugins/victoriametrics-datasource"
+		cfg.OutputBinaryPath = "plugins/victoriametrics-metrics-datasource"
 		return cfg, nil
 	})
 }

Makefile

@@ -9,10 +9,10 @@ ifeq ($(PKG_TAG),)
 PKG_TAG := $(BUILDINFO_TAG)
 endif
 
-PLUGIN_ID=victoriametrics-datasource
-APP_NAME=victoriametrics_backend_plugin
+PLUGIN_ID=victoriametrics-metrics-datasource
+APP_NAME=victoriametrics_metrics_backend_plugin
 
-GO_BUILDINFO = -X '$(PKG_PREFIX)/victoriametrics-datasource/buildinfo.Version=$(APP_NAME)-$(DATEINFO_TAG)-$(BUILDINFO_TAG)'
+GO_BUILDINFO = -X 'github.com/grafana/grafana-plugin-sdk-go/build.buildInfoJSON={\"time\":${DATEINFO_TAG},\"id\":\"${PLUGIN_ID}\",\"version\":\"${BUILDINFO_TAG}\",\"branch\":\"${PKG_TAG}\"}'
 
 .PHONY: $(MAKECMDGOALS)
 

README.md

@@ -30,15 +30,15 @@ Installing VictoriaMetrics Grafana datasource [requires](https://grafana.com/doc
 
 ``` ini
 [plugins]
-allow_loading_unsigned_plugins = victoriametrics-datasource
+allow_loading_unsigned_plugins = victoriametrics-metrics-datasource
 ```
 
 For `grafana-operator` users, please adjust `config:` section in your `kind=Grafana` resource as below
 
 ```
   config:
     plugins:
-      allow_loading_unsigned_plugins: "victoriametrics-datasource"
+      allow_loading_unsigned_plugins: "victoriametrics-metrics-datasource"
 ```
 
 See [why VictoriaMetrics datasource is unsigned](#why-victoriaMetrics-datasource-is-unsigned).
@@ -67,7 +67,7 @@ datasources:
   # displayed in Grafana panels and queries.
   - name: VictoriaMetrics
     # <string, required> Sets the data source type.
-    type: victoriametrics-datasource
+    type: victoriametrics-metrics-datasource
       # <string, required> Sets the access mode, either
       # proxy or direct (Server or Browser in the UI).
       # Some data sources are incompatible with any setting
@@ -83,7 +83,7 @@ datasources:
     # displayed in Grafana panels and queries.
   - name: VictoriaMetrics - cluster
     # <string, required> Sets the data source type.
-    type: victoriametrics-datasource
+    type: victoriametrics-metrics-datasource
     # <string, required> Sets the access mode, either
     # proxy or direct (Server or Browser in the UI).
     # Some data sources are incompatible with any setting
@@ -108,8 +108,8 @@ Please find the example of provisioning Grafana instance with VictoriaMetrics da
        grafana:
          image: grafana/grafana:11.0.0
          environment:
-         - GF_INSTALL_PLUGINS=https://github.com/VictoriaMetrics/victoriametrics-datasource/releases/download/v0.10.3/victoriametrics-datasource-v0.10.3.zip;victoriametrics-datasource
-         - GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=victoriametrics-datasource
+         - GF_INSTALL_PLUGINS=https://github.com/VictoriaMetrics/victoriametrics-datasource/releases/download/v0.10.3/victoriametrics-metrics-datasource-v0.10.3.zip;victoriametrics-metrics-datasource
+         - GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=victoriametrics-metrics-datasource
          ports:
          - 3000:3000/tcp
          volumes:
@@ -136,14 +136,14 @@ Option 1. Using Grafana provisioning:
 
 ``` yaml
 env:
-  GF_INSTALL_PLUGINS: "https://github.com/VictoriaMetrics/victoriametrics-datasource/releases/download/v0.10.3/victoriametrics-datasource-v0.10.3.zip;victoriametrics-datasource"
+  GF_INSTALL_PLUGINS: "https://github.com/VictoriaMetrics/victoriametrics-datasource/releases/download/v0.10.3/victoriametrics-metrics-datasource-v0.10.3.zip;victoriametrics-metrics-datasource"
 ```
 
 Option 2. Using Grafana plugins section in `values.yaml`:
 
 ``` yaml
 plugins:
-  - https://github.com/VictoriaMetrics/victoriametrics-datasource/releases/download/v0.10.3/victoriametrics-datasource-v0.10.3.zip;victoriametrics-datasource
+  - https://github.com/VictoriaMetrics/victoriametrics-datasource/releases/download/v0.10.3/victoriametrics-metrics-datasource-v0.10.3.zip;victoriametrics-metrics-datasource
 ```
 
 Option 3. Using init container:
@@ -163,7 +163,7 @@ extraInitContainers:
        set -ex
        mkdir -p /var/lib/grafana/plugins/
        ver=$(curl -s -L https://api.github.com/repos/VictoriaMetrics/victoriametrics-datasource/releases/latest | grep -oE 'v[0-9]+\.[0-9]+\.[0-9]+' | head -1)
-       curl -L https://github.com/VictoriaMetrics/victoriametrics-datasource/releases/download/$ver/victoriametrics-datasource-$ver.tar.gz -o /var/lib/grafana/plugins/vm-plugin.tar.gz
+       curl -L https://github.com/VictoriaMetrics/victoriametrics-datasource/releases/download/$ver/victoriametrics-metrics-datasource-$ver.tar.gz -o /var/lib/grafana/plugins/vm-plugin.tar.gz
        tar -xf /var/lib/grafana/plugins/vm-plugin.tar.gz -C /var/lib/grafana/plugins/
        rm /var/lib/grafana/plugins/vm-plugin.tar.gz
     volumeMounts:
@@ -223,15 +223,15 @@ spec:
                   set -ex
                   mkdir -p /var/lib/grafana/plugins/
                   ver=$(curl -s https://api.github.com/repos/VictoriaMetrics/victoriametrics-datasource/releases/latest | grep -oE 'v[0-9]+\.[0-9]+\.[0-9]+' | head -1)
-                  curl -L https://github.com/VictoriaMetrics/victoriametrics-datasource/releases/download/$ver/victoriametrics-datasource-$ver.tar.gz -o /var/lib/grafana/plugins/vm-plugin.tar.gz
+                  curl -L https://github.com/VictoriaMetrics/victoriametrics-datasource/releases/download/$ver/victoriametrics-metrics-datasource-$ver.tar.gz -o /var/lib/grafana/plugins/vm-plugin.tar.gz
                   tar -xf /var/lib/grafana/plugins/vm-plugin.tar.gz -C /var/lib/grafana/plugins/
                   rm /var/lib/grafana/plugins/vm-plugin.tar.gz
               volumeMounts:
                 - name: grafana-data
                   mountPath: /var/lib/grafana
   config:
     plugins:
-      allow_loading_unsigned_plugins: victoriametrics-datasource
+      allow_loading_unsigned_plugins: victoriametrics-metrics-datasource
 ```
 
 See [Grafana operator reference](https://grafana-operator.github.io/grafana-operator/docs/grafana/) to find more about  Grafana operator.
@@ -243,7 +243,7 @@ This example uses init container to download and install plugin.
 
    ```sh
    ver=$(curl -s https://api.github.com/repos/VictoriaMetrics/victoriametrics-datasource/releases/latest | grep -oE 'v[0-9]+\.[0-9]+\.[0-9]+' | head -1)
-   curl -L https://github.com/VictoriaMetrics/victoriametrics-datasource/releases/download/$ver/victoriametrics-datasource-$ver.tar.gz -o /var/lib/grafana/plugins/vm-plugin.tar.gz
+   curl -L https://github.com/VictoriaMetrics/victoriametrics-datasource/releases/download/$ver/victoriametrics-metrics-datasource-$ver.tar.gz -o /var/lib/grafana/plugins/vm-plugin.tar.gz
    tar -xf /var/lib/grafana/plugins/vm-plugin.tar.gz -C /var/lib/grafana/plugins/
    rm /var/lib/grafana/plugins/vm-plugin.tar.gz
    ```
@@ -263,7 +263,7 @@ plugins = {{path to directory with plugin}}
 
 ``` ini
 [plugins]
-allow_loading_unsigned_plugins = victoriametrics-datasource
+allow_loading_unsigned_plugins = victoriametrics-metrics-datasource
 ```
 
 ### 2. Run the plugin

compose.yaml

@@ -9,5 +9,5 @@ services:
       GF_AUTH_BASIC_ENABLED: "false"
       GF_DEFAULT_APP_MODE: development
     volumes:
-      - ./plugins/victoriametrics-datasource:/var/lib/grafana/plugins/victoriametrics-datasource
+      - ./plugins/victoriametrics-metrics-datasource:/var/lib/grafana/plugins/victoriametrics-metrics-datasource
       - ./provisioning:/etc/grafana/provisioning

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "victoriametrics-datasource",
-  "version": "0.11.1",
+  "name": "victoriametrics-metrics-datasource",
+  "version": "0.12.0",
   "description": "Showcase how to build a basic datasource plugin",
   "scripts": {
     "build": "TS_NODE_PROJECT=\"./.config/webpack/tsconfig.webpack.json\" webpack -c ./webpack.config.ts --env production",

pkg/main.go

@@ -13,7 +13,7 @@ import (
 func main() {
 	backend.Logger.Info("Starting VictoriaMetrics datasource backend ...")
 
-	if err := datasource.Manage("victoriametrics-datasource-http-backend", plugin.NewDatasource, datasource.ManageOpts{}); err != nil {
+	if err := datasource.Manage("victoriametrics-metrics-datasource", plugin.NewDatasource, datasource.ManageOpts{}); err != nil {
 		log.DefaultLogger.Error("Failed to process VictoriaMetrics datasource backend :%s", err.Error())
 		os.Exit(1)
 	}