gatus icon indicating copy to clipboard operation
gatus copied to clipboard

API response message in case of failure

Open 221bshashank opened this issue 2 years ago • 3 comments

suppose the specified conditions did not meet the API response, so it failed but the API response has a message, is it possible to show it in frontend? for eg.

    "plugins": {
        "healthy": false,
        "message": "There are 2 failed plugins: abc; def",
        "duration": 0,
        "timestamp": "2023-11-03T20:15:24.806Z"
    }

221bshashank avatar Nov 03 '23 20:11 221bshashank

Just so I understand correctly, you're asking if an endpoint returns an error in one of the parameters from the body, you'd like bubble up that error to the UI?

If so, couldn't you just do something like add the condition [BODY].message == "" (assuming the message parameter only gets populated if healthy is false) & the message would be displayed in the tooltip when you hover the failed condition on the UI?

TwiN avatar Nov 05 '23 00:11 TwiN

That's a good suggestion actually for one of the use cases, but what if gatus is showing Invalid character 'u' looking for beginning of value, and when I did a get call to the endpoint the response I got is unauthorized: members ["token:check"] cannot perform action "system:status:get" on resource "system:service:status" filtered by projects []

221bshashank avatar Nov 06 '23 09:11 221bshashank

can I give nested condition like if "healthy"== false, then check for message, because my API call pops up the error message parameter only when the healthy is false. so when I am placing a permanent condition in Gatus config of message it is failing saying invalid parameter

221bshashank avatar Nov 07 '23 09:11 221bshashank