Sharing logs with Tonic.ai

You can automatically share logs from your on-premises installation with Tonic.ai engineers in a secure and safe way.

How Tonic.ai uses the Tonic logs

By default, logs are shared with Tonic.ai. For information about the required allowlisting for telemetry and log sharing, go to URL for telemetry and log sharing.

Tonic.ai uses these logs to diagnose issues, troubleshoot bugs, help identify when performance can be improved, and to generally improve Tonic Structural and its features.

If you do not share logs with Tonic.ai, then identifying problems and troubleshooting issues becomes a slower, more manual process.

Log file architecture

Structural log files are stored in an S3 bucket for one year.

Tonic.ai uses a log aggregator to make the log files searchable. On the log aggregator, job logs are deleted after six months. API logs are deleted after 60 days.

What is in the log data

Schema information

Structural logs include detailed schema information for your database, including:

  • Table, schema, and column names

  • Data types

  • Table sizes

Usage information

Structural includes many types of usage information in the logs, including information related to:

  • Actions in the user interface, from web requests that the web server sees

  • Details related to data generation

  • Workspace configuration details, such as the generators that are applied to each column

Performance data

Tonic.ai collects detailed performance data for the generation process, including data transfer rates and code profiler results.

What is NOT in the log data

Structural has strong safeguards in place to ensure that actual data does not leak into logs.

Logs that are shared with Tonic.ai are always redacted. Structural does not send diagnostic logs to Tonic.ai.

Structural does not log information related to the database connection, such as the database username, password, and host.

Verifying whether log sharing is enabled and connected

Required global permission: Update Tonic

From Tonic Settings, you can check the status of log sharing with Tonic.ai.

On the System Status tab, under Data Sharing, the Logging panel indicates whether:

  • Log sharing is enabled.

  • If it is enabled, then whether Structural can make the connection to send the logs.

Re-enabling log sharing

Log sharing is enabled on each individual Structural container.

If log sharing becomes disabled, then to enable log sharing in a container, add the following environment settings to the Structural web server container:

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

Viewing what is sent to Tonic.ai

Structural writes all logs to STDOUT. To view the exact logs that are collected and shared, view what is written to STDOUT.

If the Structural container runs in Docker, you can run:

docker logs tonic_worker

Last updated