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

FreeBSD Manual Pages

  
 
  

home | help
PROMETHEUS_SYSCTL_EX...	FreeBSD	System Manager's ManualPROMETHEUS_SYSCTL_EX...

NAME
     prometheus_sysctl_exporter	-- print kernel	state as Prometheus metrics

SYNOPSIS
     prometheus_sysctl_exporter	[-dgh] [prefix ...]

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 prometheus_sysctl_exporter utility prints the values of sysctl	nodes
     to	standard output, formatted such	that they can be scraped by Prometheus
     directly.	By default, it prints metrics for all numerically repre-
     sentable nodes in the sysctl namespace.  It is also possible to limit
     output to a smaller number	of metrics by specifying one or	more prefixes
     as	arguments.

     Metrics printed by	this utility are named `sysctl_', followed by the name
     of	the sysctl node	having its `.' separators replaced by `_'.  Components
     on	which it is desirable to aggregate (e.g., names	of devices) are	omit-
     ted from the metric's name, but are appended as labels instead.

     There are two different methods for exporting the output of
     prometheus_sysctl_exporter	to Prometheus.	The first method is to period-
     ically invoke this	utility	through	cron(8)	and store its output in	a
     textfile.	The metrics in this textfile can then be served	over HTTP
     using the Prometheus node exporter's textfile collector.  The second
     method is to run this utility through inetd(8).  TCP port 9124 has	been
     allocated for this	purpose.

     The following options are available:

     -d	     Print descriptions	of metrics when	available.

     -g	     Gzip compresses the HTTP response body.

     -h	     Precede the output	with a HTTP response header.  This flag	is
	     required when running this	utility	through	inetd(8).

SEE ALSO
     cron(8), inetd(8),	sysctl(8), SYSCTL_ADD_NODE_WITH_LABEL(9)

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

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

     Prometheus	node exporter: https://github.com/prometheus/node_exporter.

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

HISTORY
     prometheus_sysctl_exporter	first appeared in FreeBSD 12.0.

AUTHORS
     Nuxi: https://nuxi.nl/.

FreeBSD	11.1		       December	18, 2016		  FreeBSD 11.1

NAME | SYNOPSIS | DESCRIPTION | SEE ALSO | HISTORY | AUTHORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=prometheus_sysctl_exporter&sektion=8&manpath=FreeBSD+12-current>

home | help