Logs: Don't add console link to every field in the logs response and prepare 12.2.0 (#238)

Author: idastambuk

CHANGELOG.md

@@ -1,5 +1,71 @@
 # Changelog
 
+## 12.2.0
+
+- Logs: Don't add console link to every field in the logs response in [#238](https://github.com/grafana/grafana-cloudwatch-datasource/pull/238)
+- Add issue workflows and templates in [#108](https://github.com/grafana/grafana-cloudwatch-datasource/pull/108)
+- Update dependabot groups in [#186](https://github.com/grafana/grafana-cloudwatch-datasource/pull/186)
+- Add syntax highlighting and autocomplete for logs diff command in [#185](https://github.com/grafana/grafana-cloudwatch-datasource/pull/185)
+- Refactor logs language tests in [#184](https://github.com/grafana/grafana-cloudwatch-datasource/pull/184)
+- Upgrade yarn to v4.10.3 in [#203](https://github.com/grafana/grafana-cloudwatch-datasource/pull/203)
+- Update gitignore for yarn files in [#215](https://github.com/grafana/grafana-cloudwatch-datasource/pull/215)
+- CD: Publish Github release directly, skipping draft in [#179](https://github.com/grafana/grafana-cloudwatch-datasource/pull/179)
+- Use the correct metric name for errors per function panel in the AWS Lambda sample dashboard in [#160](https://github.com/grafana/grafana-cloudwatch-datasource/pull/160)
+
+- Chore: bump github.com/aws/smithy-go from 1.23.0 to 1.23.1 in [#246](https://github.com/grafana/grafana-cloudwatch-datasource/pull/246)
+- Chore: bump github.com/grafana/grafana-plugin-sdk-go from 0.280.0 to 0.281.0 in [#236](https://github.com/grafana/grafana-cloudwatch-datasource/pull/236)
+- Chore: bump @types/node from 22.18.9 to 22.18.10 in [#231](https://github.com/grafana/grafana-cloudwatch-datasource/pull/231)
+- Chore: bump @types/node from 22.18.8 to 22.18.9 in [#228](https://github.com/grafana/grafana-cloudwatch-datasource/pull/228)
+- Chore: bump @typescript-eslint/eslint-plugin from 8.37.0 to 8.45.0 in [#226](https://github.com/grafana/grafana-cloudwatch-datasource/pull/226)
+- Chore: bump the npm-patch-dev-dependencies group with 3 updates in [#224](https://github.com/grafana/grafana-cloudwatch-datasource/pull/224)
+- Chore: bump typescript from 5.8.3 to 5.9.2 in [#222](https://github.com/grafana/grafana-cloudwatch-datasource/pull/222)
+- Chore: bump @typescript-eslint/parser from 8.42.0 to 8.44.1 in [#221](https://github.com/grafana/grafana-cloudwatch-datasource/pull/221)
+- Chore: bump @grafana/plugin-ui from 0.10.9 to 0.10.10 in [#218](https://github.com/grafana/grafana-cloudwatch-datasource/pull/218)
+- Chore: bump eslint from 9.31.0 to 9.36.0 in [#217](https://github.com/grafana/grafana-cloudwatch-datasource/pull/217)
+- Chore: bump eslint-plugin-jsdoc from 51.4.1 to 54.5.0 in [#214](https://github.com/grafana/grafana-cloudwatch-datasource/pull/214)
+- Chore: bump @eslint/js from 9.34.0 to 9.36.0 in [#212](https://github.com/grafana/grafana-cloudwatch-datasource/pull/212)
+- Chore: bump the npm-patch-dev-dependencies group with 3 updates in [#211](https://github.com/grafana/grafana-cloudwatch-datasource/pull/211)
+- Chore: bump @playwright/test from 1.54.2 to 1.55.1 in [#210](https://github.com/grafana/grafana-cloudwatch-datasource/pull/210)
+- Chore: bump github.com/grafana/grafana-aws-sdk from 1.2.0 to 1.3.0 in [#208](https://github.com/grafana/grafana-cloudwatch-datasource/pull/208)
+- Chore: bump github.com/grafana/grafana-plugin-sdk-go from 0.279.0 to 0.280.0 in [#206](https://github.com/grafana/grafana-cloudwatch-datasource/pull/206)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/cloudwatch from 1.50.0 to 1.50.1 in [#201](https://github.com/grafana/grafana-cloudwatch-datasource/pull/201)
+- Chore: bump actions/checkout from 4 to 5 in [#200](https://github.com/grafana/grafana-cloudwatch-datasource/pull/200)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/cloudwatch from 1.49.3 to 1.50.0 in [#199](https://github.com/grafana/grafana-cloudwatch-datasource/pull/199)
+- Chore: bump @typescript-eslint/parser from 8.37.0 to 8.42.0 in [#196](https://github.com/grafana/grafana-cloudwatch-datasource/pull/196)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/ec2 from 1.251.0 to 1.251.2 in [#195](https://github.com/grafana/grafana-cloudwatch-datasource/pull/195)
+- Chore: bump actions/checkout from 4 to 5 in [#126](https://github.com/grafana/grafana-cloudwatch-datasource/pull/126)
+- Chore: bump actions/setup-node from 4 to 5 in [#171](https://github.com/grafana/grafana-cloudwatch-datasource/pull/171)
+- Chore: bump @swc/core from 1.13.3 to 1.13.5 in [#194](https://github.com/grafana/grafana-cloudwatch-datasource/pull/194)
+- Chore: bump @eslint/js from 9.32.0 to 9.34.0 in [#193](https://github.com/grafana/grafana-cloudwatch-datasource/pull/193)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/resourcegroupstaggingapi from 1.30.3 to 1.30.4 in [#192](https://github.com/grafana/grafana-cloudwatch-datasource/pull/192)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/ec2 from 1.250.0 to 1.251.0 in [#191](https://github.com/grafana/grafana-cloudwatch-datasource/pull/191)
+- Chore: bump @grafana/eslint-config from 8.1.0 to 8.2.0 in [#137](https://github.com/grafana/grafana-cloudwatch-datasource/pull/137)
+- Chore: bump @types/node from 22.17.0 to 22.18.1 in [#190](https://github.com/grafana/grafana-cloudwatch-datasource/pull/190)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/oam from 1.22.2 to 1.22.3 in [#189](https://github.com/grafana/grafana-cloudwatch-datasource/pull/189)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs from 1.57.3 to 1.57.4 in [#188](https://github.com/grafana/grafana-cloudwatch-datasource/pull/188)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/ec2 from 1.249.0 to 1.250.0 in [#187](https://github.com/grafana/grafana-cloudwatch-datasource/pull/187)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/oam from 1.22.1 to 1.22.2 in [#183](https://github.com/grafana/grafana-cloudwatch-datasource/pull/183)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs from 1.57.1 to 1.57.3 in [#182](https://github.com/grafana/grafana-cloudwatch-datasource/pull/182)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/resourcegroupstaggingapi from 1.30.2 to 1.30.3 in [#181](https://github.com/grafana/grafana-cloudwatch-datasource/pull/181)
+- Chore: bump github.com/prometheus/client_golang from 1.23.0 to 1.23.2 in [#176](https://github.com/grafana/grafana-cloudwatch-datasource/pull/176)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/ec2 from 1.248.0 to 1.249.0 in [#178](https://github.com/grafana/grafana-cloudwatch-datasource/pull/178)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/cloudwatch from 1.49.1 to 1.49.3 in [#180](https://github.com/grafana/grafana-cloudwatch-datasource/pull/180)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/oam from 1.21.3 to 1.22.1 in [#175](https://github.com/grafana/grafana-cloudwatch-datasource/pull/175)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/resourcegroupstaggingapi from 1.30.1 to 1.30.2 in [#173](https://github.com/grafana/grafana-cloudwatch-datasource/pull/173)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/cloudwatch from 1.48.2 to 1.49.1 in [#174](https://github.com/grafana/grafana-cloudwatch-datasource/pull/174)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/ec2 from 1.247.1 to 1.248.0 in [#172](https://github.com/grafana/grafana-cloudwatch-datasource/pull/172)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/ec2 from 1.245.2 to 1.247.1 in [#169](https://github.com/grafana/grafana-cloudwatch-datasource/pull/169)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/resourcegroupstaggingapi from 1.29.2 to 1.30.1 in [#170](https://github.com/grafana/grafana-cloudwatch-datasource/pull/170)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs from 1.56.2 to 1.57.1 in [#168](https://github.com/grafana/grafana-cloudwatch-datasource/pull/168)
+- Chore: bump github.com/aws/aws-sdk-go-v2 from 1.38.2 to 1.38.3 in [#161](https://github.com/grafana/grafana-cloudwatch-datasource/pull/161)
+- Chore: bump golang.org/x/sync from 0.16.0 to 0.17.0 in [#162](https://github.com/grafana/grafana-cloudwatch-datasource/pull/162)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/cloudwatch from 1.48.0 to 1.48.2 in [#156](https://github.com/grafana/grafana-cloudwatch-datasource/pull/156)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/oam from 1.21.2 to 1.21.3 in [#157](https://github.com/grafana/grafana-cloudwatch-datasource/pull/157)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/ec2 from 1.243.0 to 1.245.1 in [#155](https://github.com/grafana/grafana-cloudwatch-datasource/pull/155)
+- Chore: bump github.com/stretchr/testify from 1.10.0 to 1.11.0 in [#153](https://github.com/grafana/grafana-cloudwatch-datasource/pull/153)
+- Chore: bump github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs from 1.56.0 to 1.56.2 in [#152](https://github.com/grafana/grafana-cloudwatch-datasource/pull/152)
+
+
 ## 12.1.3
 
 - Add clusterId to dimension list for AWS/ElastiCache namespace [#151](https://github.com/grafana/grafana-cloudwatch-datasource/pull/151)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "grafana-cloudwatch-datasource",
-  "version": "12.1.3",
+  "version": "12.2.0",
   "scripts": {
     "build": "webpack -c ./webpack.config.ts --env production",
     "dev": "webpack -w -c ./webpack.config.ts --env development",

src/components/QueryEditor/LogsQueryEditor/code-editors/PPLQueryEditor.tsx

@@ -96,6 +96,7 @@ export const PPLQueryEditor = (props: LogsCodeEditorProps) => {
     );
   };
   return (
+    <>
     <CodeEditor
       {...codeEditorCommonProps}
       language={language.id}
@@ -111,5 +112,6 @@ export const PPLQueryEditor = (props: LogsCodeEditorProps) => {
       onEditorDidMount={onEditorMount}
       onEditorWillUnmount={() => disposalRef.current?.dispose()}
     />
+    </>
   );
 };

src/datasource.test.ts

@@ -28,7 +28,7 @@ import * as templateUtils from './utils/templateVariableUtils';
 jest.mock('./utils/templateVariableUtils', () => {
   return {
     __esModule: true, // getting 'cannot redefine getVariableName' otherwise
-    ...jest.requireActual('./utils/templateVariableUtils')
+    ...jest.requireActual('./utils/templateVariableUtils'),
   };
 });
 
@@ -313,7 +313,7 @@ describe('datasource', () => {
       });
     });
 
-    it('should add links to log queries', async () => {
+    it('should add a data link field to log queries', async () => {
       const { datasource } = setupForLogs();
 
       const observable = datasource.query({
@@ -351,7 +351,7 @@ describe('datasource', () => {
         },
       ]);
 
-      expect(emits[0].data[0].fields.find((f: Field) => f.name === '@message').config.links).toMatchObject([
+      expect(emits[0].data[0].fields.find((f: Field) => f.name === '').config.links).toMatchObject([
         {
           title: 'View in CloudWatch console',
           url: "https://us-west-1.console.aws.amazon.com/cloudwatch/home?region=us-west-1#logs-insights:queryDetail=~(end~'2016-12-31T16*3a00*3a00.000Z~start~'2016-12-31T15*3a00*3a00.000Z~timeType~'ABSOLUTE~tz~'UTC~editorString~'some*20query~isLiveTail~false~source~(~'test))",

src/utils/datalinks.test.ts

@@ -1,4 +1,4 @@
-import { DataQueryRequest, DataQueryResponse, dateMath } from '@grafana/data';
+import { DataQueryRequest, DataQueryResponse, dateMath, FieldType } from '@grafana/data';
 import { DataSourceSrv, setDataSourceSrv } from '@grafana/runtime';
 
 import { CloudWatchQuery } from '../types';
@@ -18,10 +18,12 @@ describe('addDataLinksToLogsResponse', () => {
             {
               name: '@message',
               config: {},
+              values: ['log message one', 'log message two'],
             },
             {
               name: '@xrayTraceId',
               config: {},
+              values: ['id1', 'id2'],
             },
           ],
           refId: 'A',
@@ -64,14 +66,6 @@ describe('addDataLinksToLogsResponse', () => {
           fields: [
             {
               name: '@message',
-              config: {
-                links: [
-                  {
-                    url: "https://us-east-1.console.aws.amazon.com/cloudwatch/home?region=us-east-1#logs-insights:queryDetail=~(end~'2016-12-31T16*3a00*3a00.000Z~start~'2016-12-31T15*3a00*3a00.000Z~timeType~'ABSOLUTE~tz~'UTC~editorString~'stats*20count*28*40message*29*20by*20bin*281h*29~isLiveTail~false~source~(~'fake-log-group-one~'fake-log-group-two))",
-                    title: 'View in CloudWatch console',
-                  },
-                ],
-              },
             },
             {
               name: '@xrayTraceId',
@@ -89,14 +83,27 @@ describe('addDataLinksToLogsResponse', () => {
                 ],
               },
             },
+            {
+              name: '',
+              type: FieldType.string,
+              values: ['View this query in CloudWatch console', 'View this query in CloudWatch console'],
+              config: {
+                links: [
+                  {
+                    url: "https://us-east-1.console.aws.amazon.com/cloudwatch/home?region=us-east-1#logs-insights:queryDetail=~(end~'2016-12-31T16*3a00*3a00.000Z~start~'2016-12-31T15*3a00*3a00.000Z~timeType~'ABSOLUTE~tz~'UTC~editorString~'stats*20count*28*40message*29*20by*20bin*281h*29~isLiveTail~false~source~(~'fake-log-group-one~'fake-log-group-two))",
+                    title: 'View in CloudWatch console',
+                  },
+                ],
+              },
+            },
           ],
           refId: 'A',
         },
       ],
     });
   });
 
-  it('should add data links to response from log groups, trimming :*', async () => {
+  it('should add a data link field to response from log groups, trimming :*', async () => {
     const mockResponse: DataQueryResponse = {
       data: [
         {
@@ -140,6 +147,11 @@ describe('addDataLinksToLogsResponse', () => {
           fields: [
             {
               name: '@message',
+            },
+            {
+              name: '',
+              type: FieldType.string,
+              values: [],
               config: {
                 links: [
                   {
@@ -197,6 +209,11 @@ describe('addDataLinksToLogsResponse', () => {
           fields: [
             {
               name: '@message',
+            },
+            {
+              name: '',
+              type: FieldType.string,
+              values: [],
               config: {
                 links: [
                   {

src/utils/datalinks.ts

@@ -1,4 +1,12 @@
-import { DataFrame, DataLink, DataQueryRequest, DataQueryResponse, ScopedVars, TimeRange } from '@grafana/data';
+import {
+  DataFrame,
+  DataLink,
+  DataQueryRequest,
+  DataQueryResponse,
+  FieldType,
+  ScopedVars,
+  TimeRange,
+} from '@grafana/data';
 import { getDataSourceSrv } from '@grafana/runtime';
 
 import { AwsUrl, encodeUrl } from '../aws_url';
@@ -33,14 +41,22 @@ export async function addDataLinksToLogsResponse(
         if (xrayLink) {
           field.config.links = [xrayLink];
         }
-      } else {
-        // Right now we add generic link to open the query in xray console to every field so it shows in the logs row
-        // details. Unfortunately this also creates link for all values inside table which look weird.
-        field.config.links = [
-          createAwsConsoleLink(curTarget, request.range, interpolatedRegion, replace, getVariableValue),
-        ];
       }
     }
+
+    // add a link to the cloudwatch console as a separate field that will be displayed as a link
+    if (dataFrame.fields.length) {
+      dataFrame.fields.push({
+        name: '',
+        type: FieldType.string,
+        values: dataFrame.fields[0]?.values?.length
+          ? new Array(dataFrame.fields[0].values.length).fill('View this query in CloudWatch console')
+          : [],
+        config: {
+          links: [createAwsConsoleLink(curTarget, request.range, interpolatedRegion, replace, getVariableValue)],
+        },
+      });
+    }
   }
 }