Standalone AppSignal Agent configuration options
The following list includes all configuration options with the name of the key in the configuration file.
For more information on how to configure the Standalone AppSignal Agent with a configuration file, see our Installation page.
Available options
- Required options
- Options
app_name
| Config file key | app_name |
|---|---|
| Required | yes |
| Type | String |
| Default value | nil (This is unset by default) |
Description
Name of your application as it should be displayed on AppSignal.com.
environment
| Config file key | environment |
|---|---|
| Required | yes |
| Type | String |
| Default value | nil (This is unset by default) |
Description
The environment of the app to be reported to AppSignal.
push_api_key
| Config file key | push_api_key |
|---|---|
| Required | yes |
| Type | String |
| Default value | nil (This is unset by default) |
Description
The organization-level authentication key to authenticate with our Push API.
Read more about the AppSignal Push API key.
ca_file_path
| Config file key | ca_file_path |
|---|---|
| Required | no |
| Type | String |
| Default value | Defaults to system CAs. |
Description
- Configure the path of the SSL certificate file.
- Use this option to point to another certificate file if there's a problem connecting to our API.
-
Note: The specified path cannot contain Operating Specific file system abstractions, such as the homedir symbol
~for *NIX systems. This will be seen as a malformed path.
dns_servers
| Config file key | dns_servers |
|---|---|
| Required | no |
| Type | String |
| Default value | nil (This is unset by default) |
Description
Configure DNS servers for the AppSignal agent to use.
# /etc/appsignal-agent.conf
dns_servers = "8.8.8.8,8.8.4.4"If you're affected by our DNS timeouts, try setting a DNS server manually using this option that doesn't use more than 4 dots in the server name.
- Acceptable values:
8.8.8.8,my.custom.local.server. - Not acceptable values:
foo,my.awesome.custom.local.dns.server.
If the DNS server cannot be reached the agent will fall back on the host's DNS configuration and output a message in the appsignal.log file: A problem occurred while setting DNS servers.
hostname
| Config file key | hostname |
|---|---|
| Required | no |
| Type | String |
| Default value | detected from system |
Description
This overrides the server's hostname. Useful for when you're unable to set a custom hostname or when a nondescript id is generated for you on hosting services.
http_proxy
| Config file key | http_proxy |
|---|---|
| Required | no |
| Type | String |
| Default value | nil (This is unset by default) |
Description
If you require the agent to connect to the Internet via a proxy set the complete proxy URL in this configuration key.
log_level
| Config file key | log_level |
|---|---|
| Required | no |
| Type | String |
| Default value | info |
Description
Set the severity level of the AppSignal logger. If it is configured to "info" it will log all error, warning and info messages, but not log the debug messages.
Setting it to the levels "debug" or "trace" is usually only needed on request from support. Setting the level to "debug"/"trace" could have a slight impact on the disk usage and IO, especially on high-traffic sites. CPU overhead is minimal with the debug option enabled.
Accepted values:
- error
- warning
- info
- debug
- trace
push_api_endpoint
| Config file key | push_api_endpoint |
|---|---|
| Required | no |
| Type | String |
| Default value | https://push.appsignal.com |
Description
Configure the endpoint to send data to AppSignal. This setting will not have to be changed.
send_environment_metadata
| Config file key | send_environment_metadata |
|---|---|
| Required | no |
| Type | Boolean (true / false) |
| Default value | true |
Description
Send environment metadata about the app.
For more information please read about environment metadata.
working_dir_path
| Config file key | working_dir_path |
|---|---|
| Required | no |
| Type | String |
| Default value | /var/lib/appsignal-agent |
Description
Override the location where the Standalone AppSignal Agent can store temporary files. Use this option if the default location is not suitable. See our how AppSignal operates page for more information about the purpose of this working directory.
~ for *NIX systems. This will be seen as a malformed path.