mozilla-lk / griffin Goto Github PK

Describe the bug
If you have a duration like 10hreouz its still accepted as hours

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

Griffin is supposed to be easily configurable, fast solution for monitoring external backend services.
It should be able to know the backends, their health check method(ping or GET), the interval of testing and notification methods

Since YAML is highly used in DevOps environments, it's better to stick with YAML syntax for the operation.

A sample config would be like

services:
  - name: Foo Web Service
    host: foo.example.com
    health:
      - method: http
        endpoint: /status
        interval: 10s
      - method: ping
        interval: 5s
  - name: Bar Web Service
    host: bar.example.com
    health:
      - method: http
        endpoint: /statuz
        interval: 15s
      - method: ping
        interval: 10s
alerts:
  - type: Email
    from: [email protected]
    to: [email protected]
  - type: Webhook
    url: https://mywebhook.com/abcd13345

Hosting a public status page is a popular concept and it would be ideal for Griffin to have a small html page with status plastered on it in addition to the inbuilt notification systems.

Ref - https://status.foss.lk

# Sample griffin file

services:
  - name: Foo Web Service
    host: $FOO_HOST
    health:
      - method: http
        endpoint: /status
        port: 4040
        interval: 1h
      - method: ping
  - name: Bar Web Service
    host: bar.example.com
    health:
      - method: http
        endpoint: /statuz
        interval: 15s
      - method: ping
        interval: 30ms
alerts:
  - type: Email
    from: [email protected]
    to: [email protected]
  - type: Webhook
    url: $WEBHOOK_URL

Need to expand the environment variables

• Remove seconds
• Add default 1 min
• Use chrono duration

• Define a Notification Trait
• Implement
  • Discord
  • Slack
  • Email

Notifications

Currently, a File Path is used for obtaining the data.
It is not flexible, so we need a generic version of the reader for config

As per mentioned in #1 we want a way to check health from a given backend.

• it should do a GET request if a path is not provided by the user
• if the path is given request should be forwarded to it
• the result will determine the state of the backend service(for now lets simply pick != 200)
• it should be able to configure the interval

• Expose a REST API from griffin
  • Get server status in JSON format

• Schedule tasks to run periodically

Griffin should save collected information to a database like sqlite so we can later display the result

Something like following would be enough as a starting point,

service: service.example.com
datetime: utc_time_code
status: response_status

At the moment, we do not handle any time units with the application so this leads to errors when running the application. It would be best if we could handle time units using Serde.