Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
JAIL_EXPORTER(8)	FreeBSD	System Manager's Manual	      JAIL_EXPORTER(8)

NAME
     jail_exporter -- Prometheus exporter for jail metrics

SYNOPSIS
     jail_exporter [-hV] [--help] [--version]
     jail_exporter [--output.file-path=path] [--web.listen-address=addr:port]
		   [--web.telemetry-path=path]

DESCRIPTION
     jail_exporter is a	Prometheus exporter for	jail metrics.  The options are
     as	follows:

     -h, --help
	     Prints help information

     -V, --version
	     Prints version information

     --output.file-path=path
	     Specify a path to write collected metrics to.  When jail_exporter
	     is	given a	path it	will exit immediately after writing the	met-
	     rics and the HTTPd	will not be started.  This option is designed
	     to	be paired with the Node	Exporter Textfile Collector.  Giving a
	     path of "-" will output collected metrics to stdout.

     --web.listen-address=addr:port
	     Specify an	addr:port on which to expose the metrics and web in-
	     terface.  Defaults	to "127.0.0.1:9452".  If specifying an IPv6
	     addr:port the address portion should be enclosed within square
	     brackets, for example: "[::1]:9452".

     --web.telemetry-path=path
	     Specify a path under which	to expose the metrics.	Defaults to
	     "/metrics".

USAGE
     jail_exporter must	be run as "root" in order to access the	required
     rctl(8) APIs.  Although FreeBSD ships with	RACCT/RCTL support in the ker-
     nel, it is	disabled by default.  It can be	enabled	by setting
     kern.racct.enabled="1" in /boot/loader.conf.  After setting this, a re-
     boot will be required to enable RACCT/RCTL.

METRICS
     The metrics that are exported are those listed in the RESOURCES section
     of	rctl(8), and the following additional metrics:

     exporter_build_info
	  The version of the currently running exporter, and the version of
	  Rust used to build the exporter.  The	version	is given in the
	  "version" label on the metric, while the Rust	version	used to	build
	  the exporter is given	in the "rustversion" label.  Does not possess
	  a "name" label.

     id	  The ID of the	named jail

     num  The current number of	jails running.	Does not possess a "name" la-
	  bel.

     All metrics are prefixed with the string "jail_" and in most cases	(ex-
     cept for the metrics mentioned above) possess a "name" label containing
     the name of the jail.  An example of a metric output by the exporter
     would be:

	   # HELP jail_cputime_seconds_total CPU time, in seconds
	   # TYPE jail_cputime_seconds_total counter
	   jail_cputime_seconds_total{name="test"} 300

ENVIRONMENT VARIABLES
     jail_exporter can also take its configuration from	environment variables.
     In	the event that both command line options and environment variables are
     specified,	the command line options will win.

     JAIL_EXPORTER_OUTPUT_FILE_PATH    is equivalent to	setting	the
				       --output.file-path option.

     JAIL_EXPORTER_WEB_LISTEN_ADDRESS  is equivalent to	setting	the
				       --web.listen-address option.

     JAIL_EXPORTER_WEB_TELEMETRY_PATH  is equivalent to	setting	the
				       --web.telemetry-path option.

FILES
     /usr/local/etc/rc.d/jail_exporter	the rc.d script
     /usr/local/sbin/jail_exporter	the exporter daemon

SEE ALSO
     rctl(4), loader.conf(5), jail(8), rctl(8)

HISTORY
     jail_exporter was started during the summer of 2018 on FreeBSD 11.1.

AUTHORS
     jail_exporter was developed by David O'Rourke with	contributions from
     Fabian Freyer.

BUGS
     Please report bugs, issues, and feature requests to
     https://github.com/phyber/jail_exporter/issues

FreeBSD	13.0		       January 10, 2019			  FreeBSD 13.0

NAME | SYNOPSIS | DESCRIPTION | USAGE | METRICS | ENVIRONMENT VARIABLES | FILES | SEE ALSO | HISTORY | AUTHORS | BUGS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=jail_exporter&sektion=8&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help