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

FreeBSD Manual Pages

  
 
  

home | help
GEOM-EXPORTER(8)	    System Manager's Manual	      GEOM-EXPORTER(8)

NAME
       geom-exporter --	Export GEOM statistics to Prometheus

SYNOPSIS
       geom-exporter [-hP] [-b address]	[-p port] [-f pattern] [-F pattern]

DESCRIPTION
       Prometheus is a monitoring system that gathers metrics from its targets
       by  fetching them through HTTP GET requests.  Metrics are identified by
       a name and an optional set of labels.  Sample values are	required to be
       numerical.

       The geom-exporter daemon	publishes statistics  from  the	 FreeBSD  GEOM
       system  via  an	HTTP  server,  in  the correct format to be scraped by
       Prometheus.  Its	options	are as follows:

       -f, --pattern pattern
	       A regular expression that can be	used to	only  show  statistics
	       for some	devices.  Only devices with the	names matching pattern
	       will be published.  The format of the regular expression	is de-
	       scribed at https://docs.rs/regex.

       -F, --pattern pattern
	       A  regular  expression that can be used to exclude devices.  No
	       devices with names matching pattern will	be published.

       -b, --address address
	       Bind to this local address.   By	 default,  geom-exporter  will
	       bind to the wildcard address.

       -p, --port port
	       Serve metrics on	this TCP port.	The default is 9248.

       -P, --physical
	       Only display physical providers (those with rank	of 1).

SEE ALSO
       gstat(8)

       Prometheus project: https://prometheus.io/.

       Prometheus		       exposition		      formats:
       https://prometheus.io/docs/instrumenting/exposition_formats/.

       Prometheus	     default		 port		  allocations:
       https://github.com/prometheus/prometheus/wiki/Default-port-allocations.

FreeBSD	Ports 14.quarterly	April 17, 2024		      GEOM-EXPORTER(8)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=geom-exporter&sektion=8&manpath=FreeBSD+Ports+14.3.quarterly>

home | help