Feat/latency check

[niklastreml]

Motivation

Implements a latency check, that checks whether an endpoint is reachable and collects Timing metrics.

Config file

The check has the following config options:

checks:
  latency:
    enabled: true
    interval: 1
    timeout: 3
    retry:
      count: 3
      delay: 1
    targets:
      - https://example.com/
      - https://google.com/
      - https://httpbin.org/delay/2
      - https://httpbin.org/status/500
      - http://localhost:8080/checks/v1alpha1/latency
      - http://localhost:8081/checks/v1alpha1/latency

Sample output

{
	"data": {
		"https://google.com/": {
			"code": 200,
			"error": null,
			"total": 128
		},
		"https://httpbin.org/delay/2": {
			"code": 200,
			"error": null,
			"total": 2283
		},
		"https://httpbin.org/status/500": {
			"code": 500,
			"error": null,
			"total": 133
		}
	},
	"timestamp": "2023-11-29T18:25:03.071057924+01:00",
	"error": ""
}

Openapi Spec

openapi: 3.0.0
components: {}
info:
    title: Sparrow Metrics API
    description: Serves metrics collected by sparrows checks
    contact:
        name: CaaS Team
        url: https://caas.telekom.de
        email: [email protected]
    version: ""
paths:
    /v1/metrics/latency:
        description: latency
        get:
            tags:
                - Metrics
                - latency
            description: Returns the performance data for check latency
            responses:
                "200":
                    description: Metrics for check latency
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        additionalProperties:
                                            has: null
                                            schema:
                                                type: object
                                                properties:
                                                    code:
                                                        type: integer
                                                    error:
                                                        type: string
                                                    total:
                                                        type: integer
                                                        format: int64
                                    error:
                                        type: string
                                    timestamp:
                                        type: string
                                        format: date-time

Tests done

TODO

• Unit tests
• Fix timing info is always 0
• Docs

[y-eight]

pls merge main into branch.

hint: I renamed loaderFile to loaderFilePath