Merge pull request #25 from netdata/feat/prepare-plugin-sign

Feat/prepare plugin sign

Author: witalisoft

.github/workflows/release.yml

@@ -8,6 +8,8 @@ on:
 jobs:
   release:
     runs-on: ubuntu-latest
+    env:
+      GRAFANA_API_KEY: ${{ secrets.GRAFANA_API_KEY }}
 
     steps:
       - uses: actions/checkout@v2
@@ -48,6 +50,10 @@ jobs:
       - name: Build and test frontend
         run: yarn build
 
+      - name: Sign plugin
+        run: yarn sign
+        if: ${{ env.GRAFANA_API_KEY != '' }}
+
       - name: Get plugin metadata
         id: metadata
         run: |
@@ -82,7 +88,7 @@ jobs:
           mv dist "${{ steps.metadata.outputs.plugin-id }}"
           zip "${{ steps.metadata.outputs.archive }}" "${{ steps.metadata.outputs.plugin-id }}" -r
           md5sum "${{ steps.metadata.outputs.archive }}" > "${{ steps.metadata.outputs.archive-checksum }}"
-          echo "checksum=$(cat \"./${{ steps.metadata.outputs.archive-checksum }}\" | cut -d' ' -f1)" >> $GITHUB_OUTPUT
+          echo "checksum=$(cat './${{ steps.metadata.outputs.archive-checksum }}' | cut -d' ' -f1)" >> $GITHUB_OUTPUT
 
       - name: Upload artifacts
         uses: actions/upload-artifact@v2

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
-## 1.0.0 (Unreleased)
+## 2.0.0
+
+The plugin is compliant with Grafana Signing Requirements.
+
+## 1.0.12
 
 Initial release.

README.md

@@ -1,59 +1,25 @@
 # Netdata data source for Grafana
 
-[![Build](https://github.com/grafana/grafana-starter-datasource/workflows/CI/badge.svg)](https://github.com/grafana/grafana-starter-datasource/actions?query=workflow%3A%22CI%22)
-
 _Enhanced high-fidelity troubleshooting data source for the Open Source community!_
 
 ![Image](https://user-images.githubusercontent.com/82235632/193311991-a6d167ab-b845-49b7-817c-976b780e427e.png)
 
-## What is Netdata data source plugin for Grafana?
-
-We are huge fans of Open Source culture and it is rooted deeply into our DNA, so we thought that the Open Source community would hugely benefit from Netdata providing a Grafana data source plugin that would expose its powerful data collection engine.
-
-With this data source plugin we expose the troubleshooting capabilities of Netdata in Grafana, making them available more widely. Some of the key capabilities:
-- Real-time monitoring with single-second granularity.
-- Installation and out-of-the-box integrations available in seconds from one line of code.
-- 2,000+ metrics from across your whole Infrastructure, with insightful metadata associated with them.
-- Access to our fresh ML metrics (anomaly rates) - exposing our ML capabilities at the edge!
-
-
-## Getting started
-
-### 1. Connect your Nodes to Netdata Cloud
-
-Netdata’s data source plugin connects directly to our Netdata Cloud API’s, meaning that you’ll need to have your nodes (hosts) connected to [Netdata Cloud](https://app.netdata.cloud/?utm_source=grafana&utm_content=data_source_plugin) in order to be able to have them exposed on our plugin. For security purposes you will also need an API token for authentication (which you can get from within your Netdata profile).
-
-Note: If you don't have an account [sign-up](https://app.netdata.cloud/?utm_source=grafana&utm_content=data_source_plugin) for free to get one! 
-
-> Netdata Agent will need to be installed and running on your server, VM and/or cluster, so that it can start collecting all the relevant metrics you have from the server 
-and applications running on it. More info at https://learn.netdata.cloud/docs/get-started.
-
-### 2. Ensure you have an API Token for authentication purposes.
-
-Once you have all your nodes connected to Netdata Hub you must proceed with creating an API token, which will be linked to your Netdata Cloud  account. The API token provides a means to authenticate external calls to our APIs, allowing the same access as you to the Spaces and Rooms you can see on Netdata Hub.
-
-![image](https://user-images.githubusercontent.com/82235632/189399116-2df5da8a-49d2-42b2-bdec-64b7f7d9bd83.png)
-
-### 3. Install Netdata data source plugin on Grafana OSS or Enterprise (local)
-
-For detailed instructions on how to install the plugin on Grafana OSS or Enterprise check the section [How to install the plugin?](#how-to-install-the-plugin).
-
-### 4. Add your API token to the Netdata data source plugin configuration
-
-Once you have added your API token to Netdata data source plugin you’re ready to start taking advantage of Netdata’s troubleshooting capabilities in Grafana by starting creating your charts and dashboards!
-
-![image](https://user-images.githubusercontent.com/82235632/189398814-1efbf1c7-1a62-4d5f-abe8-6a9297a3f008.png)
-
 ## How to install the plugin?
 
-To start using the Netdata data source plugin on your Grafana environment, local or Cloud, you need to install the plugin manually - it currently isn't signed. Here are some tips to get through this depending on your setup:
+To start using the Netdata data source plugin on your Grafana environment, local or Cloud. Here are some tips to get through this depending on your setup:
+* Directly through the Grafana UI
 * Docker
 * Linux (local)
 * Windows (local - powershell)
 * Building the plugin locally
 
 The installations below will use different tools like: curl, docker, jq, wget, unzip and xcopy.
 
+### Directly through the Grafana UI
+
+Netdata is available in the Grafana Plugin catalog that can be accessed from the Grafana UI. 
+For details on how to: use the Plugin catalog, manage the plugins (install, update, uninstall), and other information, please check [this documentation](https://grafana.com/docs/grafana/latest/administration/plugin-management/#plugin-catalog).
+
 ### Docker
 
 #### Pre-buit script - setup-demo-environment
@@ -76,10 +42,10 @@ This script will:
 
 #### Manual step-by-step
 
-1. Setup your grafana docker container with the the permissions to load netdata plugin as unsinged
+1. Setup your grafana docker container with the the permissions to load netdata plugin
 
    ```
-   docker run -d --env GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=netdata-datasource --name=grafana grafana/grafana
+   docker run -d --name=grafana grafana/grafana
    ```
 
 2. Ensure you have the desired version of the plugin you want to install, get it from github releases 
@@ -116,19 +82,7 @@ This script will:
    cp -rf netdata-datasource /var/lib/grafana/plugins
    ```
 
-4. Ensure that Netdata plugin which currently isn’t signed can be registered
-
-   ```
-   vi /etc/grafana/grafana.ini
-   ```
-
-	On `allow_loading_unsigned_plugins` entry add **netdata-datasource**
-
-   ```
-   allow_loading_unsigned_plugins = netdata-datasource
-   ```
-
-5. After adding the plugin a restart of grafana server is needed
+3. After adding the plugin a restart of grafana server is needed
 
    For init.d based services you can use the command:
    ```
@@ -153,19 +107,7 @@ This script will:
    xcopy .\netdata-datasource\ "C:\Program Files\GrafanaLabs\grafana\data\plugins\netdata-datasource\" /E
    ```
 
-3. Ensure that Netdata plugin which currently isn’t signed can be registered
-
-	```
-   notepad ‘C:\Program Files\GrafanaLabs\grafana\conf\default.ini’
-   ```
-
-	On `allow_loading_unsigned_plugins` entry add **netdata-datasource**
-
-   ```
-   allow_loading_unsigned_plugins = netdata-datasource
-   ```
-
-4. After adding the plugin a restart of grafana server is needed
+3. After adding the plugin a restart of grafana server is needed
 
    ```
    net stop Grafana
@@ -188,4 +130,3 @@ For any of the above steps if you prefer to build this plugin locally instead of
    ```
 
 3. Place the contents of the `/dist` folder under the netdata folder in Grafana plugins directory.
-

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "netdata-datasource",
-  "version": "1.0.12",
+  "name": "netdatacloud-netdata-datasource",
+  "version": "2.0.0",
   "description": "netdata datasource plugin",
   "scripts": {
     "build": "grafana-toolkit plugin:build",
@@ -13,9 +13,9 @@
   "author": "netdata",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@grafana/data": "latest",
-    "@grafana/toolkit": "latest",
-    "@grafana/ui": "latest",
+    "@grafana/data": "8.5.5",
+    "@grafana/toolkit": "8.5.5",
+    "@grafana/ui": "8.5.5",
     "@testing-library/jest-dom": "5.4.0",
     "@testing-library/react": "^10.0.2",
     "@testing-library/react-hooks": "^8.0.1",

setup-demo-environment.sh

@@ -5,7 +5,7 @@ set -e -o pipefail
 
 readonly CONTAINER_NAME="grafana-netdata-plugin-demo"
 readonly CONTAINER_PORT=3000
-readonly GRAFANA_DOCKER_IMAGE="grafana/grafana:9.1.6"
+readonly GRAFANA_DOCKER_IMAGE="grafana/grafana:10.2.2"
 readonly NETDATA_PLUGIN_REPO="netdata/netdata-grafana-datasource-plugin"
 readonly PROGNAME=$(basename $0)
 readonly ARG=$1
@@ -30,7 +30,7 @@ function run() {
   declare plugin_url
   plugin_url="$(get_latest_plugin)"
   set -x
-  docker run -d -p 127.0.0.1::$CONTAINER_PORT -e GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=netdata-datasource \
+  docker run -d -p 127.0.0.1::$CONTAINER_PORT \
     --name $CONTAINER_NAME --entrypoint /bin/sleep $GRAFANA_DOCKER_IMAGE inf
   docker exec -it $CONTAINER_NAME \
     bash -c "cd /var/lib/grafana/plugins && wget $plugin_url && unzip *.zip"

src/QueryEditor.tsx

@@ -33,9 +33,9 @@ const QueryEditor: React.FC<Props> = ({ datasource, query, onChange, onRunQuery
     value: query.contextId,
   });
   const [selectedDimensions, setSelectedDimensions] = React.useState<Dropdown[]>();
-  const [selectedGroupBy, setSelectedGroupBy] = React.useState<Dropdown>();
+  const [selectedGroupBy, setSelectedGroupBy] = React.useState<Dropdown>(GroupByList[0]);
   const [selectedMethod, setSelectedMethod] = React.useState<Dropdown>(Methods[0]);
-  const [selectedAggreagations, setSelectedAggreagations] = React.useState<Dropdown>(Aggreagations[0]);
+  const [selectedAggregations, setSelectedAggregations] = React.useState<Dropdown>(Aggreagations[0]);
   const [filterByValues, setFilterByValues] = React.useState<Dropdown[]>([]);
 
   const { spaces } = useFetchSpaces(baseUrl);
@@ -54,7 +54,7 @@ const QueryEditor: React.FC<Props> = ({ datasource, query, onChange, onRunQuery
     setTotalInstances(data.data.nodes.reduce((acc: number, node: any) => acc + node.chartIDs.length, 0));
   };
 
-  const IsGroupFunctionAvailable = React.useCallback(() => {
+  const isGroupFunctionAvailable = React.useCallback(() => {
     if (groupBy === 'instance' || selectedGroupBy?.value === 'instance') {
       return false;
     }
@@ -148,13 +148,13 @@ const QueryEditor: React.FC<Props> = ({ datasource, query, onChange, onRunQuery
     setSelectedContext({});
     setSelectedDimensions([]);
     setSelectedGroupBy(GroupByList[0]);
-    setSelectedFilter({ label: 'No filter', value: 'No filter' });
+    setSelectedFilter({});
     setSelectedFilterValue({});
     setSelectedMethod(Methods[0]);
-    setSelectedAggreagations(Aggreagations[0]);
+    setSelectedAggregations(Aggreagations[0]);
 
     fetchRooms(v.value || '');
-    onChange({ spaceId: v.value } as MyQuery);
+    onChange({ ...query, spaceId: v.value });
     onRunQuery();
   };
 
@@ -166,14 +166,14 @@ const QueryEditor: React.FC<Props> = ({ datasource, query, onChange, onRunQuery
     setSelectedContext({});
     setSelectedDimensions([]);
     setSelectedGroupBy(GroupByList[0]);
-    setSelectedFilter({ label: 'No filter', value: 'No filter' });
+    setSelectedFilter({});
     setSelectedFilterValue({});
     setSelectedMethod(Methods[0]);
-    setSelectedAggreagations(Aggreagations[0]);
+    setSelectedAggregations(Aggreagations[0]);
 
     fetchContexts(selectedSpace?.value || '', v.value || '');
     fetchNodes(selectedSpace?.value || '', v.value || '');
-    onChange({ spaceId: spaceId, roomId: v.value } as MyQuery);
+    onChange({ ...query, spaceId: spaceId, roomId: v.value });
     onRunQuery();
   };
 
@@ -183,14 +183,13 @@ const QueryEditor: React.FC<Props> = ({ datasource, query, onChange, onRunQuery
     // reset the rest of inputs
     setSelectedDimensions([]);
     setSelectedGroupBy(GroupByList[0]);
-    setSelectedFilter({ label: 'No filter', value: 'No filter' });
+    setSelectedFilter({});
     setSelectedFilterValue({});
     setSelectedMethod(Methods[0]);
-    setSelectedAggreagations(Aggreagations[0]);
+    setSelectedAggregations(Aggreagations[0]);
 
     fetchDimensions({ spaceId, roomId, contextId: v.value, nodeIDs: selectedNodes?.map((n: any) => n.value) || [] });
     onChange({ ...query, contextId: v.value });
-    onChange({ spaceId, roomId, contextId: v.value } as MyQuery);
     onRunQuery();
   };
 
@@ -200,14 +199,14 @@ const QueryEditor: React.FC<Props> = ({ datasource, query, onChange, onRunQuery
     // reset the rest of inputs
     setSelectedDimensions([]);
     setSelectedGroupBy(GroupByList[0]);
-    setSelectedFilter({ label: 'No filter', value: 'No filter' });
+    setSelectedFilter({});
     setSelectedFilterValue({});
     setSelectedMethod(Methods[0]);
-    setSelectedAggreagations(Aggreagations[0]);
+    setSelectedAggregations(Aggreagations[0]);
 
     fetchDimensions({ spaceId, roomId, contextId, nodeIDs: data });
     setSelectedNodes(data);
-    onChange({ spaceId, roomId, contextId, nodes: data } as MyQuery);
+    onChange({ ...query, spaceId, roomId, contextId, nodes: data } as MyQuery);
     onRunQuery();
   };
 
@@ -249,7 +248,7 @@ const QueryEditor: React.FC<Props> = ({ datasource, query, onChange, onRunQuery
   };
 
   const onAggreagationChange = (v: SelectableValue<string>) => {
-    setSelectedAggreagations(v);
+    setSelectedAggregations(v);
     onChange({ ...query, group: v.value });
     onRunQuery();
   };
@@ -336,7 +335,7 @@ const QueryEditor: React.FC<Props> = ({ datasource, query, onChange, onRunQuery
           labelWidth={10}
           inputEl={
             <Select
-              disabled={!IsGroupFunctionAvailable()}
+              disabled={!isGroupFunctionAvailable()}
               options={Methods}
               value={selectedMethod}
               onChange={onMethodChange}
@@ -352,7 +351,7 @@ const QueryEditor: React.FC<Props> = ({ datasource, query, onChange, onRunQuery
           inputEl={
             <Select
               options={Aggreagations}
-              value={selectedAggreagations}
+              value={selectedAggregations}
               onChange={onAggreagationChange}
               allowCustomValue
               isSearchable

src/README.md

@@ -0,0 +1,41 @@
+# Netdata data source for Grafana
+
+_Enhanced high-fidelity troubleshooting data source for the Open Source community!_
+
+![Image](https://user-images.githubusercontent.com/82235632/193311991-a6d167ab-b845-49b7-817c-976b780e427e.png)
+
+## What is Netdata data source plugin for Grafana?
+
+We are huge fans of Open Source culture and it is rooted deeply into our DNA, so we thought that the Open Source community would hugely benefit from Netdata providing a Grafana data source plugin that would expose its powerful data collection engine.
+
+With this data source plugin we expose the troubleshooting capabilities of Netdata in Grafana, making them available more widely. Some of the key capabilities:
+- Real-time monitoring with single-second granularity.
+- Installation and out-of-the-box integrations available in seconds from one line of code.
+- 2,000+ metrics from across your whole Infrastructure, with insightful metadata associated with them.
+- Access to our fresh ML metrics (anomaly rates) - exposing our ML capabilities at the edge!
+
+
+## Getting started
+
+### 1. Connect your Nodes to Netdata Cloud
+
+Netdata’s data source plugin connects directly to our Netdata Cloud API’s, meaning that you’ll need to have your nodes (hosts) connected to [Netdata Cloud](https://app.netdata.cloud/?utm_source=grafana&utm_content=data_source_plugin) in order to be able to have them exposed on our plugin. For security purposes you will also need an API token for authentication (which you can get from within your Netdata profile).
+
+Note: If you don't have an account [sign-up](https://app.netdata.cloud/?utm_source=grafana&utm_content=data_source_plugin) for free to get one! 
+
+> Netdata Agent will need to be installed and running on your server, VM and/or cluster, so that it can start collecting all the relevant metrics you have from the server 
+and applications running on it. More info at https://learn.netdata.cloud/docs/get-started.
+
+### 2. Ensure you have an API Token for authentication purposes.
+
+Once you have all your nodes connected to Netdata Hub you must proceed with creating an API token, which will be linked to your Netdata Cloud  account. The API token provides a means to authenticate external calls to our APIs, allowing the same access as you to the Spaces and Rooms you can see on Netdata Hub.
+
+![image](https://user-images.githubusercontent.com/82235632/189399116-2df5da8a-49d2-42b2-bdec-64b7f7d9bd83.png)
+
+### 3. Install Netdata data source plugin
+
+### 4. Add your API token to the Netdata data source plugin configuration
+
+Once you have added your API token to Netdata data source plugin you’re ready to start taking advantage of Netdata’s troubleshooting capabilities in Grafana by starting creating your charts and dashboards!
+
+![image](https://user-images.githubusercontent.com/82235632/189398814-1efbf1c7-1a62-4d5f-abe8-6a9297a3f008.png)