refactor: cleanup and move API

.github/workflows/end2end.yml

@@ -60,7 +60,7 @@ jobs:
           --set sparrowConfig.name=the-sparrow.com \
           --set sparrowConfig.loader.type=file \
           --set sparrowConfig.loader.file.path=/config/.sparrow.yaml \
-          --set checksConfig.checks.health.interval=1s \
+          --set checksConfig.health.interval=1s \
           ./chart
 
     - name: Check Pods

README.md

@@ -409,7 +409,7 @@ checks:
   - Description: Count of DNS checks done
   - Labelled with `target`
 
-- `sparrow_dns_duration`
+- `sparrow_dns_duration_seconds`
   - Type: Gauge
   - Description: Duration of DNS resolution attempts
   - Labelled with `target`

chart/README.md

@@ -20,7 +20,7 @@ A Helm chart to install Sparrow
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | affinity | object | `{}` |  |
-| checksConfig | object | `{"checks":{}}` | Check configuration of the Sparrow read on runtime see: https://github.com/caas-team/sparrow?tab=readme-ov-file#checks |
+| checksConfig | object | `{}` | Check configuration of the Sparrow read on runtime see: https://github.com/caas-team/sparrow?tab=readme-ov-file#checks |
 | env | object | `{}` |  |
 | envFromSecrets | list | `[]` | extra environment variables Allows you to set environment variables through secrets you defined outside of the helm chart Useful for sensitive information like the http loader token |
 | extraArgs | object | `{}` | Extra command line start parameters see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md |

chart/values.yaml

@@ -137,36 +137,34 @@ sparrowConfig:
 
 # -- Check configuration of the Sparrow read on runtime
 # see: https://github.com/caas-team/sparrow?tab=readme-ov-file#checks
-checksConfig:
-  checks: {}
-  # checks:
-  #   health:
-  #     interval: 15s
-  #     timeout: 10s
-  #     retry:
-  #       count: 3
-  #       delay: 1s
-  #     targets:
-  #       - "https://www.example.com/"
-  #       - "https://www.google.com/"
-  #   latency:
-  #     interval: 15s
-  #     timeout: 30s
-  #     retry:
-  #       count: 3
-  #       delay: 2s
-  #     targets:
-  #       - https://example.com/
-  #       - https://google.com/
-  #   dns:
-  #     interval: 10s
-  #     timeout: 30s
-  #     retry:
-  #       count: 5
-  #       delay: 1s
-  #     targets:
-  #       - www.example.com
-  #       - www.google.com
+checksConfig: {}
+#  health:
+#     interval: 15s
+#     timeout: 10s
+#     retry:
+#       count: 3
+#       delay: 1s
+#     targets:
+#       - "https://www.example.com/"
+#       - "https://www.google.com/"
+#  latency:
+#     interval: 15s
+#     timeout: 30s
+#     retry:
+#       count: 3
+#       delay: 2s
+#     targets:
+#       - https://example.com/
+#       - https://google.com/
+#   dns:
+#     interval: 10s
+#     timeout: 30s
+#     retry:
+#       count: 5
+#       delay: 1s
+#     targets:
+#       - www.example.com
+#       - www.google.com
 
 # -- Configure a service monitor for prometheus-operator
 serviceMonitor:

cmd/run.go

@@ -64,7 +64,7 @@ func NewCmdRun() *cobra.Command {
 // run is the entry point to start the sparrow
 func run() func(cmd *cobra.Command, args []string) error {
 	return func(cmd *cobra.Command, args []string) error {
-		cfg := config.NewConfig()
+		cfg := &config.Config{}
 		err := viper.Unmarshal(cfg)
 		if err != nil {
 			return fmt.Errorf("failed to parse config: %w", err)

go.mod

@@ -6,9 +6,8 @@ require (
 	github.com/getkin/kin-openapi v0.120.0
 	github.com/go-chi/chi/v5 v5.0.10
 	github.com/jarcoal/httpmock v1.3.1
-	github.com/mitchellh/mapstructure v1.5.0
 	github.com/spf13/cobra v1.8.0
-	github.com/spf13/viper v1.18.0
+	github.com/spf13/viper v1.18.2
 	github.com/stretchr/testify v1.8.4
 	gopkg.in/yaml.v3 v3.0.1
 )
@@ -29,6 +28,7 @@ require (
 	github.com/magiconair/properties v1.8.7 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
+	github.com/mitchellh/mapstructure v1.5.0 // indirect
 	github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 // indirect
 	github.com/pelletier/go-toml/v2 v2.1.0 // indirect
 	github.com/perimeterx/marshmallow v1.1.5 // indirect

go.sum

@@ -88,8 +88,8 @@ github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0=
 github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho=
 github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
 github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
-github.com/spf13/viper v1.18.0 h1:pN6W1ub/G4OfnM+NR9p7xP9R6TltLUzp5JG9yZD3Qg0=
-github.com/spf13/viper v1.18.0/go.mod h1:EKmWIqdnk5lOcmR72yw6hS+8OPYcwD0jteitLMVB+yk=
+github.com/spf13/viper v1.18.2 h1:LUXCnvUvSM6FXAsj6nnfc8Q2tp1dIgUfY9Kc8GsSOiQ=
+github.com/spf13/viper v1.18.2/go.mod h1:EKmWIqdnk5lOcmR72yw6hS+8OPYcwD0jteitLMVB+yk=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
 github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=