Atlas Agent Configuration

agent

agent attributes

Name	Required	Value
cloud_url	false	string
token	false	string

agent blocks

agent.log

agent.log attributes

Name	Required	Value
format	false	enum (TEXT, JSON)
level	false	enum (DEBUG, INFO, WARN, ERROR)

instance

instance attributes

Name and description	Required	Value
driver	true	enum (azuresql, clickhouse, databricks, docker, docker+clickhouse, docker+maria, docker+mariadb, docker+mysql, docker+oracle, docker+postgres, docker+spanner, docker+sqlserver, libsql, libsql+file, libsql+ws, libsql+wss, maria, maria+unix, mariadb, mariadb+unix, mssql, mysql, mysql+unix, oracle, postgres, postgresql, redshift, redshift+http, resource+dev, resource+docker, snowflake, spanner, sqlite, sqlite3, sqlserver, aurora-mysql, aurora-postgresql)
name Human friendly name for the instance.	false	string
slug Unique identifier for the instance.	false	string

instance blocks

instance.connection

instance.connection attributes

Name	Required	Value
database	false	string
host	true	string
port	false	int
query	false	map
user	true	string

instance.connection blocks

instance.connection.auth

instance.connection.auth blocks

instance.connection.auth.aws_iam

instance.connection.auth.aws_iam attributes

Name	Required	Value
assume_role	false	string
endpoint	true	string
region	true	string

instance.connection.auth.env_var

instance.connection.auth.env_var constraints

Constraint	Value
Required	false
Require Name (e.g., instance.connection.auth.env_var "name" )	true

instance.connection.auth constraints

Constraint	Value
Required	true
Require Name	false
Mutually exclusive sets	[env_var, aws_iam]
One of required sets	[env_var, aws_iam]

instance.connection constraints

Constraint	Value
Required	true
Require Name	false

instance.default_monitor

A default_monitor block configures the default monitoring settings for all databases and schemas in the instance. Individual monitor blocks can be used to override these settings for specific databases or schemas.

instance.default_monitor attributes

Name and description	Required	Value
database	false	string
exclude	false	List of strings
exclude_databases List of databases to exclude from monitoring, e.g. 'rdsadmin' for RDS instances.	false	List of strings
include	false	List of strings
schemas	false	List of strings
snapshot_interval The interval at which snapshots are taken, e.g. 1h, 1d, etc.Minimum allowed value is 1m (1 minute).	false	string

instance.default_monitor blocks

instance.default_monitor.statistics

instance.default_monitor.statistics attributes

Name	Required	Value
enabled	true	bool

instance.default_monitor constraints

Constraint	Value
Required	false
Require Name (e.g., instance.default_monitor "name" )	true

instance.monitor

instance.monitor attributes

Name	Required	Value
database	false	string
exclude	false	List of strings
include	false	List of strings
schemas	false	List of strings
snapshot_interval	false	string

instance.monitor blocks

instance.monitor.statistics

instance.monitor.statistics attributes

Name	Required	Value
enabled	true	bool

instance.monitor constraints

Constraint	Value
Required	false
Require Name (e.g., instance.monitor "name" )	true

instance constraints

Constraint	Value
Required	false
Require Name	false
Repeatable	true
One of required sets	[monitor, default_monitor]