Observability

Observability settings

Logs

Logs settings

Disable health logs

Disable /health endpoint requests logging. Default value is false

ID	observability.disable-health-logs
Type	Bool
Default value	false
Environment variable	BOX_OBSERVABILITY_DISABLE_HEALTH_LOGS
Deprecated environment variables	BOX_LOGGING_DISABLE__HEALTH__LOGS
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	true — setting can be changed at runtime

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.

ID	observability.log-file.path
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_LOG_FILE_PATH
Deprecated environment variables	AIDBOX_LOGS
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

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

ID	observability.log-file.max-lines
Type	Int
Default value	10000
Environment variable	BOX_OBSERVABILITY_LOG_FILE_MAX_LINES
Deprecated environment variables	AIDBOX_LOGS_MAX_LINES
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

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.

ID	observability.sql.min-duration
Type	Int
Default value	-1
Environment variable	BOX_OBSERVABILITY_SQL_MIN_DURATION
Deprecated environment variables	BOX_LOGGING_SQL_MIN__DURATION
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

Logging SQL max length

Max length of a query to be logged.

ID	observability.sql.max-length
Type	Int
Default value	500
Environment variable	BOX_OBSERVABILITY_SQL_MAX_LENGTH
Deprecated environment variables	BOX_LOGGING_SQL_MAX__LENGTH
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

Metrics

Metrics settings

Metrics server port

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

ID	observability.metrics.server-port
Type	Int
Default value	(no default)
Environment variable	BOX_METRICS_PORT
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

Enable Postgres metrics

Controls whether to provide metrics related to PostgreSQL

ID	observability.metrics.enable-postgres-metrics
Type	Bool
Default value	true
Environment variable	BOX_OBSERVABILITY_METRICS_ENABLE_POSTGRES_METRICS
Deprecated environment variables	BOX_METRICS_POSTGRES_ON
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

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).

ID	observability.stdout.log-level
Type	Enum
Values	off fatal error warn info debug trace all true
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_STDOUT_LOG_LEVEL
Deprecated environment variables	AIDBOX_STDOUT_JSON
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

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).

ID	observability.stdout.pretty-log-level
Type	Enum
Values	off fatal error warn info debug trace all true
Default value	warn
Environment variable	BOX_OBSERVABILITY_STDOUT_PRETTY_LOG_LEVEL
Deprecated environment variables	AIDBOX_STDOUT_PRETTY
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

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).

ID	observability.stdout.google-log-level
Type	Enum
Values	off fatal error warn info debug trace all true
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_STDOUT_GOOGLE_LOG_LEVEL
Deprecated environment variables	AIDBOX_STDOUT_GOOGLE_JSON
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

Loki

Grafana Loki settings

Loki URL

Loki URL to enable Aidbox logs uploading into Loki

ID	observability.loki-url
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_LOKI_URL
Deprecated environment variables	AIDBOX_LK_URL
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

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.

ID	observability.loki.batch-size
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_LOKI_BATCH_SIZE
Deprecated environment variables	AIDBOX_LK_BATCH_SIZE
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

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.

ID	observability.loki.batch-timeout
Type	Int
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_LOKI_BATCH_TIMEOUT
Deprecated environment variables	AIDBOX_LK_BATCH_TIMEOUT
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

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"}

ID	observability.loki.stream
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_LOKI_STREAM
Deprecated environment variables	AIDBOX_LK_STREAM
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

Datadog

Datadog settings

Datadog API Key

Datadog API Key.

ID	observability.datadog.api-key
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_DATADOG_API_KEY
Deprecated environment variables	BOX_DD_API_KEY
Sensitive	true — value will be masked in Admin UI
Set via	Environment variables
Hot reload	false — setting requires system restart

Datadog regional site

The regional site for a Datadog customer.

ID	observability.datadog.site
Type	Enum
Values	datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ddog-gov.com ap1.datadoghq.com
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_DATADOG_SITE
Deprecated environment variables	BOX_DD_SITE
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

Datadog log tags

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

ID	observability.datadog.tags
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_DATADOG_TAGS
Deprecated environment variables	BOX_DD_TAGS
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

Datadog log file path

Fallback file to write logs in if uploading to Datadog fails

ID	observability.datadog.logs
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_DATADOG_LOGS
Deprecated environment variables	AIDBOX_DD_LOGS
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

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.

ID	observability.datadog.batch-size
Type	Int
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_DATADOG_BATCH_SIZE
Deprecated environment variables	BOX_DD_BATCH_SIZE
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

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.

ID	observability.datadog.batch-timeout
Type	Int
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_DATADOG_BATCH_TIMEOUT
Deprecated environment variables	BOX_DD_BATCH_TIMEOUT
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

Elastic

Elastic settings

Elastic Search auth

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

ID	observability.elastic.search-auth
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_ELASTIC_SEARCH_AUTH
Deprecated environment variables	AIDBOX_ES_AUTH
Sensitive	true — value will be masked in Admin UI
Set via	Environment variables
Hot reload	false — setting requires system restart

Elastic Search URL

If provided, enables mode to push logs to ElasticSearch

ID	observability.elastic.search-url
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_ELASTIC_SEARCH_URL
Deprecated environment variables	AIDBOX_ES_URL
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

Elastic Search batch size

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

ID	observability.elastic.batch-size
Type	Int
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_ELASTIC_BATCH_SIZE
Deprecated environment variables	AIDBOX_ES_BATCH_SIZE
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

Elastic Search batch timeout

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

ID	observability.elastic.batch-timeout
Type	Int
Default value	60000
Environment variable	BOX_OBSERVABILITY_ELASTIC_BATCH_TIMEOUT
Deprecated environment variables	AIDBOX_ES_BATCH_TIMEOUT
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Environment variables
Hot reload	false — setting requires system restart

Elastic Search log format

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

ID	observability.elastic.index-pattern
Type	String
Default value	'aidbox-logs'-yyyy-MM-dd
Environment variable	BOX_OBSERVABILITY_ELASTIC_INDEX_PATTERN
Deprecated environment variables	AIDBOX_ES_INDEX_PAT
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

Grafana

Grafana settings

Grafana URL for metrics dashboards

Grafana URL to update the metrics dashboards.

ID	observability.grafana.url
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_GRAFANA_URL
Deprecated environment variables	BOX_METRICS_GRAFANA_URL
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

Grafana user for metrics dashboards

Grafana user to update the metrics dashboards.

ID	observability.grafana.user
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_GRAFANA_USER
Deprecated environment variables	BOX_METRICS_GRAFANA_USER
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

Grafana password for metrics dashboards

Grafana password to update the metrics dashboards.

ID	observability.grafana.password
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_GRAFANA_PASSWORD
Deprecated environment variables	BOX_METRICS_GRAFANA_PASSWORD
Sensitive	true — value will be masked in Admin UI
Set via	Environment variables
Hot reload	false — setting requires system restart

OTEL

OpenTelemetry settings

OTEL metrics request headers

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

ID	observability.otel.metrics-request-headers
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_OTEL_METRICS_REQUEST_HEADERS
Available from	2503
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

OTEL metrics URL

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

ID	observability.otel.metrics-url
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_OTEL_METRICS_URL
Available from	2503
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

OTEL metrics interval

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

ID	observability.otel.metrics-interval
Type	Int
Default value	5
Environment variable	BOX_OBSERVABILITY_OTEL_METRICS_INTERVAL
Available from	2503
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

OTEL traces request headers

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

ID	observability.otel.traces-request-headers
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_OTEL_TRACES_REQUEST_HEADERS
Available from	2503
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

OTEL traces URL

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

ID	observability.otel.traces-url
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_OTEL_TRACES_URL
Available from	2503
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

OTEL traces batch max size

Max amount of traces in one send traces request

ID	observability.otel.traces-batch-max-size
Type	Int
Default value	100
Environment variable	BOX_OBSERVABILITY_OTEL_TRACES_BATCH_MAX_SIZE
Available from	2503
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

OTEL traces batch timeout

Timeout in milliseconds between send traces requests

ID	observability.otel.traces-batch-timeout
Type	Int
Default value	1000
Environment variable	BOX_OBSERVABILITY_OTEL_TRACES_BATCH_TIMEOUT
Available from	2503
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

OTEL traces history size

Traces history size on telemetry $status endpoint

ID	observability.otel.traces-history-size
Type	Int
Default value	10
Environment variable	BOX_OBSERVABILITY_OTEL_TRACES_HISTORY_SIZE
Available from	2503
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

OTEL logs request headers

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

ID	observability.otel.logs-request-headers
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_OTEL_LOGS_REQUEST_HEADERS
Available from	2503
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

OTEL logs URL

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

ID	observability.otel.logs-url
Type	String
Default value	(no default)
Environment variable	BOX_OBSERVABILITY_OTEL_LOGS_URL
Available from	2503
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

OTEL logs batch max size

Max amount of logs in one send logs request

ID	observability.otel.logs-batch-max-size
Type	Int
Default value	100
Environment variable	BOX_OBSERVABILITY_OTEL_LOGS_BATCH_MAX_SIZE
Available from	2503
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

OTEL logs batch timeout

Timeout in milliseconds between send logs requests

ID	observability.otel.logs-batch-timeout
Type	Int
Default value	1000
Environment variable	BOX_OBSERVABILITY_OTEL_LOGS_BATCH_TIMEOUT
Available from	2503
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart

OTEL logs history size

Logs history size on telemetry $status endpoint

ID	observability.otel.logs-history-size
Type	Int
Default value	10
Environment variable	BOX_OBSERVABILITY_OTEL_LOGS_HISTORY_SIZE
Available from	2503
Sensitive	false — value will be visible in plaintext in Admin UI
Set via	Admin UI → Settings Environment variables
Hot reload	false — setting requires system restart