DataStax OpsCenter Documentation

Advanced configuration

Using the OpsCenter console is the most convenient way to configure basic OpsCenter settings. To configure advanced capabilities, you modify configuration files.

The main configuration files for OpsCenter are:

  • opscenterd.conf - Configures the properties for the OpsCenter daemon.
  • <cluster_specific>.conf - Configures properties for each cluster monitored by OpsCenter. This file is created when you add a cluster to the Opscenter.

OpsCenter configuration properties

The location of the opscenterd.conf file depends on the type of installation:

  • Packaged installations: /etc/opscenter/opscenterd.conf
  • Binary tarball installations (Linux and Mac OSX): <install_location>/conf/opscenterd.conf
  • Windows installations: Program Files (x86)\DataStax Community\opscenter\conf\opscenterd.conf

Note

After changing properties in this file, restart OpsCenter for the changes to take effect.

You configure the following properties in opscenterd.conf:

[agents] ssh_port

The Secure Shell (SSH) port that listens for agent-OpsCenter communications. Add an [agents] section, if one doesn't already exist, to the opscenterd.conf. In this section, add the ssh_port option and a value for the port number:

[agents]
ssh_port = 2222

[webserver] port

  • The HTTP port used for client connections to the OpsCenter web server. Default is 8888.

  • Optional HTTPS support.

    To enable HTTPS, remove the comment markers (#) in front of properties prefixed with ssl in the opscenterd.conf file, as described in Configuring HTTPS.

[webserver] interface

The interface that the web server uses to listen for client connections. The interface must be an externally accessible IP address or host name.

[logging] level

The logging level for OpsCenter. Available levels are (from most to least verbose): TRACE, DEBUG, INFO, WARN, or ERROR. The OpsCenter log file is located in /var/log/opscenter/opscenterd.log.

[stat_reporter] interval

Reporting to DataStax Support. By default, OpsCenter periodically sends usage metrics about the cluster to DataStax Support. To disable the phone-home functionality, add the following lines to your opscenterd.conf file:

[stat_reporter]
  interval = 0

Additional configuration metric collection properties are available in Metrics Collection Properties.

[authentication] passwd_file

Full path to the file for configuring password authentication for OpsCenter. If this file does not exist, OpsCenter does not verify passwords. To enable password authentication, use the set_passwd.py utility to create users and set their password and role. OpsCenter currently has two available roles: admin or user.

Cluster configuration properties

You set OpsCenter configuration properties in the <cluster_specific.conf> file. The location of this file depends on the type of installation:

  • Package installations: /etc/opscenter/clusters/<cluster_specific>.conf
  • Binary tarball installations (Linux and Mac OSX): <install_location>/conf/clusters/<cluster_specific>.conf
  • Windows installations: Program Files (x86)\DataStax Community\opscenter\conf\clusters\<cluster_specific>.conf

Note

After changing properties in this file, restart OpsCenter for the changes to take effect.

Cassandra connection properties

The following properties inform OpsCenter about the Real-time (Cassandra), Analytics (Hadoop), and Search (Solr) nodes that it is monitoring:

[jmx] port

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

[cassandra] seed_hosts

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

[cassandra] api_port

The Thrift remote procedure call port configured for your cluster. Same as the rpc_port property in the cassandra.yaml configuration file. Default is 9160.

Metrics Collection Properties

The following properties are used to limit the keyspaces and column families for which you collect metrics.

[cassandra_metrics] ignored_keyspaces

A comma-delimited list of Cassandra keyspaces for which you do not want to collect performance metrics. By default, the system and OpsCenter keyspaces are excluded.

[cassandra_metrics] ignored_column_families

A comma-delimited list of Cassandra column families for which you do not want to collect performance metrics. Entries should be in the form of keyspace_name.*columnfamily_name*.

Performance Data Expiration Properties

These properties set the expiration time for data stored in the OpsCenter keyspace. Each time period for rolling up data points into summary views has a separate expiration threshold, or time-to-live (ttl) value expressed in seconds. By default, shorter time periods have lower values that result in more efficient expiration and compaction of the relatively larger volumes of data.

Uncomment these properties to change the default expiration periods for performance data. Properties and default values are:

1min_ttl = 604800

One-minute rollups expire after after one week, or 604800 seconds.

5min_ttl = 2419200

Five-minute rollups expire after four weeks, or 2419200 seconds.

2hr_ttl = 31536000

Two-hour rollups expire after one year, or 31536000 seconds.