Cassandra connection properties

These properties are configured in the cluster-specific configuration file, cluster_name.conf. Replace cluster_name with the name of your cluster.

[jmx] port

The JMX (Java Management Extensions) port of a cluster. In Cassandra versions 0.8 and higher, the JMX port is 7199.

[jmx] username

The JMX (Java Management Extensions) username, if authentication is enabled.

[jmx] password

The JMX (Java Management Extensions) password, if authentication is enabled.

[jmx] operations_pool_size

The JMX (Java Management Extensions) operations pool size. Default: 4.

[cassandra] seed_hosts

A Cassandra seed node is used to determine the ring topology and obtain gossip information about the nodes in a cluster. This list should be the same comma-delimited list of seed nodes as the one configured for the DataStax Enterprise cluster by the seeds property in the cassandra.yaml configuration file. The default value is localhost.

[cassandra] cql_port

The CQL port configured for a cluster. Default: 9042.

[cassandra] conf_location

The location of the cassandra.yaml configuration file. If install_location is specified, but conf_location is not, then conf_location is assumed to be install_location/conf/cassandra.yaml. If conf_location is specified, it must be the absolute path to the Cassandra configuration file on all nodes. These settings are cluster-wide and require that the specified locations be correct for every node.

[cassandra] install_location

The directory in which Cassandra is installed. If install_location is not specified, OpsCenter looks in the package-specific installation locations. For a tarball installation of DataStax Enterprise, the install_location is dse_install_location/resources/cassandra.

[cassandra] log_location

The directory in which DSE logs reside on a node. The default location is /var/log/cassandra. This value will auto-populate the cassandra_log_location property for each agent.

[cassandra] local_dc_pref

When specified, OpsCenter will prefer using connections to the specified datacenter.

[cassandra] used_hosts_per_remote_dc

If using local_dc_pref, this option specifies how many remote dc connections may be used as a fallback. Default: 1.

[cassandra] connect_timeout

Sets the timeout, in seconds, of a native connection from OpsCenter to Cassandra. The default value is 6.0.

[cassandra] host_read_timeout_ms

The timeout in milliseconds for a host to be considered unresponsive during CQL read operations, such as querying for data. The timeout value should be set higher than the timeout settings used on the Cassandra side (read_request_timeout_in_ms in cassandra.yaml). Default: DataStax Java Driver default value.

[cassandra] bind_interface

The interface for native connections to use.

[cassandra] connection_pool_size

The number of connections to build for the connection pool. The default value is 5.

[cassandra] username

The username used to connect to Cassandra if authentication is enabled.

[cassandra] password

The password used to connect to Cassandra if authentication is enabled.

[cassandra] send_rpc

Specifies whether to send the Cassandra RPC IP to DataStax Agents. The default value is True.

[cassandra] ssl_keystore

The SSL keystore location for OpsCenter to use to connect to Cassandra directly.

[cassandra] ssl_keystore_password

The SSL keystore password for OpsCenter to use to connect to Cassandra directly.

[cassandra] ssl_truststore

The SSL truststore location for OpsCenter to use to connect to Cassandra directly.

[cassandra] ssl_truststore_password

The SSL truststore password for OpsCenter to use to connect to Cassandra directly.

[cassandra] snapshot_threshold

The number of nodes in the cluster before OpsCenter will switch from running a backup immediately upon receiving a request to scheduling the backup to run after the next full minute, plus any time set in snapshot_wait. The default value is 10. If there are less than 10 nodes in the cluster, then OpsCenter will tell all nodes to take a snapshot as soon as it is requested. If there are more than 10 nodes, OpsCenter will tell all nodes to take a snapshot at the current time rounded to the next minute, plus snapshot_wait seconds.

[cassandra] rolling_restart_retry_delay

The number of seconds to wait between retry attempts when connecting to Cassandra after restarting a node. Default: 5.

[cassandra] rolling_restart_retry_attempts

The maximum number of connection retry attempts after restarting a Cassandra node. Default: 25.

[cassandra] rolling_restart_error_threshold

A rolling restart will be cancelled if the number of errors during the restart reaches this number. This helps prevent having too many nodes down in a cluster if something catastrophic happens during a rolling restart. Default: 1.

[cassandra] schema_refresh_interval

The time in milliseconds to wait for schema refreshes after issuing a schema change command. Because this option is intended for use with multiple schema creators that do not apply to opscenterd, the interval should remain at its default of 0.

[cassandra] restart_delay

During a rolling restart, the time in seconds OpsCenter waits after sending the command to stop Cassandra before sending the command to start it again. The default is 30 seconds.

[storage_cassandra] seed_hosts

Configure when using a separate OpsCenter storage cluster. For OpsCenter storage clusters, the agents only communicate with the listed seed hosts, consequently ensuring that a sufficient number of storage cluster nodes are placed in the comma-delimited list and that the list is reviewed as nodes are added and removed from the storage cluster.

[storage_cassandra] cql_port

Configure when using a different cluster for OpsCenter storage. The CQL port configured for your cluster, the default port is 9042.

[storage_cassandra] local_dc_pref

To reliably determine cluster information, OpsCenter can require a minimum of 2 nodes to connect to. If you specified a single value for seed_hosts, OpsCenter selects a second node in the cluster to fulfill this requirement. You can specify local_dc_pref as a datacenter name to constrain OpsCenter to use that datacenter to pick the second node.

[storage_cassandra] used_hosts_per_remote_dc

Configure when using a different cluster for OpsCenter storage. If using local_dc_pref, this option specified how many remote dc connections may be used as a fallback, the default value is 1.

[storage_cassandra] connect_timeout

Configure when using a different cluster for OpsCenter storage. Sets the timeout, in seconds, of a native connection from OpsCenter to Cassandra. The default value is 6.0.

[storage_cassandra] host_read_timeout_ms

The timeout in milliseconds for a host to be considered unresponsive during CQL read operations, such as querying for data. The timeout value should be set higher than the timeout settings used on the Cassandra side (read_request_timeout_in_ms in cassandra.yaml). Default: DataStax Java Driver default value.

[storage_cassandra] bind_interface

Configure when using a different cluster for OpsCenter storage. The interface used for native connections.

[storage_cassandra] connection_pool_size

Configure when using a different cluster for OpsCenter storage. The number of connections to build for the connection pool. The default value is 5.

[storage_cassandra] username

Configure when using a different cluster for OpsCenter storage. The username used to connect to Cassandra if authentication is enabled.

[storage_cassandra] password

Configure when using a different cluster for OpsCenter storage. The password used to connect to Cassandra if authentication is enabled.

[storage_cassandra] send_rpc

Configure when using a different cluster for OpsCenter storage. Specifies whether to send the Cassandra RPC IP to DataStax Agents. The default value is True.

[storage_cassandra] keyspace

The name of the keyspace used for OpsCenter data. The keyspace name must be unique for each managed cluster.

[storage_cassandra] ssl_keystore

The SSL keystore location for OpsCenter to use to connect to Cassandra directly.

[storage_cassandra] ssl_keystore_password

The SSL keystore password for OpsCenter to use to connect to Cassandra directly.

[storage_cassandra] ssl_truststore

The SSL truststore location for OpsCenter to use to connect to Cassandra directly.

[storage_cassandra] ssl_truststore_password

The SSL truststore password for OpsCenter to use to connect to Cassandra directly.

[storage_cassandra] schema_refresh_interval

The time in milliseconds to wait for schema refreshes after issuing a schema change command. Because this option is intended for use with multiple schema creators that do not apply to opscenterd, the interval should remain at its default of 0.

[collection] basic_info_period

The frequency in seconds to check Cassandra for a Cassandra API update. The default value is 3600 (1 hour).

[collection] nodelist_poll_period

The interval in seconds OpsCenter waits to poll the nodes in a cluster. The default value is 30.

[collection] job_poll_period

The frequency in seconds to poll the job tracker. The default value is 5.

[collection] cf_poll_period

The frequency in seconds to check for a schema update. The default value is 60.

[collection] push_throttle_period

The frequency in seconds to push node information to the UI. The default value is 60.

[metric_caching] num_data_points_cached

The number of data points to cache for cluster metrics. The default value is 50.

[metric_caching] num_metrics_cached

The number of metrics to cache for cluster metrics. The default value is 1000.

[agents] api_port

The port used by DataStax Agents for HTTP traffic. The default port is 61621.

[agents] http_timeout

The timeout, in seconds, for an HTTP call to the agent. The default value is 10.

[agents] ssl_keystore

The SSL keystore location for DataStax Agents to use to connect to CQL on the monitored cluster.

[agents] ssl_keystore_password

The SSL keystore password for DataStax Agents to use to connect to CQL on the monitored cluster.

[agents] ssl_truststore

The SSL truststore location for DataStax Agents to use for trusted certs.

[agents] ssl_truststore_password

The SSL truststore password for DataStax Agents to use for trusted certs.

[agents] storage_ssl_keystore

The SSL keystore location for DataStax Agents to use to connect to CQL on the storage cluster.

[agents] storage_ssl_keystore_password

The SSL keystore password for DataStax Agents to use to connect to CQL on the storage cluster.

[agents] storage_ssl_truststore

The SSL truststore location for DataStax Agents to use for trusted certs on the storage cluster.

[agents] storage_ssl_truststore_password

The SSL truststore password for DataStax Agents to use for trusted certs on the storage cluster.

[agents] ec2_metadata_api_host

The IP address to obtain ec2 metadata such as instance id. The default IP address is 169.254.169.254.

[agents] concurrent_agent_requests

The number of concurrent HTTP requests OpsCenter will make to DataStax Agents for most HTTP operations. The default value is 10.

[agents] concurrent_settings_requests

The number of concurrent DataStax Agents OpsCenter will contact upon start-up or when adding a new cluster. The default value is 10.

[agents] concurrent_snapshot_list_requests

The number of concurrent get snapshot info requests. The default value is 1.

[agents] snapshot_wait

See [cassandra] snapshot_threshold

[agents] remote_backup_region

The S3 region region to connect to for remote backup/restore. The default value is us-west-1.

[agents] backup_staging_dir

This path specifies the directory where commit logs archived to by cassandra. From there the commit logs are sent to the configured destinations and the backup_storage_dir.

[agents] backup_storage_dir

This path specifies the directory where commit logs are stored and retained on each node. This property must be set prior to enabling commit log archiving.

[agents] restore_req_update_period

The frequency in seconds that a restore reports progress back to OpsCenter. The default value is automatically calculated based on cluster size. To optimize performance, larger clusters have a longer threshold in which restore progress is sent to the UI. Configure this property accordingly for more or less frequent updates during a restore. Note: Lower numbers might impact performance during a restore.

[agents] diagnostic_tarball_download_timeout

The maximum time in seconds to attempt downloading a diagnostic tarball from an agent. This value might need to be increased on slower machines or for multi-instance clusters. Default value: 120.

[cassandra_metrics] ignored_keyspaces

A list of keyspaces to not collect metrics for, separated by commas. The default value is system, system_traces, system_auth, dse_auth, and OpsCenter.

[cassandra_metrics] ignored_column_families

A list of tables to not collect metrics for, separated by commas. Each entry should be of the form "ks.cf". For example: metrics_ignored_column_families = system.NodeInfo, system.Schema, Keyspace1.Standard1

[cassandra_metrics] ignored_solr_cores

A list of solr cores to not collect metrics for, separated by commas. Each entry should be of the form "ks.cf". For example: metrics_ignored_solr_cores = Keyspace1.Standard1, solr.wiki.

[cassandra_metrics] 1min_ttl

Sets the time in seconds to expire 1 minute data points. The default value is 604800 (7 days).

[cassandra_metrics] 5min_ttl

Sets the time in seconds to expire 5 minute data points. The default value is 2419200 (28 days).

[cassandra_metrics] 2hr_ttl

Sets the time in seconds to expire 2 hour data points. The default value is 31536000 (365 days).

[cassandra_metrics] 24hr_ttl

Sets the time to expire 24 hour data points. The default value is 0, or never.

[cassandra_metrics] metrics_enabled

Specifies whether DataStax Agents should collect Cassandra metrics. The default value is True.

[event_storage] enabled

Specifies whether OpsCenter events should be recorded in the event store. The default value is True.

[spark] master_http_port

Port at which the Spark master UI is exposed. Default: 7080.

[spark] master_proxy_port

Override for the computed Spark proxy port.

[kerberos] default_service

The default Kerberos service name (Example: cassandra).

[kerberos] default_hostname

The default Kerberos hostname.

[kerberos] default_client_principal

The default Kerberos client principal (Example: cassandra@realm).

[kerberos] default_client_user

The default Kerberos client user.

[kerberos] opscenterd_client_principal

The OpsCenter client principal in Kerberos (Example: user@realm).

[kerberos] opscenterd_keytab_location

Full path to the keytab containing keys for opscenterd_client_principal on the OpsCenter machine.

[kerberos] agent_client_principal

The DataStax agent client principal in Kerberos (Example: user@realm).

[kerberos] agent_keytab_location

Full path to the keytab containing keys for agent_client_principal on the DataStax agent machine.

[kerberos] debug

Whether to output debug messages during Kerberos connection attempts from OpsCenter.

[stomp] batch_size

The number of request updates OpsCenter will push out at once. The default value is 100. This is used to avoid overloading the browser.

[stomp] push_interval

How often OpsCenter will push out updates to requests. The default value is 3 seconds. This is used to avoid overloading the browser.

[stomp] alert_push_interval

How often OpsCenter will push out alert updates. The default value is 1 second. This is used to avoid overloading the browser.

[bestpractice] results_ttl

How long in seconds OpsCenter will store the results of Best Practice service runs. The default value is 2,419,200 seconds, or 4 weeks.

[forecasting] range_multiplier

The multiplier for the query range needed to produce forecasts. The default multiplier is 3.

[forecasting] required_data_percentage

Minimum percent of past data required to forecast. The default value is 0.5.

[backups] restore_init_throttle

The number of DataStax Agents on which OpsCenter will concurrently start the restore process. The default value is 20.

[backups] restore_sleep

How long OpsCenter will sleep between batches of starting the restore process, set in restore_init_throttle. The default value is 5 seconds.

[backups] failure_threshold

The percentage of the cluster that can fail to respond before a remote destination restore action fails. Default: 50.

[backups] use_s3_cli

Enable using the AWS CLI instead of the AWS SDK when bulk loading backups to Amazon S3 locations. Default: False.

[labs] graphite_host

Setting graphite_host enables the forwarding of metrics to a graphite server at the given address. Leaving the graphite_host blank disables forwarding metrics to the graphite server.

[labs] graphite_port

Port for graphite's plaintext protocol.

[labs] graphite_prefix

A prefix to insert metrics under.

[labs] bypass_dse_metrics_storage

Enable or disable storing metrics in a monitored or a separate storage DSE cluster. Metrics are stored in a DSE monitored or storage cluster by default. Default: False.

[labs] use_s3_cli

The [labs] use_s3_cli config option has been deprecated because of promotion to production rather than labs status. Please set the use_s3_cli config option in the [backups] section.

[kerberos_hostnames] 192.168.1.101

Per-node specification for the Kerberos hostname of the service (DSE). A list of IP and hostname pairs. For example 192.168.1.101 = cassandra01.example.com.

[kerberos_services] 192.168.1.101

Per-node specification of the Kerberos service name. A list of IP, hostname pairs. For example 192.168.1.101 = cassandra.

[kerberos_client_principals] 192.168.1.102

Per-client specification of the Kerberos principal to use. A list of IP, hostname pairs. For example 192.168.1.102 = opscenter-agent01@EXAMPLE.COM.

[cluster_display_options] display_name

Display name used by OpsCenter to signify this cluster.