prep rel1.5 (#124)

Author: xiangshen-dk

CHANGELOG.md

@@ -1,4 +1,10 @@
 # Changelog
+## 1.5.0 (2025-05-29)
+* Update plugin to support access token auth
+* Add datasource syncer
+* Fix message from jsonPayload doesn't show up in Grafana
+* Update a few dependencies
+
 ## 1.4.1 (2024-03-22)
 * Fix an encoding issue for parentheses
 * Fix cloud logging link scope issue

README.md

@@ -19,7 +19,7 @@ You can follow the steps to enable it:
 
 ### Generate a JWT file & Assign IAM Permissions
 
-1. If you don't have a GCP project, add a new GCP project. [link](https://cloud.google.com/resource-manager/docs/creating-managing-projects#console)
+1. If you don't have a GCP project, add a new GCP project [here](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
@@ -32,7 +32,7 @@ If you want to access logs in multiple cloud projects, you need to ensure the se
 
 If you host Grafana on a GCE VM, you can also use the [Compute Engine service account](https://cloud.google.com/compute/docs/access/service-accounts#serviceaccount). You need to make sure the service account has sufficient permissions to access the scopes and logs in all projects.
 
-Similar to [Prometheus data sources on Google Cloud](https://cloud.google.com/stackdriver/docs/managed-prometheus/query#use-serverless), you can also configure a scheduled job to use an OAuth2 access token to view the logs. Please follow the steps in the [data source syncer README](./datasource-syncer/README.md) to configure it.
+Similar to [Prometheus data sources on Google Cloud](https://cloud.google.com/stackdriver/docs/managed-prometheus/query#use-serverless), you can also configure a scheduled job to use an OAuth2 access token to view the logs. Please follow the steps in the [data source syncer README](https://github.com/GoogleCloudPlatform/cloud-logging-data-source-plugin/blob/main/datasource-syncer/README.md) to configure it.
 
 ### Service account impersonation
 You can also configure the plugin to use [service account impersonation](https://cloud.google.com/iam/docs/service-account-impersonation).
@@ -43,8 +43,8 @@ by this plugin needs logging read and project list permissions.
 1. With Grafana restarted, navigate to `Configuration -> Data sources` (or the route `/datasources`)
 2. Click "Add data source"
 3. Select "Google Cloud Logging"
-4. Provide credentials in a JWT file, either by using the file selector or pasting the contents of the file.
-5. Click "Save & test" to test that logs can be queried from Cloud Logging.
+4. Provide credentials from your JWT file, either by uploading it using the file selector or by pasting its contents directly into the designated field
+5. Click "Save & test" to test that logs can be queried from Cloud Logging
 
 ![image info](https://github.com/GoogleCloudPlatform/cloud-logging-data-source-plugin/blob/main/src/img/cloud_logging_config.png?raw=true)
 

datasource-syncer/README.md

@@ -141,9 +141,9 @@ and [Cloud Scheduler](https://cloud.google.com/scheduler), do the following:
 
     ```bash
     # These values are required.
-    export GRAFANA_INSTANCE_URL=YOUR_GRAFANA_INSTANCE_URL # The Grafana instance URL from step 2. This is a URL. Include "http://" or "https://".
-    export GRAFANA_DATASOURCE_UID=YOUR_GRAFANA_DATASOURCE_UID # The Grafana data source UID from step 3. This is not a URL.
-    export GRAFANA_SERVICE_ACCOUNT_TOKEN=YOUR_GRAFANA_SERVICE_ACCOUNT_TOKEN # The Grafana service account token from step 4.
+    export GRAFANA_INSTANCE_URL=YOUR_GRAFANA_INSTANCE_URL # The Grafana instance URL from step 3. This is a URL. Include "http://" or "https://".
+    export GRAFANA_DATASOURCE_UID=YOUR_GRAFANA_DATASOURCE_UID # The Grafana data source UID from step 4. This is not a URL.
+    export GRAFANA_SERVICE_ACCOUNT_TOKEN=YOUR_GRAFANA_SERVICE_ACCOUNT_TOKEN # The Grafana service account token from step 5.
     ```
 
 1. Create a secret in Secret Manager:
@@ -212,8 +212,11 @@ and [Cloud Scheduler](https://cloud.google.com/scheduler), do the following:
 
    It can take up to 15 seconds for the data source to be updated.
 
-1. Go to your newly configured Grafana data source and verify the **Access Token
-   ** field has the value `configured` and the **Project ID** field has your cloud project id. You might have to refresh the page. Once verified, go to the bottom
+1. Go to your newly configured Grafana data source and verify the **Access Token**
+   field has the value `configured` and the **Project ID** field displays the Google
+   Cloud Project ID you configured (e.g., the value of your ${PROJECT_ID} variable).
+
+   You might have to refresh the page. Once verified, go to the bottom
    of the page, select **Save & test**, and ensure you see a green checkmark saying that
    the datasource is properly configured. You need to select **Save & test** at
-   least once to ensure that label autocompletion in Grafana works.
+   least once to ensure that label autocompletion in Grafana works.