The address.yaml configuration file
The address.yaml file contains configuration options for the DataStax Agent.
Note: As of version 5.1 of OpsCenter, the hosts option in address.yaml now determines which nodes the agent connects to. For further information on configuration changes and migration paths, see the Upgrade Guide.
(Required) Reachable IP address of the opscenterd machine. The connection is made on stomp_port.
The stomp_port used by opscenterd. Default: 61620.
Whether to use SSL communication between the agent and opscenterd. Affects both the STOMP connection and agent HTTP server. Corresponds to [agents] use_ssl in opscenterd.conf. Setting this option to 1 turns on SSL connections. Default: 0.
The IP used to identify the node in opscenterd. If broadcast_address is set in cassandra.yaml, this should be the same as that; otherwise, it is typically the same as listen_address in cassandra.yaml. A good check is to confirm that this address is the same as the address that nodetool ring outputs. If not set, the agent attempts to determine the proper IP address via JMX.
The IP that the agent HTTP server listens on. In a multiple region deployment, this is typically a private IP. Default: Matches rpc_interface from cassandra.yaml.
The IP that the central OpsCenter process uses to connect to the DataStax agent. Default: Matches agent_rpc_interface.
The port used for the agent's HTTP endpoint. Default: 61621.
The DataStax Enterprise node or nodes responsible for storing OpsCenter data. By default, this will be the local node, but may be configured to store data on a separate cluster. The hosts option accepts an array of strings specifying the IP addresses of the node or nodes. For example, ["220.127.116.11"] or ["18.104.22.168", "22.214.171.124"].
Port used to connect to the local cassandra node. The native transport port.
The username used to connect to cassandra when authentication is enabled.
The password used to connect to cassandra when authentication is enabled.
Host used to connect to local JMX server. Default: 127.0.0.1.
Port used to connect to local JMX server. Default: 7199.
The username used to connect to the local JMX server if JMX authentication is enabled on the node.
The password used to connect to the local JMX server if JMX authentication is enabled on the node.
The agent attempts to auto-detect the location of the cassandra.yaml file via JMX, but if it cannot, this option must be set to the full path of cassandra.yaml. By default /etc/cassandra/cassandra.yaml on Installer-Services or package installations or /path/to/install/conf/cassandra.yaml on Installer-No Services or tarball installations.
The base directory where DataStax Enterprise or Cassandra is installed. When not set, the agent attempts to auto-detect the location but cannot do so in all cases.
The location of the Cassandra system.log file. This option is only used for the diagnostics tarball, and should only be set if system.log is in a non-standard location.
The length of time in seconds between attempts to collect metrics. Default: 60.
The length of time in seconds to wait between attempts to poll the disk for usage. Default: 60.
The size of the thread pool used for long-running JMX connections. Default: 5.
The size of the JMX connection pool used for JMX operations. Default: 4.
The number of retries to attempt while establishing the cassandra host id. Default: 30.
The size of the thread pool used to obtain node details. Default: 3.
The length of time in seconds between polling attempts to capture rapidly changing real-time information. Default: 5.
The length of time in seconds between polling attempts to capture information that changes frequently (e.g., OS load, data size, running tasks). Default: 10.
The length of time in seconds between polling attempts to capture information that changes infrequently. Default: 300.
The EC2 metadata api host used to determine information about the node if it is on EC2. Default: 169.254.169.254.
Whether to collect and store metrics for the local node. Setting this option to 0 turns off metrics collection. Default: 1.
The size of the thread pool used for collecting metrics over JMX. Default: 4.
A comma-separated list of keyspaces ignored by metrics collection. Example: "ks1, ks2, ks3".
A comma-separated list of tables (formerly referred to as column families) ignored by metrics collection. Example: "ks1.cf1, ks1.cf2, ks2.cf1".
A comma-separated list of solr cores ignored by metrics collection. Example: "ks1.cf1, ks1.cf2, ks2.cf1".
The maximum number of queued cassandra operations. If your cluster experiences bursty cassandra stress, increasing this queue size might help. Default: 5000.
The pool size to use for async operations to cassandra. Default when using local storage: 2. Default when using remote storage: 4.
The maximum number of repairs that might be pending. Exceeding this number blocks new repairs. Default: 5.
The SSL keystore location for agents to use to connect to CQL.
The SSL truststore password for agents to use to connect to CQL.
The Kerberos service name to use when using Kerberos authentication within DSE.
The keyspace that the agent uses to store data.
Sets whether the DataStax Agent runs using sudo. Setting this option to false means the agent does not use sudo, and the agent user does not run using elevated privileges. Setting this option to true means the agent runs with elevated privileges using sudo.
The frequency in seconds with which status updates are sent to opscenterd during Restore operations in the Backup Service. Default: 60.
The directory used for staging commitlogs to be backed up.
The location of the Backup Service staging directory for backups. The default location is /var/lib/datastax-agent/tmp.
The number of attempts to make when file download fails during a restore. Default: 3.
The timeout in milliseconds for the connection used to push backups to remote destinations. Default: 1000.
The delay in milliseconds between remote backup retries. Default: 5000.
Initial delay in milliseconds to wait before checking if a file was successfully uploaded during a backup operation. This configuration option works in conjunction with the remote_verify_max option to distinguish between broken versus tardy backups when cleaning up SSTables. The remote_verify_initial_delay value doubles each time a file transfer validation failure occurs until the value exceeds the remote_verify_max value. Default: 1000 (1 second).
The maximum time period in milliseconds to wait after a file upload has completed but is still unreadable from the remote destination. When this delay is exceeded, the file transfer is considered failed. This configuration option works in conjunction with the remote_verify_initial_delay option to distinguish between broken versus tardy backups when cleaning up SSTables. Default: 30000 (30 seconds).
When set to true, a failed file transfer from the remote destination does not halt the restore process. A future restore attempt uses any successfully transferred files. Default: false.
The maximum number of files that can be queued for an upload to a remote destination. Increasing this number consumes more memory. Default: 10000.
The AWS region to use for remote backup transfers. Default: us-west-1.
The maximum number of attempts to upload a file or create a remote destination. Default: 30.
The time in milliseconds to wait between issuing a query to trace and fetching trace events in the Performance Service Slow Query panel. Default: 300.
When stream throttling is configured in Backup Service transfers to or from a remote destination, this setting acts as a cap on how long to sleep when throttling. The cap prevents prematurely closing connections due to inactivity. Default: 25 (seconds).
Delay in seconds used to verify that the Backup Service transfer should stop. Default: 0.005.
A very large number used for bytes per second if no throttle is selected. Default: 10000000000.
How far into the past in milliseconds to look for slow queries. Default: 3600000 (1,000 hours).
Time in seconds between slow query refreshes. Default: 5.
The limit to how many slow queries are fetched. Default: 2000.
A list of keyspaces to ignore in the slow query log of the Performance Service. Default: ["OpsCenter" "dse_perf"].
Specifies whether opscenter should attempt to decrypt sensitive config values. Default: False.
Filename to use for the encryption key. If a custom name is not specified, opsc_system_key is used by default.
Path where the encryption key should be located. If unspecified, the directory of address.yaml is used by default.
Maximum delay in ms for an agent to attempt reconnecting to Cassandra. The default is 15000 ms (15 s).