Merge pull request #96 from scalyr/go-rewrite-v2-jmakar

Minor changes based on Grafana support feedback
scalyr · May 6, 2022 · d1fdf20 · d1fdf20
2 parents c013588 + 9883e3a
commit d1fdf20
Show file tree

Hide file tree

Showing 5 changed files with 147 additions and 147 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.0.2
+
+Minor changes based on Grafana support feedback.
+
 ## 3.0.1
 
 Minor cleanups/changes.

diff --git a/DEVELOPER_README.md b/DEVELOPER_README.md
@@ -0,0 +1,85 @@
+# Building
+
+1. Clone the [plugin repository](https://github.com/scalyr/scalyr-grafana-datasource-plugin) from GitHub.
+
+    ```bash
+    git  clone https://github.com/scalyr/scalyr-grafana-datasource-plugin.git
+    ```
+
+2. Build the Golang backend (with the version defined in go.mod, currently 1.16) using Mage.
+
+    ```bash
+    mage
+    ```
+
+    This will build the executables in `dist/`.
+
+    To install Mage (Golang make-like build tool):
+
+    ```bash
+    git clone https://github.com/magefile/mage $GOPATH/src/github.com/magefile/mage
+    cd $GOPATH/src/github.com/magefile/mage
+    git checkout tags/v1.12.1 # Specified in go.mod
+    go run bootstrap.go
+    ```
+
+    A `mage` executable should now be in `$GOPATH/bin/`.
+
+3. Build the Typescript frontend using LTS Node (>= v14) and Yarn.
+
+    ```bash
+    yarn install --pure-lockfile # Install dependencies into node_modules
+    yarn build
+    ```
+
+    This will build and the frontend files in `dist/`.
+
+    To install Yarn: `npm install --global yarn`.
+
+
+5. For development versions, simply copy the files to the Grafana server plugin directory.
+
+    ```bash
+    mkdir /var/lib/grafana/plugins/dataset
+    # copy files from dist/ into /var/lib/grafana/plugins/dataset
+    ```
+
+    Note that this is an unsigned plugin, and you must update your `grafana.ini` file to allow it adding the following line:
+
+   ```bash
+   allow_loading_unsigned_plugins = sentinelone-dataset-datasource
+   ```
+
+6. Adding plugins requires a restart of your grafana server.
+
+    For init.d based services you can use the command:
+
+    ```bash
+    sudo service grafana-server restart
+    ```
+
+    For systemd based services you can use the following:
+
+    ```bash
+    systemctl restart grafana-server
+    ```
+
+# Signing and Packaging
+
+To sign and package the plugin for distribution:
+
+```bash
+export GRAFANA_API_KEY=<YOUR_API_KEY>
+npx @grafana/toolkit plugin:sign # This creates dist/MANIFEST.txt
+
+cp -r dist sentinelone-dataset-datasource
+zip -r sentinelone-dataset-datasource-$(jq -r .info.version sentinelone-dataset-datasource/plugin.json).zip sentinelone-dataset-datasource
+rm -rf sentinelone-dataset-datasource # Cleanup
+```
+
+References
+- https://grafana.com/docs/grafana/latest/developers/plugins/package-a-plugin/
+- https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/
+
+Note that updates must be submitted to Grafana support for review, if approved the updated plugin will be hosted by the Grafana API and be accessible via `grafana-cli`.
+
diff --git a/README.md b/README.md
@@ -10,8 +10,8 @@ when you want to monitor many feeds on a single dashboard.
 
 With the Dataset plugin, you will be able to create and visualize your log-based
 metrics along side all of your other data sources. It's a great way to have a
-single pane of glass for today's complex systems. You can leverage Grafana alerts
-based on Dataset data to notify you when there are possible issues. More
+single pane of glass for today's complex systems. You can leverage Grafana
+alerts based on Dataset data to notify you when there are possible issues. More
 importantly, you'll soon be able to jump to Dataset's fast, easy and intuitive
 platform to quickly identify the underlying causes of issues that may arise.
 
@@ -21,140 +21,41 @@ platform to quickly identify the underlying causes of issues that may arise.
 assumes that an existing instance of Grafana already exists. If you need help
 bringing up a Grafana instance, please refer to the [documentation provided by
 Grafana](https://grafana.com/docs/installation/).
-* **A Dataset read log API Key**: A Dataset API key is required for Grafana to pull
-data from Dataset. You can obtain one by going to your account in the Dataset
-product and selecting the “API Keys” from the menu in the top right corner. You
-can find documentation on API Keys [here](https://www.scalyr.com/help/api#scalyr-api-keys).
+* **A Dataset read log API Key**: A Dataset API key is required for Grafana to
+pull data from Dataset. You can obtain one by going to your account in the
+Dataset product and selecting the “API Keys” from the menu in the top right
+corner. You can find documentation on API Keys
+[here](https://www.scalyr.com/help/api#scalyr-api-keys).
 
-## Getting started
+## Installation
 
-### Installing the latest / stable version with grafana-cli
+Using grafana-cli: `grafana-cli plugins install sentinelone-dataset-datasource`
 
-1. To install the stable version of the plugin using grafana-cli, run the following command:
+Alternatively can download it
+[here](https://github.com/scalyr/scalyr-grafana-datasource-plugin/releases/latest/)
+and unzip it manually into the Grafana plugins directory (eg
+`/var/lib/grafana/plugins`).  A restart of the Grafana server is required
+afterwards.
 
-   ```bash
-   grafana-cli --pluginUrl \
-   https://github.com/scalyr/scalyr-grafana-datasource-plugin/releases/download/3.0.1/sentinelone-dataset-datasource.zip \
-   plugins install sentinelone-dataset-datasource
-   ```
+## Configuration
 
-   Older versions can be downloaded from [github releases](https://github.com/scalyr/scalyr-grafana-datasource-plugin/releases).
-
-2. Adding plugins requires a restart of your grafana server.
-
-    For init.d based services you can use the command:
-
-    ```bash
-    sudo service grafana-server restart
-    ```
-
-    For systemd based services you can use the following:
-
-    ```bash
-    systemctl restart grafana-server
-    ```
-
-### Building a development version and installing manually
-
-1. To build and install the `development` version of the plugin, clone the
-[plugin repository](https://github.com/scalyr/scalyr-grafana-datasource-plugin) from GitHub.
-
-    ```bash
-    git  clone https://github.com/scalyr/scalyr-grafana-datasource-plugin.git
-    ```
-
-2. Build the Golang backend (with the version defined in go.mod, currently 1.16) using Mage
-
-    ```bash
-    mage
-    ```
-
-    This will build the executables in `dist/`
-
-    To install Mage (Golang make-like build tool):
-
-    ```bash
-    git clone https://github.com/magefile/mage $GOPATH/src/github.com/magefile/mage
-    cd $GOPATH/src/github.com/magefile/mage
-    git checkout tags/v1.12.1 # Specified in go.mod
-    go run bootstrap.go
-    ```
-
-    A `mage` executable should now be in `$GOPATH/bin/`.
-
-3. Build the Typescript frontend using LTS Node (>= v14) and Yarn
-
-    ```bash
-    yarn install --pure-lockfile # Install dependencies into node_modules
-    yarn build
-    ```
-
-    This will build and the frontend files in `dist/`
-
-    To install Yarn: `npm install --global yarn`
-
-
-5. For development versions, simply copy the files to the Grafana server plugin directory
-
-    ```bash
-    mkdir /var/lib/grafana/plugins/dataset
-    # copy files from dist/ into /var/lib/grafana/plugins/dataset
-    ```
-
-    Note that this is an unsigned plugin, and you must update your `grafana.ini` file to allow it adding the following line:
-
-   ```bash
-   allow_loading_unsigned_plugins = sentinelone-dataset-datasource
-   ```
-
-6. Adding plugins requires a restart of your grafana server.
-
-    For init.d based services you can use the command:
-
-    ```bash
-    sudo service grafana-server restart
-    ```
-
-    For systemd based services you can use the following:
-
-    ```bash
-    systemctl restart grafana-server
-    ```
-
-### Package and sign the plugin
-
-To sign and package the plugin for distribution:
-
-```bash
-export GRAFANA_API_KEY=<YOUR_API_KEY>
-npx @grafana/toolkit plugin:sign # This creates dist/MANIFEST.txt
-
-cp -r dist sentinelone-dataset-datasource
-zip -r sentinelone-dataset-datasource-$(jq -r .info.version sentinelone-dataset-datasource/plugin.json).zip sentinelone-dataset-datasource
-rm -rf sentinelone-dataset-datasource # Cleanup
-```
-
-References
-- https://grafana.com/docs/grafana/latest/developers/plugins/package-a-plugin/
-- https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/
-
-### Verify the Plugin was Installed
-
-1. In order to verify proper installation you must log in to your grafana instance
-   and navigate to **Configuration Settings -> Data Sources**.
+1. Log in to your grafana instance and navigate to **Configuration Settings ->
+   Data sources**.
 
     ![ConfigDataSource](https://raw.githubusercontent.com/scalyr/scalyr-grafana-datasource-plugin/go-rewrite-v2/src/img/ConfigDataSource.png)
 
-2. This will take you into the configuration page. If you already have other data
-   sources installed, you will see them show up here. Click on the **Add data source** button:
+2. This will take you into the configuration page. If you already have other
+   data sources installed, you will see them show up here. Click on the **Add
+   data source** button:
 
     ![DatasetConfig](https://raw.githubusercontent.com/scalyr/scalyr-grafana-datasource-plugin/go-rewrite-v2/src/img/DatasetConfig.png)
 
-3. If you enter "Dataset" in the search bar on the resulting page you should see "Dataset" grafana plugin show up as an option.
+3. If you enter "Dataset" in the search bar on the resulting page you should see
+   "Dataset" grafana plugin show up as an option.
 
     ![SearchForPlugin](https://raw.githubusercontent.com/scalyr/scalyr-grafana-datasource-plugin/go-rewrite-v2/src/img/SearchForPlugin.png)
 
-4. Click on ***“Select”***. This will take you to a configuration page where you
+4. Click on **Select**. This will take you to a configuration page where you
    insert your API key mentioned in the prerequisite section.
 
     ![PluginConfig](https://raw.githubusercontent.com/scalyr/scalyr-grafana-datasource-plugin/go-rewrite-v2/src/img/PluginConfig.png)
@@ -166,49 +67,59 @@ References
     |Dataset API Key | Your Scalyr Read Logs API Key|
     |Dataset URL | `https://www.scalyr.com` or `https://eu.scalyr.com` for EU users.|
 
-6. Click ***Save & Test*** to verify these settings are correct.
+6. Click **Save & Test** to verify these settings are correct.
+
 ## Using the Dataset Datasource
 
-Now that you’ve completed installing and configuring the Dataset data source plugin,
-lets go through an example of how you can start using it to create a dashboard
-using Scalyr data.
+Now that you’ve completed installing and configuring the Dataset data source
+plugin, lets go through an example of how you can start using it to create a
+dashboard using Scalyr data.
 
-1. Create a new dashboard by click Create > dashboard
+1. Create a new dashboard by click **Create -> Dashboard**.
 
     ![CreateDashboard](https://raw.githubusercontent.com/scalyr/scalyr-grafana-datasource-plugin/go-rewrite-v2/src/img/CreateDashboard.png)
 
-2. In the **“New dashboard”** box, select the **“Add a new panel** icon
+2. In the **New dashboard** box, select the **Add a new panel** icon.
 
-3. From the Data source dropdown, select **"Dataset"**.
+3. From the Data source dropdown, select **Dataset**.
 
     ![DataSetPlugin](https://raw.githubusercontent.com/scalyr/scalyr-grafana-datasource-plugin/go-rewrite-v2/src/img/DatasetPlugin.png)
 
-4. A 'Query Type' field allows to choose the type of query you wanted to search for
+4. A **Query Type** field allows to choose the type of query you wanted to
+   search for.
 
     ![QueryType](https://raw.githubusercontent.com/scalyr/scalyr-grafana-datasource-plugin/go-rewrite-v2/src/img/QueryType.png)
 
-5. 'Standard Query' - A standard query allows to search on Graph view, 
-    You can enter Graph Functions into the expression box and visualize the results. You can even enter and visualize Complex Expressions
-    Dataset [graphFunctions documentation](https://www.scalyr.com/help/dashboards#graphFunctions)
-    is a good resource to see the list of supported functions.
-    Enter expression and click the save button. In the image below, we've added a query to graph visualized the 
-    number of log messages that contain the word "error"
+5. **Standard Query** - A standard query allows to search on Graph view. You can
+   enter graph functions into the expression box and visualize the results. You
+   can even enter and visualize complex expressions.
+   [This](https://www.scalyr.com/help/dashboards#graphFunctions) is a good
+   resource to see the list of supported functions.
+
+   Enter an expression and click the save button. In the image below, we've
+   added a query to graph the number of log messages that contain the word
+   "error".
 
      ![StandardQuery](https://raw.githubusercontent.com/scalyr/scalyr-grafana-datasource-plugin/go-rewrite-v2/src/img/StandardQuery.png)
 
-6. 'Power Query' - Works similar to PQ search in Dataset app. You can enter rich set of commands for transforming
-    and manipulating data. Data can be viewed in Table format
-    Visit [this documentation](https://app.scalyr.com/help/power-queries) for more information on building Power Queries
+6. **Power Query** - Works similar to PQ search in Dataset app. You can enter
+   rich set of commands for transforming and manipulating data. Data can be
+   viewed in table format. Visit
+   [this page](https://app.scalyr.com/help/power-queries) for more information
+   on building Power Queries.
 
      ![PowerQuery](https://raw.githubusercontent.com/scalyr/scalyr-grafana-datasource-plugin/go-rewrite-v2/src/img/PowerQuery.png)
 
-You’ve successfully installed, configured and created a graph in Grafana using Dataset data!
+You’ve successfully installed, configured and created a graph in Grafana using
+Dataset data!
 
-Note: you can add multiple queries to a visualization to plot multiple series on the same graph.
+Note: you can add multiple queries to a visualization to plot multiple series on
+the same graph.
 
 ## Variables
 
-For general information on Grafana variables see the [Grafana documentation](https://grafana.com/docs/grafana/latest/reference/templating/)
+For general information on Grafana variables see the
+[Grafana documentation](https://grafana.com/docs/grafana/latest/reference/templating/)
 
 Queries support all Grafana variable substitution syntaxes, for example:
 
@@ -218,8 +129,8 @@ $varname
 ${varname:option}
 ```
 
-For multi-value variables there is a custom default substitution method, the values will be quoted and separated with
-commas, for example:
+For multi-value variables there is a custom default substitution method, the
+values will be quoted and separated with commas, for example:
 
 ```bash
 "value1","value2","value3"

diff --git a/pkg/plugin/plugin.go b/pkg/plugin/plugin.go
@@ -295,7 +295,7 @@ func (d *DataSetDatasource) CheckHealth(_ context.Context, req *backend.CheckHea
 	if statusCode != 200 {
 		return &backend.CheckHealthResult{
 			Status:  backend.HealthStatusError,
-			Message: fmt.Sprintf("DataSet returned response code %d", statusCode),
+			Message: fmt.Sprintf("Failed to connect to DataSet, please inspect the Grafana server log for details"),
 		}, nil
 	}
 

diff --git a/src/plugin.json b/src/plugin.json
@@ -43,8 +43,8 @@
         "path": "img/DatasetConfig.png"
       }
     ],
-    "version": "3.0.1",
-    "updated": "2022-05-04"
+    "version": "3.0.2",
+    "updated": "2022-05-06"
   },
   "dependencies": {
     "grafanaDependency": ">=7.0.0",