luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

docs: added os_service

This commit is contained in:
Alessandro De Blasis 2022-06-07 18:25:24 +01:00
parent dcb511e78a
commit 716324df7d
3 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
website/content/api-docs/agent/check.mdx
View File

@ -242,6 +242,9 @@ The check sends datagrams to the value specified at the interval specified in th
If the datagram is sent successfully or a timeout is returned, the check is set to the `passing` state. If the datagram is sent successfully or a timeout is returned, the check is set to the `passing` state.
The check is logged as `critical` if the datagram is sent unsuccessfully. The check is logged as `critical` if the datagram is sent unsuccessfully.
- `OSService` `(string: "")` - Specifies an `OS` service to check.
Windows Services on Windows or SystemD services on Unix.
- `TTL` `(duration: 10s)` - Specifies this is a TTL check, and the TTL endpoint - `TTL` `(duration: 10s)` - Specifies this is a TTL check, and the TTL endpoint
must be used periodically to update the state of the check. If the check is not must be used periodically to update the state of the check. If the check is not
set to passing within the specified duration, then the check will be set to the failed state. set to passing within the specified duration, then the check will be set to the failed state.

9
website/content/docs/discovery/checks.mdx
View File

@ -86,11 +86,18 @@ There are several different kinds of checks:
`timeout` field in the check definition. `timeout` field in the check definition.
- `UDP + Interval` - These checks direct the client to periodically send UDP datagrams - `UDP + Interval` - These checks direct the client to periodically send UDP datagrams
to the specified IP/hostname and port. The duration specified in the `interval` field sets the amount of time to the specified IP/hostname and port. The duration specified in the `interval` field sets the amount of time
between attempts, such as `30s` to indicate 30 seconds. The check is logged as healthy if any response from the UDP server is received. Any other result sets the status to `critical`. between attempts, such as `30s` to indicate 30 seconds. The check is logged as healthy if any response from the UDP server is received. Any other result sets the status to `critical`.
The default interval for, UDP checks is `10s`, but you can configure a custom UDP check timeout value by specifying the The default interval for, UDP checks is `10s`, but you can configure a custom UDP check timeout value by specifying the
`timeout` field in the check definition. If any timeout on read exists, the check is still considered healthy. `timeout` field in the check definition. If any timeout on read exists, the check is still considered healthy.
- `OSService + Interval` - These checks monitor the health of a service running on
the host operating system. Windows Services or SystemD services on Windows and Unix respectively.
The check is logged as `healthy` if the service is running.
If it is stopped or not running, the status is `critical`, every other result sets
the status to `warning` since it basically means that there are issues in determining the
health of the service and the check is not reliable.
- `Time to Live (TTL)` ((#ttl)) - These checks retain their last known state - `Time to Live (TTL)` ((#ttl)) - These checks retain their last known state
for a given TTL. The state of the check must be updated periodically over the HTTP for a given TTL. The state of the check must be updated periodically over the HTTP
interface. If an external system fails to update the status within a given TTL, interface. If an external system fails to update the status within a given TTL,

1
website/content/docs/ecs/configuration-reference.mdx
View File

@ -86,6 +86,7 @@ Defines the Consul checks for the service. Each check may contain these fields.
| `method` | `string` | optional | Specifies the HTTP method to be used for an HTTP check. When no value is specified, `GET` is used. | | `method` | `string` | optional | Specifies the HTTP method to be used for an HTTP check. When no value is specified, `GET` is used. |
| `name` | `string` | optional | The name of the check. | | `name` | `string` | optional | The name of the check. |
| `notes` | `string` | optional | Specifies arbitrary information for humans. This is not used by Consul internally. | | `notes` | `string` | optional | Specifies arbitrary information for humans. This is not used by Consul internally. |
| `os_service` | `string` | optional | Specifies an `OS Service` check. Must be the name of the service which status will be checked every `interval`. |
| `status` | `string` | optional | Specifies the initial status the health check. Must be one of `passing`, `warning`, `critical`, `maintenance`, or`null`. | | `status` | `string` | optional | Specifies the initial status the health check. Must be one of `passing`, `warning`, `critical`, `maintenance`, or`null`. |
| `successBeforePassing` | `integer` | optional | Specifies the number of consecutive successful results required before check status transitions to passing. | | `successBeforePassing` | `integer` | optional | Specifies the number of consecutive successful results required before check status transitions to passing. |
| `tcp` | `string` | optional | Specifies this is a TCP check. Must be an IP/hostname plus port to which a TCP connection is made every `interval`. | | `tcp` | `string` | optional | Specifies this is a TCP check. Must be an IP/hostname plus port to which a TCP connection is made every `interval`. |