Skip to content

Commit 5cc21fb

Browse files
authored
Merge pull request #74 from MisterMountain/docs
update the Usage in the Readme
2 parents f1fae1f + e597051 commit 5cc21fb

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,23 @@ Usage:
1212
1313
Available Commands:
1414
health Checks the health status of an Elasticsearch cluster
15+
ingest Checks the ingest statistics of Ingest Pipelines
1516
query Checks the total hits/results of an Elasticsearch query
17+
snapshot Checks the status of Elasticsearch snapshots
1618
1719
Flags:
18-
-H, --hostname string Hostname of the Elasticsearch instance (CHECK_ELASTICSEARCH_HOSTNAME) (default "localhost")
19-
-p, --port int Port of the Elasticsearch instance (default 9200)
20-
-U, --username string Username for HTTP Basic Authentication (CHECK_ELASTICSEARCH_USERNAME)
21-
-P, --password string Password for HTTP Basic Authentication (CHECK_ELASTICSEARCH_PASSWORD)
22-
-S, --tls Use a HTTPS connection
23-
--insecure Skip the verification of the server's TLS certificate
24-
--ca-file string Specify the CA File for TLS authentication (CHECK_ELASTICSEARCH_CA_FILE)
25-
--cert-file string Specify the Certificate File for TLS authentication (CHECK_ELASTICSEARCH_CERT_FILE)
26-
--key-file string Specify the Key File for TLS authentication (CHECK_ELASTICSEARCH_KEY_FILE)
27-
-t, --timeout int Timeout in seconds for the CheckPlugin (default 30)
28-
-h, --help help for check_elasticsearch
29-
-v, --version version for check_elasticsearch
20+
-H, --hostname string Hostname of the Elasticsearch instance (CHECK_ELASTICSEARCH_HOSTNAME) (default "localhost")
21+
-p, --port int Port of the Elasticsearch instance (default 9200)
22+
-U, --username string Username for HTTP Basic Authentication (CHECK_ELASTICSEARCH_USERNAME)
23+
-P, --password string Password for HTTP Basic Authentication (CHECK_ELASTICSEARCH_PASSWORD)
24+
-S, --tls Use a HTTPS connection
25+
--insecure Skip the verification of the server's TLS certificate
26+
--ca-file string Specify the CA File for TLS authentication (CHECK_ELASTICSEARCH_CA_FILE)
27+
--cert-file string Specify the Certificate File for TLS authentication (CHECK_ELASTICSEARCH_CERT_FILE)
28+
--key-file string Specify the Key File for TLS authentication (CHECK_ELASTICSEARCH_KEY_FILE)
29+
-t, --timeout int Timeout in seconds for the CheckPlugin (default 30)
30+
-h, --help help for check_elasticsearch
31+
-v, --version version for check_elasticsearch
3032
```
3133

3234
The check plugin respects the environment variables `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY`.

0 commit comments

Comments
 (0)