| Message ID | 20180713155403.30020-5-qi.fuli@jp.fujitsu.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
On Sat, 2018-07-14 at 00:54 +0900, QI Fuli wrote: > This patch is used to add man page for ndctl monitor command. > > Signed-off-by: QI Fuli <qi.fuli@jp.fujitsu.com> > --- > Documentation/ndctl/Makefile.am | 3 +- > Documentation/ndctl/ndctl-monitor.txt | 104 ++++++++++++++++++++++++++ > 2 files changed, 106 insertions(+), 1 deletion(-) > create mode 100644 Documentation/ndctl/ndctl-monitor.txt > > diff --git a/Documentation/ndctl/Makefile.am b/Documentation/ndctl/Makefile.am > index 4fd9636..a30b139 100644 > --- a/Documentation/ndctl/Makefile.am > +++ b/Documentation/ndctl/Makefile.am > @@ -46,7 +46,8 @@ man1_MANS = \ > ndctl-inject-error.1 \ > ndctl-inject-smart.1 \ > ndctl-update-firmware.1 \ > - ndctl-list.1 > + ndctl-list.1 \ > + ndctl-monitor.1 > > CLEANFILES = $(man1_MANS) > > diff --git a/Documentation/ndctl/ndctl-monitor.txt b/Documentation/ndctl/ndctl-monitor.txt > new file mode 100644 > index 0000000..4f1803e > --- /dev/null > +++ b/Documentation/ndctl/ndctl-monitor.txt > @@ -0,0 +1,104 @@ > +// SPDX-License-Identifier: GPL-2.0 > + > +ndctl-monitor(1) > +================ > + > +NAME > +---- > +ndctl-monitor - Monitor the smart events of nvdimm objects > + > +SYNOPSIS > +-------- > +[verse] > +'ndctl monitor' [<options>] > + > +DESCRIPTION > +----------- > +Ndctl monitor is used for monitoring the smart events of nvdimm > +objects and dumping the json format notifications to syslog, standard > +output or a logfile. > + > +The objects to monitor and smart events to notify can be selected by > +setting options and/or the default configuration file > +(/etc/ndctl/monitor.conf). Both of the values in configuration file > +and in options will work. If there is a conflict, the values in > +options will override the values in configuration file. The changed > +values in configuration file will work after the monitor is restarted. > + > +The smart threshold evnet alarm of dimm will be turned on when the > +monitor gets started, if it is set off. > + > +EXAMPLES > +-------- > + > +Run a monitor as a daemon to monitor DIMMs on bus "nfit_test.1" > +[verse] > +ndctl monitor --bus nfit_test.1 --daemon > + > +Run a monitor as a one-shot command and output the notifications to > +/var/log/ndctl.log > +[verse] > +ndctl monitor -log /var/log/ndctl.log > + > +Run a monitor daemon as a system service > +[verse] > +systemctl start ndctl-monitor.service > + > +OPTIONS > +------- > +-b:: > +--bus=:: > + Enforce that the operation only be carried on devices that are > + attached to the given bus. Where 'bus' can be a provider name > + or a bus id number. > + > +-d:: > +--dimm=:: > + A 'nmemX' device name, or dimm id number. Select the devices to > + monitor reference the given dimm. > + > +-r:: > +--region=:: > + A 'regionX' device name, or a region id number. The keyword 'all' > + can be specified to carry out the operation on every region in > + the system, optionally filtered by bus id (see --bus= option). > + > +-n:: > +--namespace=:: > + A 'namespaceX.Y' device name, or namespace region plus id tuple > + 'X.Y'. > + > +-l <file | syslog | standard>:: > +--log=<file | syslog | standard>:: > + Output notifications to <file>, syslog or standard output. > + > +--daemon:: > + Run a monitor as a daemon. > + > +-D:: > +--dimm-event=:: > + Name of an smart health event from the following: > + - "dimm-spares-remaining": Spare Blocks Remaining value has gone > + below the pre-programmed threshold. > + - "dimm-media-temperature": NVDIMM Media temperature value has > + gone above the pre-programmed threshold. > + - "dimm-controller-temperature": NVDIMM Controller temperature > + value has gone above the pre-programmed threshold. > + - "dimm-health-state": NVDIMM Normal Health Status has changed > + - "dimm-unclean-shutdown": NVDIMM Last Shutdown Status was a > + unclean shutdown. Can you add a short note here saying something like: "The monitor will attempt to enable the alarm control bits for all specified events." The rest of this looks good, thanks for the quick updates! > +-u:: > +--human:: > + Output monitor notification as human friendly json format instead > + of the default machine friendly json format. > + > +COPYRIGHT > +--------- > +Copyright (c) 2018, FUJITSU LIMITED. License GPLv2: GNU GPL version 2 > +<http://gnu.org/licenses/gpl.html>. This is free software: you are > +free to change and redistribute it. There is NO WARRANTY, to the > +extent permitted by law. > + > +SEE ALSO > +-------- > +linkndctl:ndctl-list[1], linkndctl:ndctl-inject-smart[1]
diff --git a/Documentation/ndctl/Makefile.am b/Documentation/ndctl/Makefile.am index 4fd9636..a30b139 100644 --- a/Documentation/ndctl/Makefile.am +++ b/Documentation/ndctl/Makefile.am @@ -46,7 +46,8 @@ man1_MANS = \ ndctl-inject-error.1 \ ndctl-inject-smart.1 \ ndctl-update-firmware.1 \ - ndctl-list.1 + ndctl-list.1 \ + ndctl-monitor.1 CLEANFILES = $(man1_MANS) diff --git a/Documentation/ndctl/ndctl-monitor.txt b/Documentation/ndctl/ndctl-monitor.txt new file mode 100644 index 0000000..4f1803e --- /dev/null +++ b/Documentation/ndctl/ndctl-monitor.txt @@ -0,0 +1,104 @@ +// SPDX-License-Identifier: GPL-2.0 + +ndctl-monitor(1) +================ + +NAME +---- +ndctl-monitor - Monitor the smart events of nvdimm objects + +SYNOPSIS +-------- +[verse] +'ndctl monitor' [<options>] + +DESCRIPTION +----------- +Ndctl monitor is used for monitoring the smart events of nvdimm +objects and dumping the json format notifications to syslog, standard +output or a logfile. + +The objects to monitor and smart events to notify can be selected by +setting options and/or the default configuration file +(/etc/ndctl/monitor.conf). Both of the values in configuration file +and in options will work. If there is a conflict, the values in +options will override the values in configuration file. The changed +values in configuration file will work after the monitor is restarted. + +The smart threshold evnet alarm of dimm will be turned on when the +monitor gets started, if it is set off. + +EXAMPLES +-------- + +Run a monitor as a daemon to monitor DIMMs on bus "nfit_test.1" +[verse] +ndctl monitor --bus nfit_test.1 --daemon + +Run a monitor as a one-shot command and output the notifications to +/var/log/ndctl.log +[verse] +ndctl monitor -log /var/log/ndctl.log + +Run a monitor daemon as a system service +[verse] +systemctl start ndctl-monitor.service + +OPTIONS +------- +-b:: +--bus=:: + Enforce that the operation only be carried on devices that are + attached to the given bus. Where 'bus' can be a provider name + or a bus id number. + +-d:: +--dimm=:: + A 'nmemX' device name, or dimm id number. Select the devices to + monitor reference the given dimm. + +-r:: +--region=:: + A 'regionX' device name, or a region id number. The keyword 'all' + can be specified to carry out the operation on every region in + the system, optionally filtered by bus id (see --bus= option). + +-n:: +--namespace=:: + A 'namespaceX.Y' device name, or namespace region plus id tuple + 'X.Y'. + +-l <file | syslog | standard>:: +--log=<file | syslog | standard>:: + Output notifications to <file>, syslog or standard output. + +--daemon:: + Run a monitor as a daemon. + +-D:: +--dimm-event=:: + Name of an smart health event from the following: + - "dimm-spares-remaining": Spare Blocks Remaining value has gone + below the pre-programmed threshold. + - "dimm-media-temperature": NVDIMM Media temperature value has + gone above the pre-programmed threshold. + - "dimm-controller-temperature": NVDIMM Controller temperature + value has gone above the pre-programmed threshold. + - "dimm-health-state": NVDIMM Normal Health Status has changed + - "dimm-unclean-shutdown": NVDIMM Last Shutdown Status was a + unclean shutdown. +-u:: +--human:: + Output monitor notification as human friendly json format instead + of the default machine friendly json format. + +COPYRIGHT +--------- +Copyright (c) 2018, FUJITSU LIMITED. License GPLv2: GNU GPL version 2 +<http://gnu.org/licenses/gpl.html>. This is free software: you are +free to change and redistribute it. There is NO WARRANTY, to the +extent permitted by law. + +SEE ALSO +-------- +linkndctl:ndctl-list[1], linkndctl:ndctl-inject-smart[1]
This patch is used to add man page for ndctl monitor command. Signed-off-by: QI Fuli <qi.fuli@jp.fujitsu.com> --- Documentation/ndctl/Makefile.am | 3 +- Documentation/ndctl/ndctl-monitor.txt | 104 ++++++++++++++++++++++++++ 2 files changed, 106 insertions(+), 1 deletion(-) create mode 100644 Documentation/ndctl/ndctl-monitor.txt