Web

Synopsis

rsb web [OPTIONS] URI*

Description

Serve via HTTP information about the RSB system reachable via the transports designated by URIs (zero or more URIs).

When no URIs are supplied, the default transport configuration is used.

The usual commandline options and environment variables are accepted. Specialized commandline options:

--address ADDRESS

Address on which the HTTP server should listen.

--port PORT

Port on which the HTTP server should listen.

--static-directory DIRECTORY

Directory from which static content such as HTML pages and CSS files should be read.

--response-timeout SECONDS

Time in seconds to wait for responses to introspection requests.

In most systems, all replies should arrive within a few milliseconds. However, circumstances like heavily loaded system, degraded system performance or extreme communication latency may required larger values.

See also

URIs
For details regarding the URI syntax of URI for specifying transport and scope.
Common Commandline Options
The usual commandline options are accepted.

Provided HTTP endpoints

  • http://ADDRESS:PORT/static

    Contents of the directory specified via --static-directory is made available here.

  • http://ADDRESS:PORT/introspection/json

    A JSON-serialization of a snapshot of the introspection data for the system or systems specified via URIs can be obtained here.

Examples

  • $ rsb web

    In the above example, the web command is used to collect information about the RSB system or systems that can be contacted via the currently configured transports. The information is served via HTTP, with the server listening on the default address and port, i.e. http://localhost:4444.

  • $ rsb web socket: spread://somehost

    Gather information via two transports: the socket transport and the Spread transport. The gathered information is merged as if all collected processes and participants were participant in a single RSB bus.

Implementations

Implementation Language Project Repository Link
Common Lisp rsb-tools-cl “0.13” branch of https://code.cor-lab.org/git/rsb.git.tools-cl