tideways-daemon Configuration Reference

The Tideways daemon usually does not require additional manual configuration by you. The following options are configurable:

--hostname

Changes the transmitted hostname from the system hostname to a custom defined one. It defaults to the server name, if possible the fully qualified server name. On Docker Containers the Container ID is appended to the hostname for de-duplication.

--debug

Log more information into the logfile.

--log

points to the logfile that should be used. The daemons init scripts use /var/log/tideways/daemon.log by default.

--log-parser-errors

Enables logging of errors in anomyization parsers, such as the SQL anonymizer.

--dryrun

Dry run mode not sending the data, for example to log which data will be sending.

--log-outgoing

Can be used to check what data is sent to Tideways if you want to control the privacy settings. Payload is logged into the daemon’s logfile (See --log flag).

--env

Toggles the environment this server is automatically registered in when first connecting to the Profiler. Defaults to "production". You can alternatively use the TIDEWAYS_ENVIRONMENT environment variable.

--version

Show version of the daemon and quit.

--pidfile

Points to a PID file used to cleanup sockets on startup.

--address

Change location of the default UNIX Socket, switch to TCP/IP.

--insecure

Do not verify the peer’s certificate (Not recommended!)

--retry-on-network-failure (New in 1.7)

Enable up to five retries using exponential backoff for payloads that failed to get transmitted to the backend due to errors or network failure. This is in Beta for now and not enabled by default.

--server-cert

Manually provide public part of the server’s certificate. Only to be used in combination with collection proxies.

--proxy

If outgoing traffic requires a proxy, use this flag to pass a host:port combination pointing to the proxy. Using proxy with authentication add`user:pass` in the URL, for example --proxy=http://user:pass@host:port.

--disable-server-metrics

disables the collection of Load, CPU, Memory, Network and disk metrics that are stored on each trace.

--statsd

Integration of statsD network daemon, setting ip:port sends data to StatsD service running on this ip and port.

--dogstatsd

Integration with Datadog daemon, setting to ip:port sends data to a datadog-agent using the DogstatsD protocol.

--use-connection-pool (New in 1.7.20)

For incoming connections from the PHP extension using a fixed size pool for processing instead of unbounded number of workers. Size of the pool can be set with --connection-pool-size=<number> and defaults to half the number of available cores by default. This feature is enabled by default since version 1.8 and can be disabled with --use-connectino-pool=false.

You can add flags to the startup of the daemon service by adding a file /etc/default/tideways-daemon with the variable TIDEWAYS_DAEMON_EXTRA="" defined with the flags of your choice.

TIDEWAYS_DAEMON_EXTRA="--hostname=myserver"

If you want to change the location of the log file please use TIDEWAYS_DAEMON_LOGFILE.

TIDEWAYS_DAEMON_LOGFILE="/var/log/tideways/daemon.log"

You can change the configured Tideways environment that the daemon is running:

TIDEWAYS_ENVIRONMENT=staging

How can I troubleshoot the daemon?

There is a logfile in /var/log/tideways/daemon.log if you are using the Ubuntu package or the tarball and invoke install.sh.

Maintenance

You should make sure the directory /var/log/tideways is added to log rotation, especially when you enable the --debug flag. The tarball install script, Ubuntu/Debian and RPM packages do this by default by putting a rotation config file into /etc/logrotate.d/.

Further reading

Still need help? Email [email protected]