feat: Add datadog_rum_events table (#11229)

candiduslynx · web-flow · commit e2a07a29dc34 · 2023-06-06T09:15:53.000Z
Closes #11044
diff --git a/plugins/source/datadog/client/helpers.go b/plugins/source/datadog/client/helpers.go
@@ -0,0 +1,18 @@
+package client
+
+import (
+	"context"
+
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
+)
+
+func ConsumePaginatedResponse[T any](response <-chan datadog.PaginationResult[T], cancel context.CancelFunc, res chan<- any) error {
+	defer cancel()
+	for item := range response {
+		if item.Error != nil {
+			return item.Error
+		}
+		res <- item.Item
+	}
+	return nil
+}
diff --git a/plugins/source/datadog/client/mocks/rum_api.go b/plugins/source/datadog/client/mocks/rum_api.go
diff --git a/plugins/source/datadog/client/services.go b/plugins/source/datadog/client/services.go
diff --git a/plugins/source/datadog/client/services/rum_api.go b/plugins/source/datadog/client/services/rum_api.go
diff --git a/plugins/source/datadog/client/testing.go b/plugins/source/datadog/client/testing.go
@@ -6,6 +6,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 	"github.com/cloudquery/plugin-pb-go/specs"
 	"github.com/cloudquery/plugin-sdk/v3/plugins/source"
 	"github.com/cloudquery/plugin-sdk/v3/schema"
@@ -46,3 +47,10 @@ func DatadogMockTestHelper(t *testing.T, table *schema.Table, builder func(*test
 		Destinations: []string{"mock-destination"},
 	})
 }
+
+func MockPaginatedResponse[T any](result T) (<-chan datadog.PaginationResult[T], func()) {
+	ch := make(chan datadog.PaginationResult[T], 1)
+	ch <- datadog.PaginationResult[T]{Item: result}
+	close(ch)
+	return ch, func() {}
+}
diff --git a/plugins/source/datadog/codegen/services/clients.go b/plugins/source/datadog/codegen/services/clients.go
@@ -18,4 +18,5 @@ var clients = []any{
 	&datadogV1.ServiceLevelObjectiveCorrectionsApi{},
 	&datadogV1.SyntheticsApi{},
 	&datadogV2.UsersApi{},
+	&datadogV2.RUMApi{},
 }
diff --git a/plugins/source/datadog/docs/tables/README.md b/plugins/source/datadog/docs/tables/README.md
@@ -16,6 +16,7 @@
 - [datadog_roles](../../../../../website/tables/datadog/datadog_roles.md)
   - [datadog_role_permissions](../../../../../website/tables/datadog/datadog_role_permissions.md)
   - [datadog_role_users](../../../../../website/tables/datadog/datadog_role_users.md)
+- [datadog_rum_events](../../../../../website/tables/datadog/datadog_rum_events.md)
 - [datadog_slo_corrections](../../../../../website/tables/datadog/datadog_slo_corrections.md)
 - [datadog_slos](../../../../../website/tables/datadog/datadog_slos.md)
 - [datadog_synthetics](../../../../../website/tables/datadog/datadog_synthetics.md)
diff --git a/plugins/source/datadog/resources/plugin/tables.go b/plugins/source/datadog/resources/plugin/tables.go
@@ -9,6 +9,7 @@ import (
 	"github.com/cloudquery/cloudquery/plugins/source/datadog/resources/services/monitors"
 	"github.com/cloudquery/cloudquery/plugins/source/datadog/resources/services/notebooks"
 	"github.com/cloudquery/cloudquery/plugins/source/datadog/resources/services/roles"
+	"github.com/cloudquery/cloudquery/plugins/source/datadog/resources/services/rum"
 	"github.com/cloudquery/cloudquery/plugins/source/datadog/resources/services/slos"
 	"github.com/cloudquery/cloudquery/plugins/source/datadog/resources/services/synthetics"
 	"github.com/cloudquery/cloudquery/plugins/source/datadog/resources/services/users"
@@ -26,6 +27,7 @@ func Tables() []*schema.Table {
 		notebooks.Notebooks(),
 		roles.Roles(),
 		roles.Permissions(),
+		rum.Events(),
 		slos.Objectives(),
 		slos.ObjectiveCorrections(),
 		synthetics.GlobalVariables(),
diff --git a/plugins/source/datadog/resources/services/rum/events.go b/plugins/source/datadog/resources/services/rum/events.go
@@ -0,0 +1,27 @@
+package rum
+
+import (
+	"context"
+
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
+	"github.com/cloudquery/cloudquery/plugins/source/datadog/client"
+	"github.com/cloudquery/plugin-sdk/v3/schema"
+	"github.com/cloudquery/plugin-sdk/v3/transformers"
+)
+
+func Events() *schema.Table {
+	return &schema.Table{
+		Name:      "datadog_rum_events",
+		Title:     "Datadog Real User Monitoring (RUM) Events",
+		Resolver:  fetchEvents,
+		Multiplex: client.AccountMultiplex,
+		Transform: client.TransformWithStruct(new(datadogV2.RUMEvent), transformers.WithPrimaryKeys("Id")),
+		Columns:   schema.ColumnList{client.AccountNameColumn},
+	}
+}
+
+func fetchEvents(ctx context.Context, meta schema.ClientMeta, _ *schema.Resource, res chan<- any) error {
+	c := meta.(*client.Client)
+	resp, cancel := c.DDServices.RumAPI.ListRUMEventsWithPagination(c.BuildContextV2(ctx))
+	return client.ConsumePaginatedResponse(resp, cancel, res)
+}
diff --git a/plugins/source/datadog/resources/services/rum/events_mock_test.go b/plugins/source/datadog/resources/services/rum/events_mock_test.go
@@ -0,0 +1,31 @@
+package rum
+
+import (
+	"testing"
+
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
+	"github.com/cloudquery/cloudquery/plugins/source/datadog/client"
+	"github.com/cloudquery/cloudquery/plugins/source/datadog/client/mocks"
+	"github.com/cloudquery/plugin-sdk/v3/faker"
+	"github.com/golang/mock/gomock"
+)
+
+func buildEventsMock(t *testing.T, ctrl *gomock.Controller) client.DatadogServices {
+	m := mocks.NewMockRumAPIClient(ctrl)
+	services := client.DatadogServices{
+		RumAPI: m,
+	}
+
+	var i datadogV2.RUMEvent
+	err := faker.FakeObject(&i)
+	if err != nil {
+		t.Fatal(err)
+	}
+	m.EXPECT().ListRUMEventsWithPagination(gomock.Any()).Return(client.MockPaginatedResponse(i))
+
+	return services
+}
+
+func TestEvents(t *testing.T) {
+	client.DatadogMockTestHelper(t, Events(), buildEventsMock, client.TestOptions{})
+}
diff --git a/website/pages/docs/plugins/sources/datadog/tables.md b/website/pages/docs/plugins/sources/datadog/tables.md
diff --git a/website/tables/datadog/datadog_rum_events.md b/website/tables/datadog/datadog_rum_events.md
@@ -0,0 +1,19 @@
+# Table: datadog_rum_events
+
+This table shows data for Datadog Real User Monitoring (RUM) Events.
+
+The composite primary key for this table is (**account_name**, **id**).
+
+## Columns
+
+| Name          | Type          |
+| ------------- | ------------- |
+|_cq_source_name|`utf8`|
+|_cq_sync_time|`timestamp[us, tz=UTC]`|
+|_cq_id|`uuid`|
+|_cq_parent_id|`uuid`|
+|account_name (PK)|`utf8`|
+|attributes|`json`|
+|id (PK)|`utf8`|
+|type|`utf8`|
+|additional_properties|`json`|

Original file line number	Diff line number	Diff line change
`@@ -18,4 +18,5 @@ var clients = []any{`
`18`	`18`	`&datadogV1.ServiceLevelObjectiveCorrectionsApi{},`
`19`	`19`	`&datadogV1.SyntheticsApi{},`
`20`	`20`	`&datadogV2.UsersApi{},`
	`21`	`+ &datadogV2.RUMApi{},`
`21`	`22`	`}`