Support mutliple group_by fields in SLOs (#878)

* Allow group_by in updates

* Support multi-group_by in SLOs

* Generate docs

* Changelog

Author: tobio

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## [Unreleased]
 
+- Support multiple group by fields in SLOs ([#870](https://github.com/elastic/terraform-provider-elasticstack/pull/878))
 - Use the auto-generated OAS schema from elastic/kibana for the Fleet API. ([#834](https://github.com/elastic/terraform-provider-elasticstack/issues/834))
 - Support description in `elasticstack_elasticsearch_security_role` data sources. ([#884](https://github.com/elastic/terraform-provider-elasticstack/pull/884))
 

docs/resources/kibana_slo.md

@@ -208,7 +208,7 @@ resource "elasticstack_kibana_slo" "custom_metric" {
 
 - `apm_availability_indicator` (Block List, Max: 1) (see [below for nested schema](#nestedblock--apm_availability_indicator))
 - `apm_latency_indicator` (Block List, Max: 1) (see [below for nested schema](#nestedblock--apm_latency_indicator))
-- `group_by` (String) Optional group by field to use to generate an SLO per distinct value.
+- `group_by` (List of String) Optional group by fields to use to generate an SLO per distinct value.
 - `histogram_custom_indicator` (Block List, Max: 1) (see [below for nested schema](#nestedblock--histogram_custom_indicator))
 - `kql_custom_indicator` (Block List, Max: 1) (see [below for nested schema](#nestedblock--kql_custom_indicator))
 - `metric_custom_indicator` (Block List, Max: 1) (see [below for nested schema](#nestedblock--metric_custom_indicator))

generated/slo-spec.yml

@@ -1389,6 +1389,14 @@ components:
           $ref: '#/components/schemas/objective'
         settings:
           $ref: '#/components/schemas/settings'
+        groupBy:
+          description: optional group by field to use to generate an SLO per distinct value
+          oneOf:
+            - type: string
+            - type: array
+              items:
+                type: string
+          example: some.field
         tags:
           description: List of tags
           type: array

generated/slo/api/openapi.yaml

@@ -1349,6 +1349,8 @@ components:
           $ref: '#/components/schemas/objective'
         settings:
           $ref: '#/components/schemas/settings'
+        groupBy:
+          $ref: '#/components/schemas/slo_response_groupBy'
         tags:
           description: List of tags
           items:

generated/slo/docs/UpdateSloRequest.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **BudgetingMethod** | Pointer to [**BudgetingMethod**](BudgetingMethod.md) |  | [optional] 
 **Objective** | Pointer to [**Objective**](Objective.md) |  | [optional] 
 **Settings** | Pointer to [**Settings**](Settings.md) |  | [optional] 
+**GroupBy** | Pointer to [**SloResponseGroupBy**](SloResponseGroupBy.md) |  | [optional] 
 **Tags** | Pointer to **[]string** | List of tags | [optional] 
 
 ## Methods
@@ -207,6 +208,31 @@ SetSettings sets Settings field to given value.
 
 HasSettings returns a boolean if a field has been set.
 
+### GetGroupBy
+
+`func (o *UpdateSloRequest) GetGroupBy() SloResponseGroupBy`
+
+GetGroupBy returns the GroupBy field if non-nil, zero value otherwise.
+
+### GetGroupByOk
+
+`func (o *UpdateSloRequest) GetGroupByOk() (*SloResponseGroupBy, bool)`
+
+GetGroupByOk returns a tuple with the GroupBy field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetGroupBy
+
+`func (o *UpdateSloRequest) SetGroupBy(v SloResponseGroupBy)`
+
+SetGroupBy sets GroupBy field to given value.
+
+### HasGroupBy
+
+`func (o *UpdateSloRequest) HasGroupBy() bool`
+
+HasGroupBy returns a boolean if a field has been set.
+
 ### GetTags
 
 `func (o *UpdateSloRequest) GetTags() []string`

generated/slo/model_slo_response_group_by.go

@@ -53,7 +53,7 @@ func DeleteSlo(ctx context.Context, apiClient *clients.ApiClient, sloId string,
 	return utils.CheckHttpError(res, "Unabled to delete slo with ID "+string(sloId))
 }
 
-func UpdateSlo(ctx context.Context, apiClient *clients.ApiClient, s models.Slo) (*models.Slo, diag.Diagnostics) {
+func UpdateSlo(ctx context.Context, apiClient *clients.ApiClient, s models.Slo, supportsGroupByList bool) (*models.Slo, diag.Diagnostics) {
 	client, err := apiClient.GetSloClient()
 	if err != nil {
 		return nil, diag.FromErr(err)
@@ -72,6 +72,7 @@ func UpdateSlo(ctx context.Context, apiClient *clients.ApiClient, s models.Slo)
 		BudgetingMethod: (*slo.BudgetingMethod)(&s.BudgetingMethod),
 		Objective:       &s.Objective,
 		Settings:        s.Settings,
+		GroupBy:         transformGroupBy(s.GroupBy, supportsGroupByList),
 		Tags:            s.Tags,
 	}
 
@@ -90,7 +91,7 @@ func UpdateSlo(ctx context.Context, apiClient *clients.ApiClient, s models.Slo)
 	return sloResponseToModel(s.SpaceID, slo), diag.Diagnostics{}
 }
 
-func CreateSlo(ctx context.Context, apiClient *clients.ApiClient, s models.Slo) (*models.Slo, diag.Diagnostics) {
+func CreateSlo(ctx context.Context, apiClient *clients.ApiClient, s models.Slo, supportsGroupByList bool) (*models.Slo, diag.Diagnostics) {
 	client, err := apiClient.GetSloClient()
 	if err != nil {
 		return nil, diag.FromErr(err)
@@ -109,7 +110,7 @@ func CreateSlo(ctx context.Context, apiClient *clients.ApiClient, s models.Slo)
 		BudgetingMethod: slo.BudgetingMethod(s.BudgetingMethod),
 		Objective:       s.Objective,
 		Settings:        s.Settings,
-		GroupBy:         transformGroupBy(s.GroupBy),
+		GroupBy:         transformGroupBy(s.GroupBy, supportsGroupByList),
 		Tags:            s.Tags,
 	}
 
@@ -177,14 +178,33 @@ func sloResponseToModel(spaceID string, res *slo.SloResponse) *models.Slo {
 		TimeWindow:      res.TimeWindow,
 		Objective:       res.Objective,
 		Settings:        &res.Settings,
+		GroupBy:         transformGroupByFromResponse(res.GroupBy),
 		Tags:            res.Tags,
 	}
 }
 
-func transformGroupBy(groupBy *string) *slo.SloResponseGroupBy {
+func transformGroupBy(groupBy []string, supportsGroupByList bool) *slo.SloResponseGroupBy {
 	if groupBy == nil {
 		return nil
 	}
 
-	return &slo.SloResponseGroupBy{String: groupBy}
+	if !supportsGroupByList && len(groupBy) > 0 {
+		return &slo.SloResponseGroupBy{
+			String: &groupBy[0],
+		}
+	}
+
+	return &slo.SloResponseGroupBy{ArrayOfString: &groupBy}
+}
+
+func transformGroupByFromResponse(groupBy slo.SloResponseGroupBy) []string {
+	if groupBy.String != nil {
+		return []string{*groupBy.String}
+	}
+
+	if groupBy.ArrayOfString == nil {
+		return nil
+	}
+
+	return *groupBy.ArrayOfString
 }