Configuration¶
It is important to have a valid configuration file in the etc/
directory before starting data collection. The installation automatically creates a default version that may need to be edited. This page explains the various configuration parameters.
The examples/etc
directory includes a sample reference file.
infoset-ng Configuration Example¶
In this example we explain each parameter in the configuration file.
The main
section governs the general operation of infoset-ng
.
main:
log_directory: /opt/infoset/log
log_level: debug
ingest_cache_directory: /opt/infoset/cache
ingest_pool_size: 20
interval: 300
listen_address: 0.0.0.0
bind_port: 6000
sqlalchemy_pool_size: 10
sqlalchemy_max_overflow: 10
memcached_hostname: localhost
memcached_port: 11211
db_hostname: localhost
db_username: infoset_ng
db_password: PASSWORD
db_name: infoset_ng
username: USERNAME
An explanation of these fields follows:
Parameter | Description |
---|---|
main: |
YAML key describing the server configuration. |
log_directory: |
The directory where infoset-ng places its log files |
log_level: |
Defines the logging level. debug level is the most verbose, followed by info , warning and critical |
ingest_cache_directory: |
Location where the agent data ingester will store its data in the event it cannot communicate with either the database or the server’s API |
ingest_pool_size: |
The maximum number of threads used to ingest data into the database |
interval: |
The expected interval in seconds between updates to the database from systems posting to the infoset API. Data retieved from the API will be spaced interval seconds apart. |
listen_address: |
IP address the API will be using. The default is 0.0.0.0 or all available IP addresses |
bind_port: |
The TCP port the API will be listening on |
sqlalchemy_pool_size: |
The SQLAlchemy pool size. This is the largest number of connections that infoset-ng will be keep persistently with the MySQL database |
sqlalchemy_max_overflow: |
The SQLAlchemy maximum overflow size. When the number of connections reaches the size set in sqlalchemy_pool_size , additional connections will be returned up to this limit. This is the floating number of additional database connections to be made available. |
memcached_hostname: localhost |
The hostname of our memcached cache server |
memcached_port: 11211 |
The port which memcached is running on |
db_hostname: |
The devicename or IP address of the database server. |
db_username: |
The database username |
db_password: |
The database password |
db_name: |
The name of the database |
username: |
The username that scripts should run as |
Logrotate Configuration¶
The examples/linux/logrotate/infoset-ng
file is a working logrotate
configuration to rotate the log files that infoset-ng
generates. The infoset-ng
log file data can be extensive and adding the logrotate file to your system
is highly recommended.
$ sudo cp examples/linux/logrotate/infoset-ng /etc/logrotate.d
Next Steps¶
It is time to test the operation of infoset-ng
.