Skip to content

feat(cls): [119075085] add cls loggets data source #2775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/2775.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:new-data-source
tencentcloud_cls_logsets
```
1 change: 1 addition & 0 deletions tencentcloud/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -1010,6 +1010,7 @@ func Provider() *schema.Provider {
"tencentcloud_cls_shipper_tasks": cls.DataSourceTencentCloudClsShipperTasks(),
"tencentcloud_cls_machines": cls.DataSourceTencentCloudClsMachines(),
"tencentcloud_cls_machine_group_configs": cls.DataSourceTencentCloudClsMachineGroupConfigs(),
"tencentcloud_cls_logsets": cls.DataSourceTencentCloudClsLogsets(),
"tencentcloud_eb_search": eb.DataSourceTencentCloudEbSearch(),
"tencentcloud_eb_bus": eb.DataSourceTencentCloudEbBus(),
"tencentcloud_eb_event_rules": eb.DataSourceTencentCloudEbEventRules(),
Expand Down
1 change: 1 addition & 0 deletions tencentcloud/provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -1356,6 +1356,7 @@ Cloud Log Service(CLS)
tencentcloud_cls_shipper_tasks
tencentcloud_cls_machines
tencentcloud_cls_machine_group_configs
tencentcloud_cls_logsets

TencentCloud Lighthouse(Lighthouse)
Resource
Expand Down
216 changes: 216 additions & 0 deletions tencentcloud/services/cls/data_source_tc_cls_logsets.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,216 @@
package cls

import (
"context"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
cls "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cls/v20201016"
tccommon "github.com/tencentcloudstack/terraform-provider-tencentcloud/tencentcloud/common"
"github.com/tencentcloudstack/terraform-provider-tencentcloud/tencentcloud/internal/helper"
)

func DataSourceTencentCloudClsLogsets() *schema.Resource {
return &schema.Resource{
Read: dataSourceTencentCloudClsLogsetsRead,
Schema: map[string]*schema.Schema{
"filters": {
Optional: true,
MaxItems: 10,
Type: schema.TypeList,
Description: "Query by filter.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"key": {
Type: schema.TypeString,
Required: true,
Description: "Fields that need to be filtered. Support: `logsetName`, `logsetId`, `tagKey`, `tag:tagKey`.",
},
"values": {
Type: schema.TypeSet,
Required: true,
MaxItems: 5,
Elem: &schema.Schema{Type: schema.TypeString},
Description: "The values that need to be filtered.",
},
},
},
},
// computed
"logsets": {
Computed: true,
Type: schema.TypeList,
Description: "logset lists.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"logset_id": {
Type: schema.TypeString,
Computed: true,
Description: "Logset Id.",
},
"logset_name": {
Type: schema.TypeString,
Computed: true,
Description: "Logset name.",
},
"create_time": {
Type: schema.TypeString,
Computed: true,
Description: "Create time.",
},
"assumer_name": {
Type: schema.TypeString,
Computed: true,
Description: "Cloud product identification, when the log set is created by another cloud product, this field will display the cloud product name, such as CDN, TKE.",
},
"tags": {
Type: schema.TypeList,
Computed: true,
Description: "Tags.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"key": {
Type: schema.TypeString,
Computed: true,
Description: "Tag key.",
},
"value": {
Type: schema.TypeString,
Computed: true,
Description: "Tag value.",
},
},
},
},
"topic_count": {
Type: schema.TypeInt,
Computed: true,
Description: "Topic count.",
},
"role_name": {
Type: schema.TypeString,
Computed: true,
Description: "If `assumer_name` is not empty, it indicates the service role that created the log set.",
},
},
},
},
"result_output_file": {
Type: schema.TypeString,
Optional: true,
Description: "Used to save results.",
},
},
}
}

func dataSourceTencentCloudClsLogsetsRead(d *schema.ResourceData, meta interface{}) error {
defer tccommon.LogElapsed("data_source.tencentcloud_cls_logsets.read")()
defer tccommon.InconsistentCheck(d, meta)()

var (
logId = tccommon.GetLogId(tccommon.ContextNil)
ctx = context.WithValue(context.TODO(), tccommon.LogIdKey, logId)
service = ClsService{client: meta.(tccommon.ProviderMeta).GetAPIV3Conn()}
logsets []*cls.LogsetInfo
)

paramMap := make(map[string]interface{})
if v, ok := d.GetOk("filters"); ok {
filtersSet := v.([]interface{})
tmpSet := make([]*cls.Filter, 0, len(filtersSet))
for _, item := range filtersSet {
filter := cls.Filter{}
filterMap := item.(map[string]interface{})
if v, ok := filterMap["key"]; ok {
filter.Key = helper.String(v.(string))
}

if v, ok := filterMap["values"]; ok {
valuesSet := v.(*schema.Set).List()
filter.Values = helper.InterfacesStringsPoint(valuesSet)
}

tmpSet = append(tmpSet, &filter)
}

paramMap["Filters"] = tmpSet
}

err := resource.Retry(tccommon.ReadRetryTimeout, func() *resource.RetryError {
result, e := service.DescribeClsLogsetsByFilter(ctx, paramMap)
if e != nil {
return tccommon.RetryError(e)
}

logsets = result
return nil
})

if err != nil {
return err
}

ids := make([]string, 0, len(logsets))
tmpList := make([]map[string]interface{}, 0, len(logsets))
if logsets != nil {
for _, logsetInfo := range logsets {
logsetInfoMap := map[string]interface{}{}
if logsetInfo.LogsetId != nil {
logsetInfoMap["logset_id"] = logsetInfo.LogsetId
}

if logsetInfo.LogsetName != nil {
logsetInfoMap["logset_name"] = logsetInfo.LogsetName
}

if logsetInfo.CreateTime != nil {
logsetInfoMap["create_time"] = logsetInfo.CreateTime
}

if logsetInfo.AssumerName != nil {
logsetInfoMap["assumer_name"] = logsetInfo.AssumerName
}

if logsetInfo.Tags != nil {
tagsList := []interface{}{}
for _, tags := range logsetInfo.Tags {
tagsMap := map[string]interface{}{}
if tags.Key != nil {
tagsMap["key"] = tags.Key
}

if tags.Value != nil {
tagsMap["value"] = tags.Value
}

tagsList = append(tagsList, tagsMap)
}

logsetInfoMap["tags"] = tagsList
}

if logsetInfo.TopicCount != nil {
logsetInfoMap["topic_count"] = logsetInfo.TopicCount
}

if logsetInfo.RoleName != nil {
logsetInfoMap["role_name"] = logsetInfo.RoleName
}

ids = append(ids, *logsetInfo.LogsetId)
tmpList = append(tmpList, logsetInfoMap)
}

_ = d.Set("logsets", tmpList)
}

d.SetId(helper.DataResourceIdsHash(ids))
output, ok := d.GetOk("result_output_file")
if ok && output.(string) != "" {
if e := tccommon.WriteToFile(output.(string), tmpList); e != nil {
return e
}
}

return nil
}
45 changes: 45 additions & 0 deletions tencentcloud/services/cls/data_source_tc_cls_logsets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
Use this data source to query detailed information of cls logsets

Example Usage

Query all cls logsets

```hcl
data "tencentcloud_cls_logsets" "logsets" {}
```

Query by filters

```hcl
# Query by `logsetName`
data "tencentcloud_cls_logsets" "logsets" {
filters {
key = "logsetName"
values = ["cls_service_logging"]
}
}

# Query by `logsetId`
data "tencentcloud_cls_logsets" "logsets" {
filters {
key = "logsetId"
values = ["50d499a8-c4c0-4442-aa04-e8aa8a02437d"]
}
}

# Query by `tagKey`
data "tencentcloud_cls_logsets" "logsets" {
filters {
key = "tagKey"
values = ["createdBy"]
}
}

# Query by `tag:tagKey`
data "tencentcloud_cls_logsets" "logsets" {
filters {
key = "tag:createdBy"
values = ["terraform"]
}
}
```
35 changes: 35 additions & 0 deletions tencentcloud/services/cls/data_source_tc_cls_logsets_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
package cls_test

import (
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
tcacctest "github.com/tencentcloudstack/terraform-provider-tencentcloud/tencentcloud/acctest"
"testing"
)

// go test -i; go test -test.run TestAccTencentCloudClsLogsetsDataSource_basic -v
func TestAccTencentCloudClsLogsetsDataSource_basic(t *testing.T) {
t.Parallel()
resource.Test(t, resource.TestCase{
PreCheck: func() {
tcacctest.AccPreCheck(t)
},
Providers: tcacctest.AccProviders,
Steps: []resource.TestStep{
{
Config: testAccClsLogsetsDataSource,
Check: resource.ComposeTestCheckFunc(
tcacctest.AccCheckTencentCloudDataSourceID("data.tencentcloud_cls_logsets.logsets"),
),
},
},
})
}

const testAccClsLogsetsDataSource = `
data "tencentcloud_cls_logsets" "logsets" {
filters {
key = "logsetId"
values = ["50d499a8-c4c0-4442-aa04-e8aa8a02437d"]
}
}
`
48 changes: 48 additions & 0 deletions tencentcloud/services/cls/service_tencentcloud_cls.go
Original file line number Diff line number Diff line change
Expand Up @@ -1160,6 +1160,54 @@ func (me *ClsService) DescribeClsMachineGroupConfigsByFilter(ctx context.Context
return
}

func (me *ClsService) DescribeClsLogsetsByFilter(ctx context.Context, param map[string]interface{}) (Logsets []*cls.LogsetInfo, errRet error) {
var (
logId = tccommon.GetLogId(ctx)
request = cls.NewDescribeLogsetsRequest()
)

defer func() {
if errRet != nil {
log.Printf("[CRITAL]%s api[%s] fail, request body [%s], reason[%s]\n", logId, request.GetAction(), request.ToJsonString(), errRet.Error())
}
}()

for k, v := range param {
if k == "Filters" {
request.Filters = v.([]*cls.Filter)
}
}

var (
offset int64 = 0
limit int64 = 100
)

Logsets = make([]*cls.LogsetInfo, 0)
for {
request.Offset = &offset
request.Limit = &limit
response, err := me.client.UseClsClient().DescribeLogsets(request)
if err != nil {
errRet = err
return
}
log.Printf("[DEBUG]%s api[%s] success, request body [%s], response body [%s]\n", logId, request.GetAction(), request.ToJsonString(), response.ToJsonString())

if response == nil || len(response.Response.Logsets) < 1 {
break
}
Logsets = append(Logsets, response.Response.Logsets...)
if len(response.Response.Logsets) < int(limit) {
break
}

offset += limit
}

return
}

func (me *ClsService) DescribeClsDataTransformById(ctx context.Context, taskId string) (dataTransform *cls.DataTransformTaskInfo, errRet error) {
logId := tccommon.GetLogId(ctx)

Expand Down
Loading
Loading