waarp / analyze

A simple tool to gather information about Waarp services and about the server they run on
MIT License
1 stars 2 forks source link

Waarp Analyze

Waarp Analyze is a tool that gathers information about Waarp instances and about the server it runs on.

It is useful to generate reports about the state of the system when a transfer is in error, or to verify the global configuration.

Reports are generated in Restructured Text and can be converted to any format supported by docutils (or pandoc, or any RST converter).

.. _docutils: http://docutils.sourceforge.net/ .. _pandoc: http://pandoc.org/

Warning about compatibility

For now, Waarp Analyze only runs on GNU/Linux 32 and 64 bits. It only detects running instances of Waarp R66 Server.

Installation

Download the pre-compiled binaries for your system and architecture from https://dl.waarp.org/dist/waarp-analyze , decompress the archive.

You can then run Waarp Analyze with the command::

/path/to/waarp-analyze-{version}/waarp-analyze

Alternatively, you can build it from source with gb_: clone this repository, then run gb build at the root of the project.

.. _gb: https://getgb.io

Execution

You can run waarp-analyze directly or with following options::

$ ./bin/waarp-analyze --help Usage: waarp-analyze [OPTIONS]

Application Options: -v, --verbose Verbose output -V, --version Prints version and exits -o, --output= Write report to this location. Use '- for stdout -H, --hostid= Limit analyze to this Waarp instance

Help Options: -h, --help Show this help message

Roadmap

Following developments are planned:

Data Gathered

Waarp Analyze includes following data in reports:

License

Waarp Analyze is provided under the terms of the MIT license.