Sharing Logs and Telemetry with Tonic

Purpose of Tonic logs

Tonic uses these logs to diagnose issues, troubleshoot bugs, help identify when performance can be improved, and to generally improve Tonic and its features. If a user decides to not share logs with Tonic, which is the default, then identifying problems and troubleshooting issues becomes a more manual and slower process.

Architecture

What is in the log data:

Schema information

Tonic logs include detailed schema information of your database. Including things like table, schema, and column names, data types, sizes of tables, etc. We do not however, log information related to database users such as username.

Usage information

Tonic includes many types of usage information in the logs. This includes information related to actions in the UI (via web requests seen by the web server), details related to data generation, and Workspace configuration details such as which generators are applied to which columns.

Performance Data

Tonic collects detailed performance data of the generation process. This includes things like data transfer rates and code profiler results.

What is NOT in the log data:

Tonic has strong safeguards in place to ensure that actual data does not leak into logs. Additionally, Tonic does not log information related to the database connection, e.g. database username, password, host, etc.

​

How to set it up

Logging can be enabled on each individual Tonic container. For the container on which you wish to enable logging you must add the following two environmental values to the applicable container:

Environment:
    ENABLE_LOG_COLLECTION: true
    ENVIRONMENT_NAME: "your company's name, in lowercase with no spaces"

How to view what is being sent to Tonic

Tonic writes all logs to STDOUT. You can view the exact logs being collected and shared by viewing what is being written to STDOUT. One way to accomplish this, assuming the Tonic container is running in Docker would be to run

docker logs tonic_worker

​

​