feat(cockpit): add getRulesCount endpoint (scaleway#2623)

Author: scaleway-bot

api/cockpit/v1/cockpit_sdk.go

@@ -550,6 +550,18 @@ type GetConfigResponseRetention struct {
 	DefaultDays uint32 `json:"default_days"`
 }
 
+// RulesCount: rules count.
+type RulesCount struct {
+	// DataSourceID: ID of the data source.
+	DataSourceID string `json:"data_source_id"`
+
+	// DataSourceName: name of the data source.
+	DataSourceName string `json:"data_source_name"`
+
+	// RulesCount: total count of rules associated with this data source.
+	RulesCount int32 `json:"rules_count"`
+}
+
 // Alert: Structure representing an alert.
 type Alert struct {
 	// Region: the region in which the alert is defined.
@@ -799,6 +811,18 @@ type GetConfigResponse struct {
 	ProductLogsRetention *GetConfigResponseRetention `json:"product_logs_retention"`
 }
 
+// GetRulesCountResponse: get rules count response.
+type GetRulesCountResponse struct {
+	// RulesCountByDatasource: total count of rules grouped by data source.
+	RulesCountByDatasource []*RulesCount `json:"rules_count_by_datasource"`
+
+	// PreconfiguredRulesCount: total count of preconfigured rules.
+	PreconfiguredRulesCount int32 `json:"preconfigured_rules_count"`
+
+	// CustomRulesCount: total count of custom rules.
+	CustomRulesCount int32 `json:"custom_rules_count"`
+}
+
 // GlobalAPICreateGrafanaUserRequest: Create a Grafana user.
 type GlobalAPICreateGrafanaUserRequest struct {
 	// ProjectID: ID of the Project in which to create the Grafana user.
@@ -1283,6 +1307,15 @@ type RegionalAPIGetDataSourceRequest struct {
 	DataSourceID string `json:"-"`
 }
 
+// RegionalAPIGetRulesCountRequest: regional api get rules count request.
+type RegionalAPIGetRulesCountRequest struct {
+	// Region: region to target. If none is passed will use default region from the config.
+	Region scw.Region `json:"-"`
+
+	// ProjectID: ID of the Project to retrieve the rule count for.
+	ProjectID string `json:"project_id"`
+}
+
 // RegionalAPIGetTokenRequest: Get a token.
 type RegionalAPIGetTokenRequest struct {
 	// Region: region to target. If none is passed will use default region from the config.
@@ -2300,6 +2333,42 @@ func (s *RegionalAPI) DisableAlertManager(req *RegionalAPIDisableAlertManagerReq
 	return &resp, nil
 }
 
+// GetRulesCount: Get a detailed count of enabled rules in the specified Project. Includes preconfigured and custom alerting and recording rules.
+func (s *RegionalAPI) GetRulesCount(req *RegionalAPIGetRulesCountRequest, opts ...scw.RequestOption) (*GetRulesCountResponse, error) {
+	var err error
+
+	if req.Region == "" {
+		defaultRegion, _ := s.client.GetDefaultRegion()
+		req.Region = defaultRegion
+	}
+
+	if req.ProjectID == "" {
+		defaultProjectID, _ := s.client.GetDefaultProjectID()
+		req.ProjectID = defaultProjectID
+	}
+
+	query := url.Values{}
+	parameter.AddToQuery(query, "project_id", req.ProjectID)
+
+	if fmt.Sprint(req.Region) == "" {
+		return nil, errors.New("field Region cannot be empty in request")
+	}
+
+	scwReq := &scw.ScalewayRequest{
+		Method: "GET",
+		Path:   "/cockpit/v1/regions/" + fmt.Sprint(req.Region) + "/rules/count",
+		Query:  query,
+	}
+
+	var resp GetRulesCountResponse
+
+	err = s.client.Do(scwReq, &resp, opts...)
+	if err != nil {
+		return nil, err
+	}
+	return &resp, nil
+}
+
 // CreateContactPoint: Contact points are email addresses associated with the default receiver, that the Alert manager sends alerts to.
 // The source of the alerts are data sources within the same Project and region as the Alert manager.
 // If you need to receive alerts for other receivers, you can create additional contact points and receivers in Grafana. Make sure that you select the Scaleway Alert manager.