Checks¶
At its core, argos runs checks and return the results to the service. Here are the implemented checks, with a description of what they do and how to configure them.
Simple checks¶
These checks are the most basic ones. They simply check that the response from the service matches what you expect.
Check |
Description |
Configuration |
---|---|---|
|
Check that the returned status code matches what you expect. |
|
|
Check that the returned status code is in the list of codes you expect. |
|
|
Check that the returned body contains a given string. |
|
|
Check that the returned body matches a given regex. |
|
|
Check that the response contains the expected headers. |
|
|
Check that the response contains the expected headers with the expected value. |
|
|
Check that response headers contains the expected headers and that the values matches the provided regexes. |
|
|
Check that JSON response contains the expected structure. |
|
|
Check that JSON response contains the expected structure and values. |
|
|
Check that JSON response contains the expected structure and that the values matches the provided regexes. |
|
|
Check that JSON response is the exact expected JSON object. |
|
- domain: "https://example.org"
paths:
- path: "/"
checks:
- status-is: 200
- body-contains: "Hello world"
- body-like: "Hel+o w.*"
- headers-contain:
- "content-encoding"
- "content-type"
- path: "/foobar"
checks:
- status-in:
- 200
- 302
# It’s VERY important to respect the 4 spaces indentation here!
- headers-have:
content-encoding: "gzip"
content-type: "text/html"
# It’s VERY important to respect the 4 spaces indentation here!
# You have to double the escape character \
- headers-like:
content-encoding: "gzip|utf"
content-type: "text/(html|css)"
- json-contains:
- /foo/bar/0
- /timestamp
# It’s VERY important to respect the 4 spaces indentation here!
- json-has:
/maintenance: false
/productname: "Nextcloud"
# It’s VERY important to respect the 4 spaces indentation here!
# You have to double the escape character \
- json-like:
/productname: ".*cloud"
/versionstring: "29\\..*"
- json-is: '{"foo": "bar", "baz": 42}'
SSL certificate expiration¶
Checks that the SSL certificate will not expire soon. You need to define the thresholds in the configuration, and set the on-check
option to enable the check.
ssl:
thresholds:
- "1d": critical
- "5d": warning
- domain: "https://example.org"
paths:
- path: "/"
checks:
- ssl-certificate-expiration: "on-check"