root
/
grafana
mirror of https://github.com/grafana/grafana.git
1
0
Fork 0
Code Issues Actions 236 Packages Projects Releases Wiki Activity

Cloudwatch: Round up endTime in GetMetricData to next minute (#89341) 

* Add cloudWatchRoundUpEndTime feature toggle
This commit is contained in:
Ida Štambuk 2024-06-27 17:10:28 +02:00 committed by GitHub
parent 0aaf820fd9
commit ba5b33227c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 56 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md
View File

@ -63,6 +63,7 @@ Most [generally available](https://grafana.com/docs/release-life-cycle/#general-
| `alertingQueryOptimization` | Optimizes eligible queries in order to reduce load on datasources | |
| `cloudWatchNewLabelParsing` | Updates CloudWatch label parsing to be more accurate | Yes |
| `pluginProxyPreserveTrailingSlash` | Preserve plugin proxy trailing slash. | |
| `cloudWatchRoundUpEndTime` | Round up end time for metric queries to the next minute to avoid missing data | Yes |
## Public preview feature toggles

1
packages/grafana-data/src/types/featureToggles.gen.ts
View File

@ -198,4 +198,5 @@ export interface FeatureToggles {
passScopeToDashboardApi?: boolean;
alertingApiServer?: boolean;
dashboardRestoreUI?: boolean;
cloudWatchRoundUpEndTime?: boolean;
}

7
pkg/services/featuremgmt/registry.go
View File

@ -1353,6 +1353,13 @@ var (
Owner: grafanaFrontendPlatformSquad,
Expression: "false", // enabled by default
},
{
Name: "cloudWatchRoundUpEndTime",
Description: "Round up end time for metric queries to the next minute to avoid missing data",
Stage: FeatureStageGeneralAvailability,
Owner: awsDatasourcesSquad,
Expression: "true",
},
}
)

1
pkg/services/featuremgmt/toggles_gen.csv
View File

@ -179,3 +179,4 @@ zanzana,experimental,@grafana/identity-access-team,false,false,false
passScopeToDashboardApi,experimental,@grafana/dashboards-squad,false,false,false
alertingApiServer,experimental,@grafana/alerting-squad,false,true,false
dashboardRestoreUI,experimental,@grafana/grafana-frontend-platform,false,false,false
cloudWatchRoundUpEndTime,GA,@grafana/aws-datasources,false,false,false

1 Name Stage Owner requiresDevMode RequiresRestart FrontendOnly
179 passScopeToDashboardApi experimental @grafana/dashboards-squad false false false
180 alertingApiServer experimental @grafana/alerting-squad false true false
181 dashboardRestoreUI experimental @grafana/grafana-frontend-platform false false false
182 cloudWatchRoundUpEndTime GA @grafana/aws-datasources false false false

4
pkg/services/featuremgmt/toggles_gen.go
View File

@ -726,4 +726,8 @@ const (
// FlagDashboardRestoreUI
// Enables the frontend to be able to restore a recently deleted dashboard
FlagDashboardRestoreUI = "dashboardRestoreUI"
// FlagCloudWatchRoundUpEndTime
// Round up end time for metric queries to the next minute to avoid missing data
FlagCloudWatchRoundUpEndTime = "cloudWatchRoundUpEndTime"
)

12
pkg/services/featuremgmt/toggles_gen.json
View File

@ -563,6 +563,18 @@
"codeowner": "@grafana/aws-datasources"
}
},
{
"metadata": {
"name": "cloudWatchRoundUpEndTime",
"resourceVersion": "1719324143210",
"creationTimestamp": "2024-06-25T14:02:23Z"
},
"spec": {
"description": "Round up end time for metric queries to the next minute to avoid missing data",
"stage": "GA",
"codeowner": "@grafana/aws-datasources"
}
},
{
"metadata": {
"name": "configurableSchedulerTick",

1
pkg/tsdb/cloudwatch/features/features.go
View File

@ -10,6 +10,7 @@ const (
FlagCloudWatchCrossAccountQuerying = "cloudWatchCrossAccountQuerying"
FlagCloudWatchBatchQueries = "cloudWatchBatchQueries"
FlagCloudWatchNewLabelParsing = "cloudWatchNewLabelParsing"
FlagCloudWatchRoundUpEndTime = "cloudWatchRoundUpEndTime"
)
func IsEnabled(ctx context.Context, feature string) bool {

7
pkg/tsdb/cloudwatch/get_metric_data_executor.go
View File

@ -2,10 +2,12 @@ package cloudwatch
import (
"context"
"time"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/service/cloudwatch"
"github.com/aws/aws-sdk-go/service/cloudwatch/cloudwatchiface"
"github.com/grafana/grafana/pkg/tsdb/cloudwatch/features"
"github.com/grafana/grafana/pkg/tsdb/cloudwatch/utils"
)
@ -18,6 +20,11 @@ func (e *cloudWatchExecutor) executeRequest(ctx context.Context, client cloudwat
if nextToken != "" {
metricDataInput.NextToken = aws.String(nextToken)
}
// GetMetricData EndTime is exclusive, so we round up to the next minute to get the last data point
if features.IsEnabled(ctx, features.FlagCloudWatchRoundUpEndTime) {
*metricDataInput.EndTime = metricDataInput.EndTime.Truncate(time.Minute).Add(time.Minute)
}
resp, err := client.GetMetricDataWithContext(ctx, metricDataInput)
if err != nil {
return mdo, err

24
pkg/tsdb/cloudwatch/get_metric_data_executor_test.go
View File

@ -3,18 +3,38 @@ package cloudwatch
import (
"context"
"testing"
"time"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/service/cloudwatch"
"github.com/grafana/grafana/pkg/tsdb/cloudwatch/features"
"github.com/grafana/grafana/pkg/tsdb/cloudwatch/mocks"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/require"
)
func TestGetMetricDataExecutorTest(t *testing.T) {
func TestGetMetricDataExecutorTestRequest(t *testing.T) {
t.Run("Should round up end time if cloudWatchRoundUpEndTime is enabled", func(t *testing.T) {
executor := &cloudWatchExecutor{}
inputs := &cloudwatch.GetMetricDataInput{MetricDataQueries: []*cloudwatch.MetricDataQuery{}}
queryEndTime, _ := time.Parse("2006-01-02T15:04:05Z07:00", "2024-05-01T01:45:04Z")
inputs := &cloudwatch.GetMetricDataInput{EndTime: &queryEndTime, MetricDataQueries: []*cloudwatch.MetricDataQuery{}}
mockMetricClient := &mocks.MetricsAPI{}
mockMetricClient.On("GetMetricDataWithContext", mock.Anything, mock.Anything, mock.Anything).Return(
&cloudwatch.GetMetricDataOutput{
MetricDataResults: []*cloudwatch.MetricDataResult{{Values: []*float64{}}},
}, nil).Once()
_, err := executor.executeRequest(contextWithFeaturesEnabled(features.FlagCloudWatchRoundUpEndTime), mockMetricClient, inputs)
require.NoError(t, err)
expectedTime, _ := time.Parse("2006-01-02T15:04:05Z07:00", "2024-05-01T01:46:00Z")
expectedInput := &cloudwatch.GetMetricDataInput{EndTime: &expectedTime, MetricDataQueries: []*cloudwatch.MetricDataQuery{}}
mockMetricClient.AssertCalled(t, "GetMetricDataWithContext", mock.Anything, expectedInput, mock.Anything)
})
}
func TestGetMetricDataExecutorTestResponse(t *testing.T) {
executor := &cloudWatchExecutor{}
inputs := &cloudwatch.GetMetricDataInput{EndTime: aws.Time(time.Now()), MetricDataQueries: []*cloudwatch.MetricDataQuery{}}
mockMetricClient := &mocks.MetricsAPI{}
mockMetricClient.On("GetMetricDataWithContext", mock.Anything, mock.Anything, mock.Anything).Return(
&cloudwatch.GetMetricDataOutput{