Observability

Observability settings

Logs

Logs settings

Disable health logs

Disable /health endpoint requests logging. Default value is false

Log file path

If provided, enables mode to pipe logs as JSON into the file by specified path.

If ElasticSearch URL is provided then the file is used as a fallback in case if ElasticSearch is not available.

Logs max lines

Sets the limit of log records to push into the file When the limit is reached, the current log file is renamed with .old postfix and a new log file is created

Logging SQL min duration

Threshold for logging only long queries. Analogous from PostgreSQL. Log only requests whose execution time exceeds the specified number of milliseconds.

Logging SQL max length

Max length of a query to be logged.

Metrics

Metrics settings

Metrics server port

Port on which Aidbox will expose metrics. To disable metrics server, leave this setting empty

Enable Postgres metrics

Controls whether to provide metrics related to PostgreSQL

Stdout

Stdout settings

Stdout log level

Controls stdout with specified logs level. Possible values: off, fatal, error, warn, info, debug, trace, all, true By setting one of these levels you would also get all the levels to the left. e.g. if you set log level to warn you would also get log events with fatal and error levels (off is excluded).

Pretty print log level

Controls pretty print of logs to stdout with specified level. Possible values: off, fatal, error, warn, info, debug, trace, all, true By setting one of these levels you would also get all the levels to the left. e.g. if you set log level to warn you would also get log events with fatal and error levels (off is excluded).

Google log level

Produces in Google Logging format with specified log level. Possible values: off, fatal, error, warn, info, debug, trace, all, true By setting one of these levels you would also get all the levels to the left. e.g. if you set log level to warn you would also get log events with fatal and error levels (off is excluded).

Loki

Grafana Loki settings

Loki URL

Loki URL to enable Aidbox logs uploading into Loki

Loki batch size

Loki batch size for log uploading. Aidbox uploads logs when either at least specific observability.loki.batch-size collected or time passed from previous log uploading exceeds observability.loki.batch-timeout.

Loki batch timeout

How long to wait before uploading Aidbox uploads logs when either at least observability.loki.batch-size entries collected or time passed from previous log uploading exceeds observability.loki.batch-timeout.

Loki stream

Stream refers to the labels or metadata associated with a log stream Is defined by a unique set of labels, which serve as the stream key. For example: {"box": "aidbox"}

Datadog

Datadog settings

Datadog API Key

Datadog API Key.

Datadog regional site

The regional site for a Datadog customer.

Datadog log tags

Tags associated with your logs. Convenient for transferring the name of the environment. For example env:staging.

Datadog log file path

Fallback file to write logs in if uploading to Datadog fails

Datadog log batch size

How many log entries to collect before uploading. Aidbox uploads logs when either at least specific observability.datadog.batch-size collected or time passed from previous log uploading exceeds observability.datadog.batch-timeout.

Datadog log batch timeout

How long to wait before uploading Aidbox uploads logs when either at least specific observability.datadog.batch-size collected or time passed from previous log uploading exceeds observability.datadog.batch-timeout.

Elastic

Elastic settings

Elastic Search auth

Format: <user>:<password> Basic auth credentials for ElasticSearch. API key is not supported.

Elastic Search URL

If provided, enables mode to push logs to ElasticSearch

Elastic Search batch size

Log batch size used to optimize log shipping performance. The default value is 200

Elastic Search batch timeout

Timeout to post a batch to ElasticSearch. If there is not enough records to reach full batch size

Elastic Search log format

Custom index format string. The default value is 'aidbox-logs'-yyyy-MM-dd.

Grafana

Grafana settings

Grafana URL for metrics dashboards

Grafana URL to update the metrics dashboards.

Grafana user for metrics dashboards

Grafana user to update the metrics dashboards.

Grafana password for metrics dashboards

Grafana password to update the metrics dashboards.

OTEL

OpenTelemetry settings

OTEL metrics request headers

The headers for OTEL metrics requests, formatted as HeaderName:HeaderValue HeaderName:HeaderValue.

OTEL metrics URL

The metrics' consumer URL (OTEL collector, Elastic EPM etc.).

OTEL metrics interval

The time interval (in seconds) for sending OTEL metrics.

OTEL traces request headers

The headers for OTEL traces requests, formatted as HeaderName:HeaderValue HeaderName:HeaderValue.

OTEL traces URL

The traces' consumer URL (OTEL collector, Elastic EPM etc.).

OTEL traces batch max size

Max amount of traces in one send traces request

OTEL traces batch timeout

Timeout in milliseconds between send traces requests

OTEL traces history size

Traces history size on telemetry $status endpoint

OTEL logs request headers

The headers for OTEL logs requests, formatted as HeaderName:HeaderValue HeaderName:HeaderValue.

OTEL logs URL

The logs' consumer URL (OTEL collector, Elastic EPM etc.).

OTEL logs batch max size

Max amount of logs in one send logs request

OTEL logs batch timeout

Timeout in milliseconds between send logs requests

OTEL logs history size

Logs history size on telemetry $status endpoint