Merge pull request #4 from xiangshen-dk/release

Update the files based on review feedback.

Author: charlesbaer

CONTRIBUTING.md

@@ -25,6 +25,52 @@ This project follows
 
 ## Contribution process
 
+### Build the plugin
+
+If you download the source, you need to build the plugin. Make sure you have all the prerequisites installed and configured:
+
+- Grafana 9.0
+- Go 1.16+
+- Mage
+- NodeJS
+- yarn
+
+Under the source directory, run the following commands:
+
+```bash
+yarn install
+yarn build
+
+#Run the following to update Grafana plugin SDK for Go dependency to the latest minor version:
+
+go get -u github.com/grafana/grafana-plugin-sdk-go
+go mod tidy
+
+#Build backend plugin binaries for Linux, Windows and Darwin to dist directory:
+mage -v
+```
+
+More details, please read [the doc](https://grafana.com/tutorials/build-a-data-source-backend-plugin/).
+### Grafana Configuration
+
+To have Grafana detect this plugin and make it available for use, two entries must be modified in the Grafana config file. See [Grafana's Documentation](https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/) for more details, including the default location of the config file depending on platform.
+
+First, set `paths.plugins` to point to where this repo has been downloaded locally. The final build artifacts will be under the `dist` directory:
+
+```ini
+[paths]
+plugins = /Users/alice/grafana/googlecloud-logging-datasource/dist
+```
+
+Next, update `plugins.allow_loading_unsigned_plugins` so that this plugin's ID is in the list:
+
+```ini
+[plugins]
+allow_loading_unsigned_plugins = googlecloud-logging-datasource
+```
+
+With these settings updated, we can now restart Grafana and expect the plugin to be available. The specific command to restart Grafana will depend on what platform it's running on, with the various options documented by [Grafana](https://grafana.com/docs/grafana/v9.0/setup-grafana/restart-grafana/).
+
 ### Code Reviews
 
 All submissions, including submissions by project members, require review. We

README.md

@@ -11,54 +11,28 @@ which allows users to query and visualize their Google Cloud logs in Grafana.
 
 Download this plugin to the machine Grafana is running on, either using `git clone` or simply downloading it as a ZIP file. For the purpose of this guide, we'll assume the user "alice" has downloaded it into their local directory "/Users/alice/grafana/". If you are running the Grafana server using a user such as `grafana`, make sure the user has access to the directory.
 
-### Build the plugin
+### Enable Cloud Resource Manager API
 
-If you download the source, you need to build the plugin. Make sure you have all the prerequisites installed and configured:
+You need to enable the resource manager API. Otherwise, your cloud projects will not be displayed in the dropdown menu.
 
-- Grafana 9.0
-- Go 1.16+
-- Mage
-- NodeJS
-- yarn
+You can following the those steps to enable it:
 
-Under the source directory, run the following commands:
+1. Navigate to the [cloud resource manager API page](https://console.cloud.google.com/apis/library/cloudresourcemanager.googleapis.com]) in GCP and select your project
+2. Press the `Enable` button
 
-```bash
-yarn install
-yarn build
+### Generate a JWT file
 
-#Run the following to update Grafana plugin SDK for Go dependency to the latest minor version:
+1.  If you don't have gcp project, add new gcp project. [link](https://cloud.google.com/resource-manager/docs/creating-managing-projects#console)
+2.  Open the [Credentials](https://console.developers.google.com/apis/credentials) page in the Google API Console.
+3.  Click **Create Credentials** then click **Service account**.
+4.  On the Create service account page, enter the Service account details.
+5.  On the `Create service account` page, fill in the `Service account details` and then click `Create and Continue`
+6.  On the `Grant this service account access to project` section, select the `Logs Viewer` role under `Logging` to the service account. Click `Done`
+7.  In the next step, click the service account you just created. Under the `Keys` tabl and select `Add key` and `Create new key`
+8.  Choose key type `JSON` and click `Create`. A JSON key file will be created and downloaded to your computer
 
-go get -u github.com/grafana/grafana-plugin-sdk-go
-go mod tidy
-
-#Build backend plugin binaries for Linux, Windows and Darwin to dist directory:
-mage -v
-```
-
-More details, please read [the doc](https://grafana.com/tutorials/build-a-data-source-backend-plugin/).
 ### Grafana Configuration
 
-To have Grafana detect this plugin and make it available for use, two entries must be modified in the Grafana config file. See [Grafana's Documentation](https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/) for more details, including the default location of the config file depending on platform.
-
-First, set `paths.plugins` to point to where this repo has been downloaded locally. The final build artifacts will be under the `dist` directory:
-
-```ini
-[paths]
-plugins = /Users/alice/grafana/googlecloud-logging-datasource/dist
-```
-
-Next, update `plugins.allow_loading_unsigned_plugins` so that this plugin's ID is in the list:
-
-```ini
-[plugins]
-allow_loading_unsigned_plugins = googlecloud-logging-datasource
-```
-
-With these settings updated, we can now restart Grafana and expect the plugin to be available. The specific command to restart Grafana will depend on what platform it's running on, with the various options documented by [Grafana](https://grafana.com/docs/grafana/v9.0/setup-grafana/restart-grafana/).
-
-## Configuration
-
 1. With Grafana restarted, navigate to `Configuration -> Data sources` (or the route `/datasources`)
 2. Click "Add data source"
 3. Select "Google Cloud Logging"

go.mod

@@ -1,4 +1,4 @@
-module github.com/GoogleCloudPlatform/cloud-logging-grafana-data-source-plugin
+module github.com/GoogleCloudPlatform/cloud-logging-data-source-plugin
 
 go 1.16
 

package.json

@@ -13,10 +13,10 @@
   "author": "Google Inc.",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@grafana/data": "latest",
-    "@grafana/runtime": "latest",
-    "@grafana/toolkit": "latest",
-    "@grafana/ui": "latest",
+    "@grafana/data": "^9.0.2",
+    "@grafana/runtime": "^9.0.2",
+    "@grafana/toolkit": "^9.0.2",
+    "@grafana/ui": "^9.0.2",
     "@types/lodash": "latest"
   },
   "resolutions": {
@@ -26,6 +26,10 @@
     "node": ">=14"
   },
   "dependencies": {
-    "@grafana/google-sdk": "^0.0.3"
+    "@grafana/google-sdk": "^0.0.3",
+    "@grafana/data": "^9.0.2",
+    "@grafana/runtime": "^9.0.2",
+    "@grafana/toolkit": "^9.0.2",
+    "@grafana/ui": "^9.0.2"
   }
 }

pkg/main.go

@@ -17,9 +17,9 @@ package main
 import (
 	"os"
 
+	"github.com/GoogleCloudPlatform/cloud-logging-data-source-plugin/pkg/plugin"
 	"github.com/grafana/grafana-plugin-sdk-go/backend/datasource"
 	"github.com/grafana/grafana-plugin-sdk-go/backend/log"
-	"github.com/GoogleCloudPlatform/cloud-logging-grafana-data-source-plugin/pkg/plugin"
 )
 
 func main() {

pkg/plugin/cloudlogging/client.go

@@ -113,7 +113,7 @@ func (c *Client) ListProjects(ctx context.Context) ([]string, error) {
 func (c *Client) TestConnection(ctx context.Context, projectID string) error {
 	start := time.Now()
 	defer func() {
-		log.DefaultLogger.Info("Finished testConnection", "duration", time.Since(start).String())
+		log.DefaultLogger.Debug("Finished testConnection", "duration", time.Since(start).String())
 	}()
 
 	it := c.lClient.ListLogEntries(ctx, &loggingpb.ListLogEntriesRequest{
@@ -149,7 +149,7 @@ func (c *Client) ListLogs(ctx context.Context, q *Query) ([]*loggingpb.LogEntry,
 
 	start := time.Now()
 	defer func() {
-		log.DefaultLogger.Info("Finished listing logs", "duration", time.Since(start).String())
+		log.DefaultLogger.Debug("Finished listing logs", "duration", time.Since(start).String())
 	}()
 
 	it := c.lClient.ListLogEntries(ctx, &req)

pkg/plugin/cloudlogging/cloudlogging_test.go

@@ -18,8 +18,8 @@ import (
 	"errors"
 	"testing"
 
+	"github.com/GoogleCloudPlatform/cloud-logging-data-source-plugin/pkg/plugin/cloudlogging"
 	"github.com/grafana/grafana-plugin-sdk-go/data"
-	"github.com/GoogleCloudPlatform/cloud-logging-grafana-data-source-plugin/pkg/plugin/cloudlogging"
 	"github.com/stretchr/testify/require"
 	"google.golang.org/genproto/googleapis/api/monitoredres"
 	ltype "google.golang.org/genproto/googleapis/logging/type"

pkg/plugin/mocks/API.go

@@ -23,11 +23,11 @@ import (
 	"strings"
 	"time"
 
+	"github.com/GoogleCloudPlatform/cloud-logging-data-source-plugin/pkg/plugin/cloudlogging"
 	"github.com/grafana/grafana-plugin-sdk-go/backend"
 	"github.com/grafana/grafana-plugin-sdk-go/backend/instancemgmt"
 	"github.com/grafana/grafana-plugin-sdk-go/backend/log"
 	"github.com/grafana/grafana-plugin-sdk-go/data"
-	"github.com/GoogleCloudPlatform/cloud-logging-grafana-data-source-plugin/pkg/plugin/cloudlogging"
 )
 
 // Make sure CloudLoggingDatasource implements required interfaces
@@ -123,7 +123,7 @@ type ListProjectsResponse struct {
 //
 // Currently only projects are fetched, other requests receive a 404
 func (d *CloudLoggingDatasource) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error {
-	log.DefaultLogger.Info("CallResource called")
+	// log.DefaultLogger.Info("CallResource called")
 
 	// Right now we only support calls to `/projects`
 	resource := req.Path
@@ -163,7 +163,7 @@ func (d *CloudLoggingDatasource) CallResource(ctx context.Context, req *backend.
 // The QueryDataResponse contains a map of RefID to the response for each query, and each response
 // contains Frames ([]*Frame).
 func (d *CloudLoggingDatasource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
-	log.DefaultLogger.Info("QueryData called")
+	// log.DefaultLogger.Info("QueryData called")
 
 	// create response struct
 	response := backend.NewQueryDataResponse()
@@ -249,7 +249,7 @@ func (d *CloudLoggingDatasource) query(ctx context.Context, pCtx backend.PluginC
 // datasource configuration page which allows users to verify that
 // a datasource is working as expected.
 func (d *CloudLoggingDatasource) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) {
-	log.DefaultLogger.Info("CheckHealth called")
+	// log.DefaultLogger.Info("CheckHealth called")
 
 	var status = backend.HealthStatusOk
 	settings := req.PluginContext.DataSourceInstanceSettings

pkg/plugin/plugin.go

@@ -20,8 +20,8 @@ import (
 	"testing"
 	"time"
 
-	"github.com/GoogleCloudPlatform/cloud-logging-grafana-data-source-plugin/pkg/plugin/cloudlogging"
-	"github.com/GoogleCloudPlatform/cloud-logging-grafana-data-source-plugin/pkg/plugin/mocks"
+	"github.com/GoogleCloudPlatform/cloud-logging-data-source-plugin/pkg/plugin/cloudlogging"
+	"github.com/GoogleCloudPlatform/cloud-logging-data-source-plugin/pkg/plugin/mocks"
 	"github.com/grafana/grafana-plugin-sdk-go/backend"
 	"github.com/grafana/grafana-plugin-sdk-go/data"
 	"github.com/stretchr/testify/mock"