Configuration¶
temBoard agent reads configuration from arguments, environment and file. Defaut
configuration file is /etc/temboard-agent/temboard-agent.conf
. You can
change this with TEMBOARD_CONFIGFILE
envvar or --configfile
switch.
temBoard agent always searches for a directory whose name is built with the
config file and the .d
suffix. Thus the default config directory is
/etc/temboard-agent/temboard-agent.conf.d
. temBoard agent reads only files
suffixed with .conf
. temBoard agent reads files in POSIX sort order:
uppercase precedes lowercase.
The configuration file is mandatory. The configuration directory is optional.
The configuration file is in INI-style format as implemented by Python stlib config parser. Configuration parameters are distributed under sections:
temboard
: this is the main section grouping core parameters;postgresql
: parameters related to the PostgreSQL cluster that the agent is connected to;logging
: how and where to log;dashboard
: parameters of the plugindashboard
;monitoring
: pluginmonitoring
;administration
: pluginadministration
,maintenance
: pluginmaintenance
.statements
: pluginstatements
;
temboard
section¶
port
: port number that the agent will listen on to serve itsHTTP API
. Default:2345
;address
: IP v4 address that the agent will listen on. Default:0.0.0.0
(all);users
: Path to the file containing the list of the users allowed to use theHTTP API
. Default:/etc/temboard-agent/users
;plugins
: Array of plugin (name) to load. Default:["monitoring", "dashboard", "pgconf", "administration", "activity", "maintenance", "statements"]
;ssl_cert_file
: Path to SSL certificate file (.pem) for the embeded HTTPS process serving the API. Default:/etc/temboard-agent/temboard-agent_CHANGEME.pem
;ssl_key_file
: Path to SSL private key file. Default:/etc/temboard-agent/temboard-agent_CHANGEME.key
;home
: Path to agent home directory, it contains files used to store temporary data. When running multiple agents on the same host, each agent must have its own home directory. Default:/var/lib/temboard-agent/main
.hostname
: Overrides real machine hostname. Must be a valid FQDN. Default:None
;
postgresql
section¶
host
: Path to PostgreSQL unix socket. Default:/var/run/postgresql
;port
: PostgreSQL port number. Default:5432
;user
: PostgreSQL user. Must be a super-user. Default:postgres
;password
: User password. Default:None
;dbname
: Database name for the connection. Default:postgres
;instance
: Cluster name. Default:main
.key
: Authentication key used to send data to the UI. Default:None
;
logging
section¶
method
: Method used to send the logs:stderr
,syslog
orfile
. Default:syslog
;facility
: Syslog facility. Default:local0
;destination
: Path to the log file. Default:/dev/log
;level
: Log level, can be set toDEBUG
,INFO
,WARNING
,ERROR
orCRITICAL
. Default:INFO
.debug
: A comma separated list of loggers to which level will be set toDEBUG
.
dashboard
plugin¶
scheduler_interval
: Time interval, in second, between each run of the process collecting data used to render the dashboard. Default:2
;history_length
: Number of record to keep. Default:150
.
monitoring
plugin¶
dbnames
: Database name list (comma separated) to supervise. * for all. Default:*
;probes
: List of probes to run (comma separated). * for all. Default:*
;scheduler_interval
: Interval, in second, between each run of the process executing the probes. Default:60
;
administration
plugin¶
pg_ctl
: External command used to start/stop PostgreSQL. Default:None
.
statements
plugin¶
dbname
: Name of the database hostingpg_stat_statements
view, enabled through creation of the eponymous extension. Default:postgres
.