Skip to content

[datadog_dashboard] Add support for sorting toplist widget. #3326

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[datadog_dashboard] Add support for sorting toplist widget. #3326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
130 changes: 130 additions & 0 deletions datadog/resource_datadog_dashboard.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8260,8 +8260,59 @@ func getToplistRequestSchema() map[string]*schema.Schema {
Schema: getWidgetRequestStyle(),
},
},
"sort": getToplistRequestSortSchema(),
}
}

func getToplistRequestSortSchema() *schema.Schema {
return &schema.Schema{
Description: "The controls for sorting the widget.",
Type: schema.TypeList,
Optional: true,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"count": {
Description: "The number of items to limit the widget to.",
Type: schema.TypeInt,
Optional: true,
},
"order_by": {
Description: "The array of items to sort the widget by in order.",
Type: schema.TypeList,
Optional: true,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"index": {
Description: "The index of the formula to sort by.",
Type: schema.TypeInt,
Optional: true,
},
"order": {
Description: "Widget sorting methods. Allowed enum values: `asc`, `desc`",
Type: schema.TypeString,
Required: true,
ValidateDiagFunc: validators.ValidateEnumValue(datadogV1.NewWidgetSortFromValue),
},
"type": {
Description: "Set the sort type to formula. Allowed enum values: `formula`",
Type: schema.TypeString,
Required: true,
ValidateDiagFunc: validators.ValidateStringEnumValue(datadogV1.FORMULATYPE_FORMULA, datadogV1.GROUPTYPE_GROUP),
},
"name": {
Description: "The name of the group.",
Type: schema.TypeString,
Optional: true,
},
},
},
},
},
},
}
}

func buildDatadogToplistRequests(terraformRequests *[]interface{}) *[]datadogV1.ToplistWidgetRequest {
datadogRequests := make([]datadogV1.ToplistWidgetRequest, len(*terraformRequests))
for i, r := range *terraformRequests {
Expand Down Expand Up @@ -8329,10 +8380,49 @@ func buildDatadogToplistRequests(terraformRequests *[]interface{}) *[]datadogV1.
datadogToplistRequest.Style = buildDatadogWidgetRequestStyle(v)
}
}

if v, ok := terraformRequest["sort"].([]interface{}); ok && len(v) > 0 {
sort := v[0].(map[string]interface{})
datadogToplistRequest.Sort = buildDatadogToplistSortBy(sort)
}
datadogRequests[i] = *datadogToplistRequest
}
return &datadogRequests
}

func buildDatadogToplistSortBy(terraformSort map[string]interface{}) *datadogV1.WidgetSortBy {
datadogSortBy := datadogV1.NewWidgetSortBy()

if count, ok := terraformSort["count"].(int); ok {
datadogSortBy.SetCount(int64(count))
}

if orderByList, ok := terraformSort["order_by"].([]interface{}); ok && len(orderByList) > 0 {
orderBy := make([]datadogV1.WidgetSortOrderBy, len(orderByList))

for i, item := range orderByList {
itemMap := item.(map[string]interface{})
order := itemMap["order"].(string)
widgetSortOrder := datadogV1.WidgetSort(order)
sortType := itemMap["type"].(string)

if sortType == string(datadogV1.FORMULATYPE_FORMULA) {
index := int64(itemMap["index"].(int))
formula := datadogV1.NewWidgetFormulaSort(index, widgetSortOrder, datadogV1.FORMULATYPE_FORMULA)
orderBy[i] = datadogV1.WidgetFormulaSortAsWidgetSortOrderBy(formula)
} else if sortType == string(datadogV1.GROUPTYPE_GROUP) {
name := itemMap["name"].(string)
group := datadogV1.NewWidgetGroupSort(name, widgetSortOrder, datadogV1.GROUPTYPE_GROUP)
orderBy[i] = datadogV1.WidgetGroupSortAsWidgetSortOrderBy(group)
}
}

datadogSortBy.SetOrderBy(orderBy)
}

return datadogSortBy
}

func buildTerraformToplistRequests(datadogToplistRequests *[]datadogV1.ToplistWidgetRequest) *[]map[string]interface{} {
terraformRequests := make([]map[string]interface{}, len(*datadogToplistRequests))
for i, datadogRequest := range *datadogToplistRequests {
Expand Down Expand Up @@ -8373,11 +8463,51 @@ func buildTerraformToplistRequests(datadogToplistRequests *[]datadogV1.ToplistWi
style := buildTerraformWidgetRequestStyle(*v)
terraformRequest["style"] = []map[string]interface{}{style}
}
if v, ok := datadogRequest.GetSortOk(); ok {
sort := buildTerraformToplistWidgetSort(*v)
terraformRequest["sort"] = []map[string]interface{}{sort}
}
terraformRequests[i] = terraformRequest
}
return &terraformRequests
}

func buildTerraformToplistWidgetSort(datadogSort datadogV1.WidgetSortBy) map[string]interface{} {
terraformSort := make(map[string]interface{})

if count, ok := datadogSort.GetCountOk(); ok {
terraformSort["count"] = int(*count)
}

if orderByList, ok := datadogSort.GetOrderByOk(); ok && len(*orderByList) > 0 {
terraformOrderBy := make([]map[string]interface{}, len(*orderByList))

for i, item := range *orderByList {
orderByItem := make(map[string]interface{})

if formula := item.WidgetFormulaSort; formula != nil {
orderByItem["type"] = string(formula.GetType())
orderByItem["order"] = string(formula.GetOrder())
if index, ok := formula.GetIndexOk(); ok {
orderByItem["index"] = int(*index)
}
} else if group := item.WidgetGroupSort; group != nil {
orderByItem["type"] = string(group.GetType())
orderByItem["order"] = string(group.GetOrder())
if name, ok := group.GetNameOk(); ok {
orderByItem["name"] = *name
}
}

terraformOrderBy[i] = orderByItem
}

terraformSort["order_by"] = terraformOrderBy
}

return terraformSort
}

func buildTerraformToplistWidgetStyle(datadogToplistStyle *datadogV1.ToplistWidgetStyle) *[]map[string]interface{} {
terraformStyles := make([]map[string]interface{}, 1)
terraformStyle := map[string]interface{}{}
Expand Down
96 changes: 96 additions & 0 deletions docs/resources/dashboard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12854,6 +12854,7 @@ Optional:
- `query` (Block List) (see [below for nested schema](#nestedblock--widget--group_definition--widget--split_graph_definition--source_widget_definition--toplist_definition--request--query))
- `rum_query` (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--split_graph_definition--source_widget_definition--toplist_definition--request--rum_query))
- `security_query` (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--split_graph_definition--source_widget_definition--toplist_definition--request--security_query))
- `sort` (Block List, Max: 1) The controls for sorting the widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--split_graph_definition--source_widget_definition--toplist_definition--request--sort))
- `style` (Block List, Max: 1) Define request for the widget's style. (see [below for nested schema](#nestedblock--widget--group_definition--widget--split_graph_definition--source_widget_definition--toplist_definition--request--style))

<a id="nestedblock--widget--group_definition--widget--split_graph_definition--source_widget_definition--toplist_definition--request--apm_query"></a>
Expand Down Expand Up @@ -13501,6 +13502,29 @@ Optional:



<a id="nestedblock--widget--group_definition--widget--split_graph_definition--source_widget_definition--toplist_definition--request--sort"></a>
### Nested Schema for `widget.group_definition.widget.split_graph_definition.source_widget_definition.toplist_definition.request.sort`

Optional:

- `count` (Number) The number of items to limit the widget to.
- `order_by` (Block List) The array of items to sort the widget by in order. (see [below for nested schema](#nestedblock--widget--group_definition--widget--split_graph_definition--source_widget_definition--toplist_definition--request--sort--order_by))

<a id="nestedblock--widget--group_definition--widget--split_graph_definition--source_widget_definition--toplist_definition--request--sort--order_by"></a>
### Nested Schema for `widget.group_definition.widget.split_graph_definition.source_widget_definition.toplist_definition.request.sort.order_by`

Required:

- `order` (String) Widget sorting methods. Allowed enum values: `asc`, `desc` Valid values are `asc`, `desc`.
- `type` (String) Set the sort type to formula. Allowed enum values: `formula` Valid values are `formula`, `group`.

Optional:

- `index` (Number) The index of the formula to sort by.
- `name` (String) The name of the group.



<a id="nestedblock--widget--group_definition--widget--split_graph_definition--source_widget_definition--toplist_definition--request--style"></a>
### Nested Schema for `widget.group_definition.widget.split_graph_definition.source_widget_definition.toplist_definition.request.style`

Expand Down Expand Up @@ -15533,6 +15557,7 @@ Optional:
- `query` (Block List) (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query))
- `rum_query` (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--rum_query))
- `security_query` (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--security_query))
- `sort` (Block List, Max: 1) The controls for sorting the widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--sort))
- `style` (Block List, Max: 1) Define request for the widget's style. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--style))

<a id="nestedblock--widget--group_definition--widget--toplist_definition--request--apm_query"></a>
Expand Down Expand Up @@ -16180,6 +16205,29 @@ Optional:



<a id="nestedblock--widget--group_definition--widget--toplist_definition--request--sort"></a>
### Nested Schema for `widget.group_definition.widget.toplist_definition.request.sort`

Optional:

- `count` (Number) The number of items to limit the widget to.
- `order_by` (Block List) The array of items to sort the widget by in order. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--sort--order_by))

<a id="nestedblock--widget--group_definition--widget--toplist_definition--request--sort--order_by"></a>
### Nested Schema for `widget.group_definition.widget.toplist_definition.request.sort.order_by`

Required:

- `order` (String) Widget sorting methods. Allowed enum values: `asc`, `desc` Valid values are `asc`, `desc`.
- `type` (String) Set the sort type to formula. Allowed enum values: `formula` Valid values are `formula`, `group`.

Optional:

- `index` (Number) The index of the formula to sort by.
- `name` (String) The name of the group.



<a id="nestedblock--widget--group_definition--widget--toplist_definition--request--style"></a>
### Nested Schema for `widget.group_definition.widget.toplist_definition.request.style`

Expand Down Expand Up @@ -25482,6 +25530,7 @@ Optional:
- `query` (Block List) (see [below for nested schema](#nestedblock--widget--split_graph_definition--source_widget_definition--toplist_definition--request--query))
- `rum_query` (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--split_graph_definition--source_widget_definition--toplist_definition--request--rum_query))
- `security_query` (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--split_graph_definition--source_widget_definition--toplist_definition--request--security_query))
- `sort` (Block List, Max: 1) The controls for sorting the widget. (see [below for nested schema](#nestedblock--widget--split_graph_definition--source_widget_definition--toplist_definition--request--sort))
- `style` (Block List, Max: 1) Define request for the widget's style. (see [below for nested schema](#nestedblock--widget--split_graph_definition--source_widget_definition--toplist_definition--request--style))

<a id="nestedblock--widget--split_graph_definition--source_widget_definition--toplist_definition--request--apm_query"></a>
Expand Down Expand Up @@ -26129,6 +26178,29 @@ Optional:



<a id="nestedblock--widget--split_graph_definition--source_widget_definition--toplist_definition--request--sort"></a>
### Nested Schema for `widget.split_graph_definition.source_widget_definition.toplist_definition.request.sort`

Optional:

- `count` (Number) The number of items to limit the widget to.
- `order_by` (Block List) The array of items to sort the widget by in order. (see [below for nested schema](#nestedblock--widget--split_graph_definition--source_widget_definition--toplist_definition--request--sort--order_by))

<a id="nestedblock--widget--split_graph_definition--source_widget_definition--toplist_definition--request--sort--order_by"></a>
### Nested Schema for `widget.split_graph_definition.source_widget_definition.toplist_definition.request.sort.order_by`

Required:

- `order` (String) Widget sorting methods. Allowed enum values: `asc`, `desc` Valid values are `asc`, `desc`.
- `type` (String) Set the sort type to formula. Allowed enum values: `formula` Valid values are `formula`, `group`.

Optional:

- `index` (Number) The index of the formula to sort by.
- `name` (String) The name of the group.



<a id="nestedblock--widget--split_graph_definition--source_widget_definition--toplist_definition--request--style"></a>
### Nested Schema for `widget.split_graph_definition.source_widget_definition.toplist_definition.request.style`

Expand Down Expand Up @@ -28161,6 +28233,7 @@ Optional:
- `query` (Block List) (see [below for nested schema](#nestedblock--widget--toplist_definition--request--query))
- `rum_query` (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--toplist_definition--request--rum_query))
- `security_query` (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--toplist_definition--request--security_query))
- `sort` (Block List, Max: 1) The controls for sorting the widget. (see [below for nested schema](#nestedblock--widget--toplist_definition--request--sort))
- `style` (Block List, Max: 1) Define request for the widget's style. (see [below for nested schema](#nestedblock--widget--toplist_definition--request--style))

<a id="nestedblock--widget--toplist_definition--request--apm_query"></a>
Expand Down Expand Up @@ -28808,6 +28881,29 @@ Optional:



<a id="nestedblock--widget--toplist_definition--request--sort"></a>
### Nested Schema for `widget.toplist_definition.request.sort`

Optional:

- `count` (Number) The number of items to limit the widget to.
- `order_by` (Block List) The array of items to sort the widget by in order. (see [below for nested schema](#nestedblock--widget--toplist_definition--request--sort--order_by))

<a id="nestedblock--widget--toplist_definition--request--sort--order_by"></a>
### Nested Schema for `widget.toplist_definition.request.sort.order_by`

Required:

- `order` (String) Widget sorting methods. Allowed enum values: `asc`, `desc` Valid values are `asc`, `desc`.
- `type` (String) Set the sort type to formula. Allowed enum values: `formula` Valid values are `formula`, `group`.

Optional:

- `index` (Number) The index of the formula to sort by.
- `name` (String) The name of the group.



<a id="nestedblock--widget--toplist_definition--request--style"></a>
### Nested Schema for `widget.toplist_definition.request.style`

Expand Down
24 changes: 24 additions & 0 deletions docs/resources/powerpack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7102,6 +7102,7 @@ Optional:
- `query` (Block List) (see [below for nested schema](#nestedblock--widget--toplist_definition--request--query))
- `rum_query` (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--toplist_definition--request--rum_query))
- `security_query` (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--toplist_definition--request--security_query))
- `sort` (Block List, Max: 1) The controls for sorting the widget. (see [below for nested schema](#nestedblock--widget--toplist_definition--request--sort))
- `style` (Block List, Max: 1) Define request for the widget's style. (see [below for nested schema](#nestedblock--widget--toplist_definition--request--style))

<a id="nestedblock--widget--toplist_definition--request--apm_query"></a>
Expand Down Expand Up @@ -7749,6 +7750,29 @@ Optional:



<a id="nestedblock--widget--toplist_definition--request--sort"></a>
### Nested Schema for `widget.toplist_definition.request.sort`

Optional:

- `count` (Number) The number of items to limit the widget to.
- `order_by` (Block List) The array of items to sort the widget by in order. (see [below for nested schema](#nestedblock--widget--toplist_definition--request--sort--order_by))

<a id="nestedblock--widget--toplist_definition--request--sort--order_by"></a>
### Nested Schema for `widget.toplist_definition.request.sort.order_by`

Required:

- `order` (String) Widget sorting methods. Allowed enum values: `asc`, `desc` Valid values are `asc`, `desc`.
- `type` (String) Set the sort type to formula. Allowed enum values: `formula` Valid values are `formula`, `group`.

Optional:

- `index` (Number) The index of the formula to sort by.
- `name` (String) The name of the group.



<a id="nestedblock--widget--toplist_definition--request--style"></a>
### Nested Schema for `widget.toplist_definition.request.style`

Expand Down