Merge pull request #27 from statuspal/add-metric-data-source

FabianDaniel00 · web-flow · commit 410cb0e0753a · 2024-11-26T18:46:19.000+01:00
feat: add metric and metrics data source
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,12 @@ All notable changes of the StatusPal Terraform provider will be documented in th
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.0] - 2024-10-17
+
+### Added
+
+- Metric resource and metrics data source.
+
 ## [0.2.12] - 2024-10-17
 
 ### Fixed
diff --git a/docs/data-sources/metrics.md b/docs/data-sources/metrics.md
@@ -0,0 +1,69 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "statuspal_metrics Data Source - statuspal"
+subcategory: ""
+description: |-
+  
+---
+
+# statuspal_metrics (Data Source)
+
+
+
+## Example Usage
+
+```terraform
+# List all metrics of the status page with subdomain "example-com".
+data "statuspal_metrics" "example" {
+  status_page_subdomain = "example-com"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `status_page_subdomain` (String) The status page subdomain of the services.
+
+### Optional
+
+- `query` (Block, Optional) (see [below for nested schema](#nestedblock--query))
+
+### Read-Only
+
+- `id` (String) Placeholder identifier attribute. Ignore it, only used in testing.
+- `metrics` (Attributes List) The metrics (see [below for nested schema](#nestedatt--metrics))
+
+<a id="nestedblock--query"></a>
+### Nested Schema for `query`
+
+Optional:
+
+- `after` (String) Used as a cursor for pagination
+- `before` (String) Used as a cursor for pagination
+- `limit` (Number) Set the number of metrics to return in the response. This defaults to 20 items
+
+
+<a id="nestedatt--metrics"></a>
+### Nested Schema for `metrics`
+
+Required:
+
+- `id` (String) The unique identifier for the metric.
+
+Read-Only:
+
+- `enabled` (Boolean) A flag indicating if the metric is enabled.
+- `featured_number` (String) A featured number for the metric.
+- `integration_id` (Number) The integration ID related to the metric.
+- `latest_entry_time` (Number) The timestamp for the latest entry of the metric.
+- `order` (Number) The order of the metric in the system.
+- `remote_id` (String) The remote ID for the metric.
+- `remote_name` (String) The remote name for the metric.
+- `status` (String) The status of the metric.
+- `threshold` (Number) The threshold value for the metric.
+- `title` (String) The title of the metric.
+- `type` (String) The type of the metric.
+- `unit` (String) The unit of measurement for the metric.
+- `visible` (Boolean) A flag indicating if the metric is visible.
diff --git a/docs/index.md b/docs/index.md
@@ -18,7 +18,7 @@ terraform {
   required_providers {
     statuspal = {
       source  = "statuspal/statuspal"
-      version = "0.2.12"
+      version = "0.3.0"
     }
   }
 
diff --git a/docs/resources/metric.md b/docs/resources/metric.md
@@ -0,0 +1,72 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "statuspal_metric Resource - statuspal"
+subcategory: ""
+description: |-
+  
+---
+
+# statuspal_metric (Resource)
+
+
+
+## Example Usage
+
+```terraform
+# Manage example metric of the status page with subdomain "example-com".
+resource "statuspal_metric" "example" {
+  status_page_subdomain = "example-com"
+  metric = {
+    title = "example"
+    unit  = "ms"
+    type  = "rt"
+  }
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `metric` (Attributes) The metric. (see [below for nested schema](#nestedatt--metric))
+- `status_page_subdomain` (String) The status page subdomain of the services.
+
+### Read-Only
+
+- `id` (String) Placeholder identifier attribute. Ignore it, only used in testing.
+
+<a id="nestedatt--metric"></a>
+### Nested Schema for `metric`
+
+Required:
+
+- `title` (String) The title of the metric.
+- `type` (String) The type of the metric.
+- `unit` (String) The unit of measurement for the metric.
+
+Optional:
+
+- `enabled` (Boolean) A flag indicating if the metric is enabled.
+- `featured_number` (String) A featured number for the metric.
+- `integration_id` (Number) The integration ID related to the metric.
+- `order` (Number) The order of the metric in the system.
+- `remote_id` (String) The remote ID for the metric.
+- `remote_name` (String) The remote name for the metric.
+- `threshold` (Number) The threshold value for the metric.
+- `visible` (Boolean) A flag indicating if the metric is visible.
+
+Read-Only:
+
+- `id` (String) The unique identifier for the metric.
+- `latest_entry_time` (Number) The timestamp for the latest entry of the metric.
+- `status` (String) The status of the metric.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# Service can be imported by specifying the status page subdomain and metric ID.
+terraform import statuspal_metric.example "example-com 1"
+```
diff --git a/examples/data-sources/statuspal_metrics/data-source.tf b/examples/data-sources/statuspal_metrics/data-source.tf
@@ -0,0 +1,4 @@
+# List all metrics of the status page with subdomain "example-com".
+data "statuspal_metrics" "example" {
+  status_page_subdomain = "example-com"
+}
diff --git a/examples/metric/main.tf b/examples/metric/main.tf
@@ -13,20 +13,15 @@ provider "statuspal" {
   region  = "US"
 }
 
-resource "statuspal_status_page" "example" {
-  organization_id = "1"
-  status_page = {
-    name      = "example"
-    url       = "example.com"
-    time_zone = "Europe/Berlin"
-  }
-}
-
-resource "statuspal_metric" "example" {
-  status_page_subdomain = statuspal_status_page.example.status_page.subdomain
+resource "statuspal_metric" "edu" {
+  status_page_subdomain = "example-com"
   metric = {
     title = "example"
     unit  = "ms"
     type  = "rt"
   }
 }
+
+output "example_statuspal_metric" {
+  value = statuspal_metric.edu
+}
diff --git a/examples/metrics/main.tf b/examples/metrics/main.tf
@@ -0,0 +1,23 @@
+terraform {
+  required_providers {
+    statuspal = {
+      source = "registry.terraform.io/statuspal/statuspal"
+    }
+  }
+
+  required_version = ">= 1.2.0"
+}
+
+provider "statuspal" {
+  api_key = "uk_aERPQU1kUzUrRmplaXJRMlc2TDEwZz09"
+  region  = "US" // "US" or "EU"
+}
+
+data "statuspal_metrics" "edu" {
+  status_page_subdomain = "example-com"
+}
+
+
+output "edu_statuspal_metrics" {
+  value = data.statuspal_metrics.edu
+}
diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -3,7 +3,7 @@ terraform {
   required_providers {
     statuspal = {
       source  = "statuspal/statuspal"
-      version = "0.2.12"
+      version = "0.3.0"
     }
   }
 
diff --git a/examples/resources/statuspal_metric/import.sh b/examples/resources/statuspal_metric/import.sh
@@ -0,0 +1,2 @@
+# Service can be imported by specifying the status page subdomain and metric ID.
+terraform import statuspal_metric.example "example-com 1"
diff --git a/examples/resources/statuspal_metric/resource.tf b/examples/resources/statuspal_metric/resource.tf
@@ -0,0 +1,9 @@
+# Manage example metric of the status page with subdomain "example-com".
+resource "statuspal_metric" "example" {
+  status_page_subdomain = "example-com"
+  metric = {
+    title = "example"
+    unit  = "ms"
+    type  = "rt"
+  }
+}
diff --git a/internal/client/metrics.go b/internal/client/metrics.go
@@ -4,51 +4,69 @@ import (
 	"encoding/json"
 	"fmt"
 	"net/http"
+	"net/url"
 	"strings"
 )
 
-// MetricType defines the possible types for metrics (Uptime or Response Time).
-type MetricType string
-
 const (
-	MetricTypeUptime       MetricType = "up"
-	MetricTypeResponseTime MetricType = "rt"
+	MetricTypeUptime       string = "up"
+	MetricTypeResponseTime string = "rt"
 )
 
-// FeaturedNumber defines the possible types for the featured number.
-type FeaturedNumber string
-
 const (
-	FeaturedNumberAvg  FeaturedNumber = "avg"
-	FeaturedNumberMax  FeaturedNumber = "max"
-	FeaturedNumberLast FeaturedNumber = "last"
+	FeaturedNumberAvg  string = "avg"
+	FeaturedNumberMax  string = "max"
+	FeaturedNumberLast string = "last"
 )
 
-// Metric represents a metric on the status page.
-type Metric struct {
-	ID              int64          `json:"id,omitempty"`
-	Status          string         `json:"status,omitempty"`
-	LatestEntryTime int64          `json:"latest_entry_time,omitempty"`
-	Order           int64          `json:"order,omitempty"`
-	Title           string         `json:"title"`
-	Unit            string         `json:"unit"`
-	Type            MetricType     `json:"type"`
-	Enabled         bool           `json:"enabled,omitempty"`
-	Visible         bool           `json:"visible,omitempty"`
-	RemoteID        string         `json:"remote_id,omitempty"`
-	RemoteName      string         `json:"remote_name,omitempty"`
-	Threshold       int64          `json:"threshold,omitempty"`
-	FeaturedNumber  FeaturedNumber `json:"featured_number,omitempty"`
-	IntegrationID   string         `json:"integration_id,omitempty"`
-}
-
 type MetricBody struct {
 	Metric Metric `json:"metric"`
 }
 
+type MetricsBody struct {
+	Metrics []Metric `json:"metrics"`
+}
+
+type MetricsQuery struct {
+	Before string `query:"before"`
+	After  string `query:"after"`
+	Limit  int64  `query:"limit"`
+}
+
+func (c *Client) GetMetrics(statusPageSubdomain string, query MetricsQuery) (*[]Metric, error) {
+	urlParams := url.Values{}
+	if query.Before != "" {
+		urlParams.Add("before", query.Before)
+	}
+	if query.After != "" {
+		urlParams.Add("after", query.After)
+	}
+	if query.Limit > 0 {
+		urlParams.Add("limit", fmt.Sprintf("%d", query.Limit))
+	}
+
+	req, err := http.NewRequest("GET", fmt.Sprintf("%s/status_pages/%s/metrics%s", c.HostURL, statusPageSubdomain, urlParams.Encode()), nil)
+	if err != nil {
+		return nil, err
+	}
+
+	body, err := c.doRequest(req)
+	if err != nil {
+		return nil, err
+	}
+
+	response := MetricsBody{}
+	err = json.Unmarshal(*body, &response)
+	if err != nil {
+		return nil, err
+	}
+
+	return &response.Metrics, nil
+}
+
 // GetMetric retrieves a single metric by ID.
-func (c *Client) GetMetric(id int64, subdomain string) (*Metric, error) {
-	req, err := http.NewRequest("GET", fmt.Sprintf("%s/status_pages/%s/metrics/%d", c.HostURL, subdomain, id), nil)
+func (c *Client) GetMetric(id string, subdomain string) (*Metric, error) {
+	req, err := http.NewRequest("GET", fmt.Sprintf("%s/status_pages/%s/metrics/%s", c.HostURL, subdomain, id), nil)
 	if err != nil {
 		return nil, err
 	}
@@ -96,15 +114,15 @@ func (c *Client) CreateMetric(subdomain string, metric *Metric) (*Metric, error)
 }
 
 // UpdateMetric updates an existing metric on the status page.
-func (c *Client) UpdateMetric(id int64, subdomain string, metric *Metric) (*Metric, error) {
+func (c *Client) UpdateMetric(id string, subdomain string, metric *Metric) (*Metric, error) {
 	rb, err := json.Marshal(MetricBody{
 		Metric: *metric,
 	})
 	if err != nil {
 		return nil, err
 	}
 
-	req, err := http.NewRequest("PUT", fmt.Sprintf("%s/status_pages/%s/metrics/%d", c.HostURL, subdomain, id), strings.NewReader(string(rb)))
+	req, err := http.NewRequest("PUT", fmt.Sprintf("%s/status_pages/%s/metrics/%s", c.HostURL, subdomain, id), strings.NewReader(string(rb)))
 	if err != nil {
 		return nil, err
 	}
@@ -124,8 +142,8 @@ func (c *Client) UpdateMetric(id int64, subdomain string, metric *Metric) (*Metr
 }
 
 // DeleteMetric deletes a metric from the status page.
-func (c *Client) DeleteMetric(id int64, subdomain string) error {
-	req, err := http.NewRequest("DELETE", fmt.Sprintf("%s/status_pages/%s/metrics/%d", c.HostURL, subdomain, id), nil)
+func (c *Client) DeleteMetric(id string, subdomain string) error {
+	req, err := http.NewRequest("DELETE", fmt.Sprintf("%s/status_pages/%s/metrics/%s", c.HostURL, subdomain, id), nil)
 	if err != nil {
 		return err
 	}
diff --git a/internal/client/models.go b/internal/client/models.go
@@ -150,3 +150,21 @@ type NotificationRecipient struct {
 	ID    int64  `json:"id"`
 	Email string `json:"email"` // Add more fields as needed
 }
+
+// Metric represents a metric on the status page.
+type Metric struct {
+	ID              int64  `json:"id"`
+	Status          string `json:"status"`
+	LatestEntryTime int64  `json:"latest_entry_time"`
+	Order           int64  `json:"order"`
+	Title           string `json:"title"`
+	Unit            string `json:"unit"`
+	Type            string `json:"type"`
+	Enabled         bool   `json:"enabled"`
+	Visible         bool   `json:"visible"`
+	RemoteID        string `json:"remote_id"`
+	RemoteName      string `json:"remote_name"`
+	Threshold       int64  `json:"threshold"`
+	FeaturedNumber  string `json:"featured_number"`
+	IntegrationID   *int64 `json:"integration_id"`
+}
diff --git a/internal/provider/metric_resource.go b/internal/provider/metric_resource.go
diff --git a/internal/provider/metric_resource_test.go b/internal/provider/metric_resource_test.go
diff --git a/internal/provider/metrics_data_source.go b/internal/provider/metrics_data_source.go
diff --git a/internal/provider/metrics_data_source_test.go b/internal/provider/metrics_data_source_test.go
diff --git a/internal/provider/provider.go b/internal/provider/provider.go

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ terraform {`
`18`	`18`	`required_providers {`
`19`	`19`	`statuspal = {`
`20`	`20`	`source = "statuspal/statuspal"`
`21`		`- version = "0.2.12"`
	`21`	`+ version = "0.3.0"`
`22`	`22`	`}`
`23`	`23`	`}`
`24`	`24`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ terraform {`
`3`	`3`	`required_providers {`
`4`	`4`	`statuspal = {`
`5`	`5`	`source = "statuspal/statuspal"`
`6`		`- version = "0.2.12"`
	`6`	`+ version = "0.3.0"`
`7`	`7`	`}`
`8`	`8`	`}`
`9`	`9`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# Service can be imported by specifying the status page subdomain and metric ID.`
	`2`	`+terraform import statuspal_metric.example "example-com 1"`