issue-156: change plugin id to Grafana naming convention (#161)

* issue-156: change plugin id to Grafana naming convention * issue-156: cleanup vl-plugin-cleanup * issue-156: cleanup vl-plugin-cleanup * issue-156: change plugin id to Grafana naming convention * issue-156: cleanup vl-plugin-cleanup * issue-156: cleanup vl-plugin-cleanup * issue-156: update CHANGELOG.md * issue-156: update CHANGELOG.md * issue-156: cleanup
VictoriaMetrics · Dec 17, 2024 · b8fd925 · b8fd925
1 parent e413bed
commit b8fd925
Show file tree

Hide file tree

Showing 7 changed files with 52 additions and 26 deletions.
diff --git a/.config/webpack/constants.ts b/.config/webpack/constants.ts
@@ -1,2 +1,2 @@
 export const SOURCE_DIR = 'src';
-export const DIST_DIR = 'plugins/victorialogs-datasource';
+export const DIST_DIR = 'plugins/victoriametrics-logs-datasource';
diff --git a/CHANGELOG.md b/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-logs-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-logs-datasource  
+    ```
+- If you are using provisioning, update the `type` field to `victoriametrics-logs-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-logs-datasource` to prepare the plugin for the sign procedure. See [this issue](https://github.com/VictoriaMetrics/victorialogs-datasource/issues/156).
+
 ## v0.12.0
 
 * FEATURE: add compatibility for Grafana `v10.x.x` to ensure `/select/logs/hits` displays precise logs volume on the Explore page. See [this comment](https://github.com/VictoriaMetrics/victorialogs-datasource/pull/146#issuecomment-2533419498).

diff --git a/Makefile b/Makefile
@@ -9,8 +9,8 @@ ifeq ($(PKG_TAG),)
 PKG_TAG := $(BUILDINFO_TAG)
 endif
 
-PLUGIN_ID=victorialogs-datasource
-APP_NAME=victorialogs_backend_plugin
+PLUGIN_ID=victoriametrics-logs-datasource
+APP_NAME=victoriametrics_logs_backend_plugin
 
 GO_BUILDINFO = -X 'github.com/grafana/grafana-plugin-sdk-go/build.buildInfoJSON={\"time\":${DATEINFO_TAG},\"id\":\"${PLUGIN_ID}\",\"version\":\"${BUILDINFO_TAG}\",\"branch\":\"${PKG_TAG}\"}'
 

diff --git a/README.md b/README.md
@@ -18,15 +18,15 @@ the following changes to Grafana's `grafana.ini` config:
 
 ``` ini
 [plugins]
-allow_loading_unsigned_plugins = victorialogs-datasource
+allow_loading_unsigned_plugins = victoriametrics-logs-datasource
 ```
 
 If using `grafana-operator`, adjust `config` section in your `kind=Grafana` resource as below:
 
 ```
   config:
     plugins:
-      allow_loading_unsigned_plugins: "victorialogs-datasource"
+      allow_loading_unsigned_plugins: "victoriametrics-logs-datasource"
 ```
 
 For detailed instructions on how to install the plugin in Grafana Cloud or locally,
@@ -43,7 +43,7 @@ datasources:
     # displayed in Grafana panels and queries.
   - name: VictoriaLogs
     # <string, required> Sets the data source type.
-    type: victorialogs-datasource
+    type: victoriametrics-logs-datasource
     # <string, required> Sets the access mode, either
     # proxy or direct (Server or Browser in the UI).
     access: proxy
@@ -67,8 +67,8 @@ Please find the example of provisioning Grafana instance with VictoriaLogs datas
        grafana:
          image: grafana/grafana:11.0.0
          environment:
-         - GF_INSTALL_PLUGINS=https://github.com/VictoriaMetrics/victorialogs-datasource/releases/download/v0.12.0/victorialogs-datasource-v0.12.0.zip;victorialogs-datasource
-         - GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=victorialogs-datasource
+         - GF_INSTALL_PLUGINS=https://github.com/VictoriaMetrics/victorialogs-datasource/releases/download/v0.12.0/victoriametrics-logs-datasource-v0.12.0.zip;victoriametrics-logs-datasource
+         - GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=victoriametrics-logs-datasource
          ports:
          - 3000:3000/tcp
          volumes:
@@ -95,15 +95,15 @@ Option 1. Using Grafana provisioning:
 
 ``` yaml
 env:
-  GF_INSTALL_PLUGINS: "https://github.com/VictoriaMetrics/victorialogs-datasource/releases/download/v0.12.0/victorialogs-datasource-v0.12.0.zip;victorialogs-datasource"
-  GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS: "victorialogs-datasource"
+  GF_INSTALL_PLUGINS: "https://github.com/VictoriaMetrics/victorialogs-datasource/releases/download/v0.12.0/victoriametrics-logs-datasource-v0.12.0.zip;victoriametrics-logs-datasource"
+  GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS: "victoriametrics-logs-datasource"
 ```
 
 Option 2. Using Grafana plugins section in `values.yaml`:
 
 ``` yaml
 plugins:
-  - https://github.com/VictoriaMetrics/victorialogs-datasource/releases/download/v0.12.0/victorialogs-datasource-v0.12.0.zip;victorialogs-datasource
+  - https://github.com/VictoriaMetrics/victorialogs-datasource/releases/download/v0.12.0/victoriametrics-logs-datasource-v0.12.0.zip;victoriametrics-logs-datasource
 ```
 
 Option 3. Using init container:
@@ -124,7 +124,7 @@ extraInitContainers:
        set -ex
        mkdir -p /var/lib/grafana/plugins/
        ver=$(curl -s -L https://api.github.com/repos/VictoriaMetrics/victorialogs-datasource/releases/latest | grep -oE 'v[0-9]+\.[0-9]+\.[0-9]+' | head -1)
-       curl -L https://github.com/VictoriaMetrics/victorialogs-datasource/releases/download/$ver/victorialogs-datasource-$ver.tar.gz -o /var/lib/grafana/plugins/vl-plugin.tar.gz
+       curl -L https://github.com/VictoriaMetrics/victorialogs-datasource/releases/download/$ver/victoriametrics-logs-datasource-$ver.tar.gz -o /var/lib/grafana/plugins/vl-plugin.tar.gz
        tar -xf /var/lib/grafana/plugins/vl-plugin.tar.gz -C /var/lib/grafana/plugins/
        rm /var/lib/grafana/plugins/vl-plugin.tar.gz
     volumeMounts:
@@ -184,15 +184,15 @@ spec:
                   set -ex
                   mkdir -p /var/lib/grafana/plugins/
                   ver=$(curl -s https://api.github.com/repos/VictoriaMetrics/victorialogs-datasource/releases/latest | grep -oE 'v[0-9]+\.[0-9]+\.[0-9]+' | head -1)
-                  curl -L https://github.com/VictoriaMetrics/victorialogs-datasource/releases/download/$ver/victorialogs-datasource-$ver.tar.gz -o /var/lib/grafana/plugins/vl-plugin.tar.gz
+                  curl -L https://github.com/VictoriaMetrics/victorialogs-datasource/releases/download/$ver/victoriametrics-logs-datasource-$ver.tar.gz -o /var/lib/grafana/plugins/vl-plugin.tar.gz
                   tar -xf /var/lib/grafana/plugins/vl-plugin.tar.gz -C /var/lib/grafana/plugins/
                   rm /var/lib/grafana/plugins/vl-plugin.tar.gz
               volumeMounts:
                 - name: grafana-data
                   mountPath: /var/lib/grafana
   config:
     plugins:
-      allow_loading_unsigned_plugins: victorialogs-datasource
+      allow_loading_unsigned_plugins: victoriametrics-logs-datasource
 ```
 
 See [Grafana operator reference](https://grafana-operator.github.io/grafana-operator/docs/grafana/) to find more about Grafana operator.
@@ -204,7 +204,7 @@ This example uses init container to download and install plugin.
 
    ``` bash
    ver=$(curl -s https://api.github.com/repos/VictoriaMetrics/victorialogs-datasource/releases/latest | grep -oE 'v[0-9]+\.[0-9]+\.[0-9]+' | head -1)
-   curl -L https://github.com/VictoriaMetrics/victorialogs-datasource/releases/download/$ver/victorialogs-datasource-$ver.tar.gz -o /var/lib/grafana/plugins/vl-plugin.tar.gz
+   curl -L https://github.com/VictoriaMetrics/victorialogs-datasource/releases/download/$ver/victoriametrics-logs-datasource-$ver.tar.gz -o /var/lib/grafana/plugins/vl-plugin.tar.gz
    tar -xf /var/lib/grafana/plugins/vl-plugin.tar.gz -C /var/lib/grafana/plugins/
    rm /var/lib/grafana/plugins/vl-plugin.tar.gz
    ```
@@ -224,7 +224,7 @@ plugins = {{path to directory with plugin}}
 
 ``` ini
 [plugins]
-allow_loading_unsigned_plugins = victorialogs-datasource
+allow_loading_unsigned_plugins = victoriametrics-logs-datasource
 ```
 
 ### 2. Run the plugin
@@ -238,7 +238,7 @@ yarn install
 # run the app in the development mode
 yarn dev
 
-# build the plugin for production to the `victorialogs-datasource` folder and zip build
+# build the plugin for production to the `victoriametrics-logs-datasource` folder and zip build
 yarn build:zip
 ```
 
@@ -250,7 +250,7 @@ From the root folder of the project run the following command:
 make vl-backend-plugin-build
 ```
 
-This command will build executable multi-platform files to the `victorialogs-datasource` folder for the following platforms:
+This command will build executable multi-platform files to the `victoriametrics-logs-datasource` folder for the following platforms:
 
 * linux/amd64
 * linux/arm64
@@ -268,7 +268,7 @@ From the root folder of the project run the following command:
 make vl-frontend-plugin-build
 ```
 
-This command will build all frontend app into `victorialogs-datasource` folder.
+This command will build all frontend app into `victoriametrics-logs-datasource` folder.
 
 ### 5. How to build frontend and backend parts of the plugin:
 
@@ -278,7 +278,7 @@ When frontend and backend parts of the plugin is required, run the following com
 make vl-plugin-build
 ```
 
-This command will build frontend part and backend part or the plugin and locate both parts into `victorialogs-datasource` folder.
+This command will build frontend part and backend part or the plugin and locate both parts into `victoriametrics-logs-datasource` folder.
 
 ## How to make new release
 

diff --git a/compose.yaml b/compose.yaml
@@ -9,5 +9,5 @@ services:
       GF_AUTH_BASIC_ENABLED: "false"
       GF_DEFAULT_APP_MODE: development
     volumes:
-      - ./plugins/victorialogs-datasource:/var/lib/grafana/plugins/victorialogs-datasource
+      - ./plugins/victoriametrics-logs-datasource:/var/lib/grafana/plugins/victoriametrics-logs-datasource
       - ./provisioning:/etc/grafana/provisioning
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "victorialogs-datasource",
+  "name": "victoriametrics-logs-datasource",
   "version": "0.12.0",
   "description": "VictoriaLogs datasource plugin for grafana",
   "scripts": {

diff --git a/src/plugin.json b/src/plugin.json
@@ -1,15 +1,15 @@
 {
   "type": "datasource",
   "name": "VictoriaLogs",
-  "id": "victorialogs-datasource",
+  "id": "victoriametrics-logs-datasource",
   "category": "logging",
   "logs": true,
   "metrics": true,
   "alerting": true,
   "annotations": true,
   "streaming": true,
   "backend": true,
-  "executable": "victorialogs_backend_plugin",
+  "executable": "victoriametrics_logs_backend_plugin",
   "queryOptions": {
     "maxDataPoints": true
   },
@@ -19,12 +19,25 @@
       "name": "VictoriaLogs",
       "url": "https://victoriametrics.com/"
     },
-    "keywords": ["datasource"],
+    "keywords": ["logs", "log analytics", "observability", "victoriametrics", "victorialogs", "datasource"],
     "logos": {
       "small": "img/logo.svg",
       "large": "img/logo.svg"
     },
-    "links": [],
+    "links": [
+      {
+        "name": "Learn more",
+        "url": "https://docs.victoriametrics.com/victorialogs/"
+      },
+      {
+        "name": "LogsQL",
+        "url": "https://docs.victoriametrics.com/victorialogs/logsql/"
+      },
+      {
+        "name": "GitHub Project",
+        "url": "https://github.com/VictoriaMetrics/victorialogs-datasource"
+      }
+    ],
     "screenshots": [],
     "version": "%VERSION%",
     "updated": "%TODAY%"