diff options
author | Markos Fountoulakis <44345837+mfundul@users.noreply.github.com> | 2019-12-05 00:21:22 +0200 |
---|---|---|
committer | Chris Akritidis <43294513+cakrit@users.noreply.github.com> | 2019-12-04 14:21:22 -0800 |
commit | 16f835489c1a93b5dbd84747c52c883f43b716f0 (patch) | |
tree | fe91de0b4fa0d85f52870550e410bc1d0dead434 /cli/README.md | |
parent | a7a88ba2723242da1de6626df0541d2091bd9b2b (diff) |
Implement netdata command server and cli tool (#7325)
* Checkpoint commit (POC)
* Implemented command server in the daemon
* Add netdatacli implementation
* Added prints in command server setup functions
* Make libuv version 1 a hard dependency for the agent
* Additional documentation
* Improved accuracy of names and documentation
* Fixed documentation
* Fixed buffer overflow
* Added support for exit status in cli. Added prefixes for exit code, stdout and stderr. Fixed parsers.
* Fix compilation errors
* Fix compile errors
* Fix compile errors
* Fix compile error
* Fix linker error for muslc
Diffstat (limited to 'cli/README.md')
-rw-r--r-- | cli/README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/cli/README.md b/cli/README.md new file mode 100644 index 0000000000..3872dac1c1 --- /dev/null +++ b/cli/README.md @@ -0,0 +1,26 @@ +# Netdata cli + +You can see the commands netdatacli supports by executing it with `netdatacli` and entering `help` in +standard input. All commands are given as standard input to `netdatacli`. + +The commands that a running netdata agent can execute are the following: + +```sh +The commands are (arguments are in brackets): +help + Show this help menu. +reload-health + Reload health configuration. +save-database + Save internal DB to disk for for memory mode save. +reopen-logs + Close and reopen log files. +shutdown-agent + Cleanup and exit the netdata agent. +fatal-agent + Log the state and halt the netdata agent. +``` + +Those commands are the same that can be sent to netdata via [signals](../daemon#command-line-options). + +[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcli%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>) |