Editing agf.conf | Angelfish Configuration File

The main application configuration file for Angelfish is  /agf.conf.  

This file specifies some settings that can be changed, it is found in the directory where Angelfish was unpacked and installed.  

You can edit this file with your preferred text editor.  

Here is an introduction to what can be edited and some examples.



token= - Do not change this value.  This is created from the license you received from us, and is used for encrypting the license and other data.  If this is changed everything will stop working for your Angelfish instance. 

datadir= - This is where the data directory resides.  By default the data directory lives in the same installation directory as the rest of the Angelfish files.  Some may move the data directory to another directory for space or speed purposes, which is possible.  Manually move the data directory, and update agf.conf here to look for it in the right location.

defaultbrowsedir= - This tells Angelfish which directory to look at first when browsing for datasources in the configuration screen.  When setting up a new datasource this will default to the installation directory, yet you can edit this to look at a specific directory if you have most of your log files stored in a certain place.



ip= - The IP address to bind to.  Use to bind to all IPs (even the loop-back).

port= - This sets the port for Angelfish to listen on for incoming connection requests.  By default this is set to port 9000.  When using your internet browser to open the Angelfish UI, this port is what you will enter after the IP address of the server you have Angelfish running on.  Changing the port will let you avoid using one that other services may be using.

timeout= - The number of seconds to allow http requests before timing out.

backlog= - Maximum length the queue of pending connections may grow to.

use_ssl= - This controls whether Angelfish will accept only an SSL connection or not.  Set this to 1 if your organization uses SSL.

NOTE:  You will need to obtain or create the required SSL certificate and key files in order to enable SSL.  See README-SSL.txt in the 'certs' subdirectory for more information on how to do this.

childprocs= - The number of sub-processes to spawn to handle requests.  A higher number will mean a more responsive server, but too many may slow things down.  Adjust this setting with care.

reqsperchild= - The number of requests s sub-process will serve before it expires.  This value shouldn't normally have to be altered.



host= - The host to contact for data source information.  On a single-server installation, this should be set to localhost (or whatever the 'ip' value in the [angelfishd] section is set to.)



reload= - Scheduler reloads entries at this interval (in minutes).  This sets how often schedulerd will check for any new or pending tasks that need to be run (profile processing, etc).

max_log_processors= - The maximum number of log processors that can be running at any one time.

NOTE:  If there are a lot of profiles set to run at the same time and this value is set too high, the system will likely become slow or unresponsive until the processing queue has cleared.  Also, if there are many profiles scheduled to be run one minute after the previous, available memory and processor time will exponentially be queued and cause the system to become slow or unresponsive.
It is highly encouraged to spread out processing times, based on low usage times and other profile processing times.  



allow_tokens= - Whether or not to enable the API token authentication.  Setting to 0 will only allow the Angelfish interface to make API requests.

token_expiration= - Set the number of minutes after which to expire API tokens.  Setting to 0 will allow tokens to last indefinitely.

max_results= - Maximum number of results per API request.

max_dimensions= - Maximum number of dimensions per API request.

max_metrics= - Maximum number of metrics per API request.

max_sort= - Maximum number of sort fields per API request.

max_filters= - Maximum number of filters per API request.

Was this article helpful?
0 out of 0 found this helpful


Article is closed for comments.