Skip to content

Commit

Permalink
Merge pull request #150 from mackerelio/add_included_metrics_support
Browse files Browse the repository at this point in the history 
Add IncludedMetrics support
  • Loading branch information
@yohfee
yohfee committed Nov 21, 2023
2 parents 81608c3 + 56f9b62 commit 54fde30
Show file tree
Hide file tree
Showing 2 changed files with 102 additions and 4 deletions.
44 changes: 43 additions & 1 deletion aws_integrations.go
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
package mackerel

import "fmt"
import (
"encoding/json"
"fmt"
)

// AWSIntegration AWS integration information
type AWSIntegration struct {
Expand All @@ -20,10 +23,49 @@ type AWSIntegration struct {
type AWSIntegrationService struct {
Enable bool `json:"enable"`
Role *string `json:"role"`
IncludedMetrics []string `json:"includedMetrics"`
ExcludedMetrics []string `json:"excludedMetrics"`
RetireAutomatically bool `json:"retireAutomatically,omitempty"`
}

type awsIntegrationService = AWSIntegrationService

type awsIntegrationServiceWithIncludedMetrics struct {
Enable bool `json:"enable"`
Role *string `json:"role"`
IncludedMetrics []string `json:"includedMetrics"`
RetireAutomatically bool `json:"retireAutomatically,omitempty"`
}

type awsIntegrationServiceWithExcludedMetrics struct {
Enable bool `json:"enable"`
Role *string `json:"role"`
ExcludedMetrics []string `json:"excludedMetrics"`
RetireAutomatically bool `json:"retireAutomatically,omitempty"`
}

// MarshalJSON implements json.Marshaler
func (a *AWSIntegrationService) MarshalJSON() ([]byte, error) {
// AWS integration create/update APIs only accept either includedMetrics or excludedMetrics
if a.ExcludedMetrics != nil && a.IncludedMetrics == nil {
return json.Marshal(awsIntegrationServiceWithExcludedMetrics{
Enable: a.Enable,
Role: a.Role,
ExcludedMetrics: a.ExcludedMetrics,
RetireAutomatically: a.RetireAutomatically,
})
}
if a.ExcludedMetrics == nil && a.IncludedMetrics != nil {
return json.Marshal(awsIntegrationServiceWithIncludedMetrics{
Enable: a.Enable,
Role: a.Role,
IncludedMetrics: a.IncludedMetrics,
RetireAutomatically: a.RetireAutomatically,
})
}
return json.Marshal(awsIntegrationService(*a))
}

// CreateAWSIntegrationParam parameters for CreateAWSIntegration
type CreateAWSIntegrationParam struct {
Name string `json:"name"`
Expand Down
62 changes: 59 additions & 3 deletions aws_integrations_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,18 +65,18 @@ func TestFindAWSIntegrations(t *testing.T) {
"EC2": {
"enable": false,
"role": (*string)(nil),
"excludedMetrics": []string{""},
"includedMetrics": []string{"ec2.cpu.used"},
"retireAutomatically": false,
},
"ALB": {
"enable": false,
"role": (*string)(nil),
"excludedMetrics": []string{""},
"includedMetrics": []string{""},
},
"RDS": {
"enable": false,
"role": (*string)(nil),
"excludedMetrics": []string{""},
"includedMetrics": []string{""},
},
},
},
Expand All @@ -101,11 +101,22 @@ func TestFindAWSIntegrations(t *testing.T) {
if reflect.DeepEqual(awsIntegrations[0].Services["EC2"], &AWSIntegrationService{
Enable: true,
Role: toPointer("web-group"),
IncludedMetrics: nil,
ExcludedMetrics: []string{"ec2.cpu.used", "ec2.network.in", "ec2.network.out"},
RetireAutomatically: true,
}) != true {
t.Errorf("Wrong data for aws integrations services: %v", awsIntegrations[0].Services["EC2"])
}

if reflect.DeepEqual(awsIntegrations[1].Services["EC2"], &AWSIntegrationService{
Enable: false,
Role: nil,
IncludedMetrics: []string{"ec2.cpu.used"},
ExcludedMetrics: nil,
RetireAutomatically: false,
}) != true {
t.Errorf("Wrong data for aws integrations services: %v", awsIntegrations[1].Services["EC2"])
}
}

func TestFindAWSIntegration(t *testing.T) {
Expand Down Expand Up @@ -167,6 +178,7 @@ func TestFindAWSIntegration(t *testing.T) {
if reflect.DeepEqual(awsIntegration.Services["EC2"], &AWSIntegrationService{
Enable: true,
Role: toPointer("web-group"),
IncludedMetrics: nil,
ExcludedMetrics: []string{"ec2.cpu.used", "ec2.network.in", "ec2.network.out"},
RetireAutomatically: true,
}) != true {
Expand Down Expand Up @@ -199,6 +211,7 @@ func TestCreateAWSIntegration(t *testing.T) {
if reflect.DeepEqual(awsIntegration.Services["EC2"], &AWSIntegrationService{
Enable: true,
Role: toPointer("web-group"),
IncludedMetrics: nil,
ExcludedMetrics: []string{"ec2.cpu.used", "ec2.network.in", "ec2.network.out"},
RetireAutomatically: true,
}) != true {
Expand Down Expand Up @@ -256,17 +269,20 @@ func TestCreateAWSIntegration(t *testing.T) {
"EC2": {
Enable: true,
Role: toPointer("web-group"),
IncludedMetrics: nil,
ExcludedMetrics: []string{"ec2.cpu.used", "ec2.network.in", "ec2.network.out"},
RetireAutomatically: true,
},
"ALB": {
Enable: true,
Role: toPointer("web-group"),
IncludedMetrics: nil,
ExcludedMetrics: []string{"alb.request.count"},
},
"RDS": {
Enable: true,
Role: toPointer("db-group"),
IncludedMetrics: nil,
ExcludedMetrics: []string{"rds.cpu.used", "rds.aurora.row_lock_time.row_lock"},
},
},
Expand All @@ -283,6 +299,7 @@ func TestCreateAWSIntegration(t *testing.T) {
if reflect.DeepEqual(awsIntegrations.Services["EC2"], &AWSIntegrationService{
Enable: true,
Role: toPointer("web-group"),
IncludedMetrics: nil,
ExcludedMetrics: []string{"ec2.cpu.used", "ec2.network.in", "ec2.network.out"},
RetireAutomatically: true,
}) != true {
Expand Down Expand Up @@ -315,6 +332,7 @@ func TestUpdateAWSIntegration(t *testing.T) {
if reflect.DeepEqual(awsIntegration.Services["EC2"], &AWSIntegrationService{
Enable: true,
Role: toPointer("web-group"),
IncludedMetrics: nil,
ExcludedMetrics: []string{"ec2.cpu.used", "ec2.network.in", "ec2.network.out"},
RetireAutomatically: true,
}) != true {
Expand Down Expand Up @@ -372,17 +390,20 @@ func TestUpdateAWSIntegration(t *testing.T) {
"EC2": {
Enable: true,
Role: toPointer("web-group"),
IncludedMetrics: nil,
ExcludedMetrics: []string{"ec2.cpu.used", "ec2.network.in", "ec2.network.out"},
RetireAutomatically: true,
},
"ALB": {
Enable: true,
Role: toPointer("web-group"),
IncludedMetrics: nil,
ExcludedMetrics: []string{"alb.request.count"},
},
"RDS": {
Enable: true,
Role: toPointer("db-group"),
IncludedMetrics: nil,
ExcludedMetrics: []string{"rds.cpu.used", "rds.aurora.row_lock_time.row_lock"},
},
},
Expand All @@ -399,6 +420,7 @@ func TestUpdateAWSIntegration(t *testing.T) {
if reflect.DeepEqual(awsIntegrations.Services["EC2"], &AWSIntegrationService{
Enable: true,
Role: toPointer("web-group"),
IncludedMetrics: nil,
ExcludedMetrics: []string{"ec2.cpu.used", "ec2.network.in", "ec2.network.out"},
RetireAutomatically: true,
}) != true {
Expand Down Expand Up @@ -464,6 +486,7 @@ func TestDeleteAWSIntegration(t *testing.T) {
if reflect.DeepEqual(awsIntegrations.Services["EC2"], &AWSIntegrationService{
Enable: true,
Role: toPointer("web-group"),
IncludedMetrics: nil,
ExcludedMetrics: []string{"ec2.cpu.used", "ec2.network.in", "ec2.network.out"},
RetireAutomatically: true,
}) != true {
Expand Down Expand Up @@ -547,3 +570,36 @@ func TestListAWSIntegrationExcludableMetrics(t *testing.T) {
func toPointer(s string) *string {
return &s
}

func TestAWSIntegrationService_MarshalJSON(t *testing.T) {
tests := []struct {
caption string
service AWSIntegrationService
expected string
}{
{"both undefined", AWSIntegrationService{
IncludedMetrics: nil, ExcludedMetrics: nil,
}, `{"enable":false,"role":null,"includedMetrics":null,"excludedMetrics":null}`},
{"both defined", AWSIntegrationService{
IncludedMetrics: []string{}, ExcludedMetrics: []string{},
}, `{"enable":false,"role":null,"includedMetrics":[],"excludedMetrics":[]}`},
{"IncludedMetrics only defined", AWSIntegrationService{
IncludedMetrics: []string{},
}, `{"enable":false,"role":null,"includedMetrics":[]}`},
{"ExcludedMetrics only defined", AWSIntegrationService{
ExcludedMetrics: []string{},
}, `{"enable":false,"role":null,"excludedMetrics":[]}`},
}
for _, test := range tests {
t.Run(test.caption, func(tt *testing.T) {
bytes, err := json.Marshal(&test.service)
actual := string(bytes)
if err != nil {
t.Error("err should be nil but: ", err)
}
if !reflect.DeepEqual(test.expected, actual) {
t.Errorf("%v should be %s but got %s", test.caption, test.expected, actual)
}
})
}
}

0 comments on commit 54fde30

Please sign in to comment.