dse.yaml configuration file

Security and authentication options

Authentication options

authentication_options:
    enabled: false
    default_scheme: kerberos
    other_schemes:
      - internal
    scheme_permissions: true
    allow_digest_with_kerberos: true
    plain_text_without_ssl: warn
    transitional_mode: disabled

authentication_options

Options for the DSE Authenticator to authenticate connections. Authenticators other than DSE Authenticator are not supported.

enabled

Default: false. Enables user authentication. When false, the DSE Authenticator allows all connections.

default_scheme

Sets the first scheme to validate a user against when the driver does not request a specific scheme.

• internal- Plain text authentication using the internal password authentication.
• ldap - Plain text authentication using pass-through LDAP authentication.
• kerberos - GSSAPI authentication using the Kerberos authenticator. Default.

other_schemes

List of schemes that are also checked if validation against the first scheme fails and no scheme was specified by the driver. Same scheme names as default_scheme.

scheme_permissions

Only enable (true) when using multiple schemes for authentication. Prevents unintentional role assignment that might occur if user or group names overlap in the authentication service. When true every role requires permissions to a scheme in order to be assigned, see Binding a role to an authentication scheme.

allow_digest_with_kerberos

Controls whether DIGEST-MD5 authentication is also allowed with Kerberos. The DIGEST-MD5 mechanism is not directly associated with an authentication scheme, but is used by Kerberos to pass credentials between nodes and jobs. In analytics clusters, set to true when using with Spark jobs.

plain_text_without_ssl

Controls how the DseAuthenticator responds to plain text authentication requests over unencrypted client connections. Set to one of the following values:

• block - Block the request with an authentication error.
• warn - Log a warning about the request but allow it to continue. Default.
• allow - Allow the request without any warning.

transitional_mode

For temporary use during authentication setup in an already established environment. Allows access to the database using the anonymous role, which has all permissions except AUTHORIZE.

To enable, use one of the following options:

• permissive - Allow all connections that provide credentials. Maps authenticated superusers to their role AND maps all other users to anonymous.
• normal - Allow all connections that provide credentials. Maps all authenticated users to their role AND maps all other connections to anonymous.
• strict - Allow only authenticated connections that map to a login enabled role OR connections that provide a blank username and password as anonymous.

Important: Credentials are required for all connections after authentication is enabled; use a blank username and password to login with anonymous role in transitional mode.

When set to disabled, all connections must provide valid credentials and map to a login enabled role.

Role management options

role_management_options:
    mode: internal

role_management_options

Options for the DSE Role Manager. To enable role manager, set authorization_options enabled to true and role_manager in cassandra.yaml to com.datastax.bdp.cassandra.auth.DseRoleManager, see Managing roles. When scheme_permissions is enabled, all roles must have permission to execute on the authentication scheme. See Binding a role to an authentication scheme.

mode

Set to one of the following values:

• internal - Scheme that manages roles per individual user in the internal database. Default.
• ldap - Scheme that assigns roles by looking up the user name in LDAP and mapping the group attribute (ldap_options) to an internal role name. To configure an LDAP scheme, complete the steps in Defining an LDAP scheme.

Note: Nested roles are not supported for LDAP.

Authorization options

authorization_options: 
    enabled: false
    transitional_mode: disabled
    allow_row_level_security: false

Kerberos options

kerberos_options:
  keytab: path_to_keytab/dse.keytab
  service_principal: dse_user/_HOST@REALM
  http_principal: HTTP/_HOST@REALM
  qop: auth

kerberos_options

Configure security for a DataStax Enterprise cluster using Kerberos. See Kerberos guidelines.

keytab

The keytab file must contain the credentials for both of the fully resolved principal names, which replace _HOST with the Fully Qualified Domain Name (FQDN) of the host in the service_principal and http_principal settings. The UNIX user running DSE must also have read permissions on the keytab.

service_principal

The service_principal that the DataStax Enterprise process runs under must use the form dse_user/_HOST@REALM.

where dse_user is:

• Package and Installer-Services installations: cassandra
• Package installations: the name of the UNIX user that starts the service

where:

• _HOST is converted to a reverse DNS lookup of the broadcast address.
• REALM is the name of your Kerberos realm. In the Kerberos principal, REALM must be uppercase.

The service_principal must be consistent everywhere: in the dse.yaml file, present in the keytab, and in the cqlshrc file (where service_principal is separated into service/hostname).

http_principal

The http_principal is used by the Tomcat application container to run DSE Search. The Tomcat web server uses GSS-API mechanism (SPNEGO) to negotiate the GSSAPI security mechanism (Kerberos). Set REALM to the name of your Kerberos realm. In the Kerberos principal, REALM must be uppercase.

qop

A comma-delimited list of Quality of Protection (QOP) values that clients and servers can use for each connection. The client can have multiple QOP values, while the server can have only a single QOP value. The valid values are:

• auth - Authentication only. Default.
• auth-int - Authentication plus integrity protection for all transmitted data.
• auth-conf - Authentication plus integrity protection and encryption of all transmitted data.

  Encryption using auth-conf is separate and independent of whether encryption is done using SSL. If both auth-conf and SSL are enabled, the transmitted data is encrypted twice. DataStax recommends choosing only one method and using it for both encryption and authentication.

LDAP options

Define LDAP options to authenticate users against an external LDAP service and/or for Role Management using LDAP group look up. See Enabling DSE Unified Authentication.

ldap_options:
    server_host: localhost ## Appropriate only for development and testing on a single node.
    server_port: 389
    search_dn: uid=Admin
    search_password: secret
    use_ssl: false
    use_tls: false
    truststore_path: path/to/truststore
    truststore_password: passwordToTruststore
    truststore_type: jks
    user_search_base: ou=users,dc=example,dc=com
    user_search_filter: (uid={0})
    user_memberof_attribute: memberof
    group_search_type: directory_search
    group_search_base:
    group_search_filter: (uniquemember={0})
    group_name_attribute: cn
    credentials_validity_in_ms: 0
    search_validity_in_seconds: 0
    connection_pool:
        max_active: 8
        max_idle: 8

ldap_options:
    server_host: win2012ad_server.mycompany.lan
    server_port: 389
    search_dn: cn=lookup_user,cn=users,dc=win2012domain,dc=mycompany,dc=lan
    search_password: lookup_user_password
    use_ssl: false
    use_tls: false
    truststore_path: path/to/truststore
    truststore_password: passwordToTruststore
    truststore_type: jks
    user_search_base: cn=users,dc=win2012domain,dc=mycompany,dc=lan
    user_search_filter: (sAMAccountName={0})
    user_memberof_attribute: memberOf
    group_search_type: directory_search
    group_search_type: memberof_search
    group_search_base:
    group_search_filter: (uniquemember={0})
    group_name_attribute: cn
    credentials_validity_in_ms: 0
    search_validity_in_seconds: 0
    connection_pool:
        max_active: 8
        max_idle: 8

ldap_options

Options to configure LDAP security. See Defining an LDAP scheme.

server_host

The host name of the LDAP server.

Note: Only install LDAP on the same host (localhost) in single node test or development environments.

server_port

The port on which the LDAP server listens. Default: 389

search_dn

Distinguished name (DN) of an account with read access to the user_search_base and group_search_base. Comment out to use an anonymous bind. For example:

• OpenLDAP: uid=lookup,ou=users,dc=springsource,dc=com
• Microsoft Active Directory (AD): cn=lookup, cn=users, dc=springsource, dc=com

Warning: Do not create/use an LDAP account or group called cassandra. The DSE database comes with a default login role cassandra, which has access to all database objects using the consistency level QUOROM.

search_password

The password of the search_dn account.

use_ssl

Set to true to enable SSL connections to the LDAP server. If set to true, change server_port to the SSL port of the LDAP server. Default: false

use_tls

Set to true to enable TLS connections to the LDAP server. If set to true, change the server_port to the TLS port of the LDAP server. Default: false

truststore_path

The path to the truststore for SSL certificates.

truststore_password

The password to access the trust store.

truststore_type

The type of truststore. Default: jks

user_search_base

The search base for your domain, used to look up users. Set the ou and dc elements for your LDAP domain. Typically this is set to ou=users,dc=domain,dc=top_level_domain. For example, ou=users,dc=example,dc=com.

Active Directory uses a different search base, typically CN=search,CN=Users,DC=ActDir_domname,DC=internal. For example, CN=search,CN=Users,DC=example-sales,DC=internal.

user_search_filter

The search filter for looking up user names. Set the LDAP attribute name of the user identifier equal to {0}. For example AD (Microsoft Active Directory), is typically samAccountName={0}. Default: uid={0}

user_memberof_attribute

The attribute on the user entry that contains group membership information. Required when managing roles using group_search_type: memberof_search with LDAP (role_manager.mode:ldap).

group_search_type

Required when managing roles with LDAP (role_manager.mode: ldap). Defines how group membership is looked up for a user. Choose from one of the following values:

• directory_search - Filters the results by doing a subtree search of group_search_base to find groups that contain the user name in the attribute defined in the group_search_filter. (Default)
• memberof_search - Get groups from the user attribute defined in user_memberof_attribute. The directory server must have memberof support, which is a default user attribute in Microsoft Active Directory (AD).

group_search_base

The unique distinguished name (DN) of the group record from which to start the group membership search on.

group_search_filter

Set to any valid LDAP filter.

. Default: (uniquemember={0})

group_name_attribute

The attribute in the group record that contains the LDAP group name. Role names are case sensitive and must match exactly on DSE for assignment. Default: cn

credentials_validity_in_ms

The duration period in milliseconds for the credential cache. Default: 0

search_validity_in_seconds

The duration period in seconds for the search cache. Default: 0

connection_pool

The configuration settings for the connection pool for making LDAP requests.

• max_active - The maximum number of active connections to the LDAP server. Default: 8
• max_idle - The maximum number of idle connections in the pool awaiting requests. Default: 8

Encrypt sensitive system resources

system_info_encryption:
  enabled: false
  cipher_algorithm: AES
  secret_key_strength: 128
  chunk_length_kb: 64
  key_provider: KmipKeyProviderFactory
  kmip_host: kmip_host_name

system_info_encryption

Controls encryption of sensitive system resources using either a local encryption key or remote KMIP key.

enabled

Set to true to enable encryption of system resources that might contain sensitive information, including the system.batchlog and system.paxos tables, hint files, and the database commit log. After enabling system resource encryption in an environment that already has data, encrypt the existing SSTables by running nodetool upgradesstables -a system batchlog paxos

Note: The system_trace keyspace is NOT encrypted by enabling the system_information_encryption section. In environments that also have tracing enabled, manually configure encryption with compression on the system_trace keyspace. See Transparent data encryption.

Default: false.

cipher_algorithm

Default: AES. The name of the JCE cipher algorithm used to encrypt system resources.

Table 1. Supported cipher algorithms names

cipher_algorithm	secret_key_strength
AES	128, 192, or 256
DES	56
DESede	112 or 168
Blowfish	32-448
RC2	40-128

secret_key_strength

Default: 128. Length of key to use for the system resources. See Supported cipher algorithms names.

Note: DSE uses a matching local key or request the key type from the KMIP server. For KMIP, if an existing key does not match the KMIP server automatically generates a new key.

chunk_length_kb

Default: 64. Optional. Size of SSTable chunks when data from the system.batchlog or system.paxos are written to disk.

Note: To encrypt existing data, run nodetool upgradesstables -a system batchlog paxos on all nodes in the cluster.

key_provider

Set to KmipKeyProviderFactory to encrypt sensitive system data with a KMIP key. Comment out this property if using a local encryption key.

Default: none

kmip_host

Set to the kmip_group_name that defines the KMIP host in kmip_hosts section. DSE requests a key from the KMIP host and uses the key generated by the KMIP provider. Default: none

Encrypted configuration properties settings

system_key_directory: /etc/dse/conf
  config_encryption_active: false
  config_encryption_key_name: (key_filename | KMIP_key_URL )

system_key_directory

Path to the directory where local encryption key files are stored, also called system keys. Distribute the system keys to all nodes in the cluster. Ensure that the DSE account is the folder owner and has read/write (600) permissions. Default: /etc/dse/conf

See Setting up local encryption keys.

Note: This directory is not used for KMIP keys.

config_encryption_active

Default: false. Set to true to enable decryption of configuration property values using the specified config_encryption_key_name. When enabled, encrypt values for following properties:

• dse.yaml LDAP values:

  ldap_options.search_password
  ldap_options.truststore_password

  Restriction: Use plain text for the KMIP keystore or truststore passwords.

• cassandra.yaml SSL values:

  server_encryption_options.keystore_password
  server_encryption_options.truststore_password
  client_encryption_options.keystore_password 
  client_encryption_options.truststore_password 

Tip: dsetool encryptconfigvalue returns encrypts values using the config_encryption_key_name key

config_encryption_key_name

Default: system_key. The default name is not configurable.

Set to the local encryption key filename or KMIP key URL to use for configuration file property value decryption.

Note: Use dsetool encryptconfigvalue to generate encrypted values for the configuration file properties.

KMIP encryption options

Options for KMIP encryption keys and communication between the DataStax Enterprise node and the KMIP key server or key servers. Enables DataStax Enterprise encryption features to use encryption keys that stored on a server that is not running DataStax Enterprise.

kmip_hosts:  
  your_kmip_groupname:
    hosts: kmip1.yourdomain.com, kmip2.yourdomain.com 
    keystore_path: pathto/kmip/keystore.jks
    keystore_type: jks
    keystore_password: password
    truststore_path: pathto/kmip/truststore.jks
    truststore_type: jks
    truststore_password: password
    key_cache_millis: 300000
    timeout: 1000

kmip_hosts

Connection settings for key servers that support the KMIP protocol.

kmip_groupname

A user-defined name for a group of options to configure a KMIP server or servers, key settings, and certificates. Configure options for a kmip_groupname section for each KMIP key server or group of KMIP key servers. Using separate key server configuration settings allows use of different key servers to encrypt table data, and eliminates the need to enter key server configuration information in DDL statements and other configurations. Multiple KMIP hosts are supported.

hosts

A comma-separated list of KMIP hosts using the Fully Qualified Domain Name (FQDN). DSE queries the host in the listed order.

For example, if the host list contains kmip1.yourdomain.com, kmip2.yourdomain.com, DSE tries kmip1.yourdomain.com and then kmip2.yourdomain.com.

keystore_path

The path to a Java keystore created from the KMIP agent PEM files. For example: /etc/dse/conf/KMIP_keystore.jks

keystore_type

The type of key store. The default value is jks.

keystore_password

The password to access the key store.

truststore_path

The path to a Java truststore created using the KMIP root certificate. For example: /etc/dse/conf/KMIP_truststore.jks

truststore_type

The type of truststore. The default value is jks.

truststore_password

The password to access the truststore.

key_cache_millis

Milliseconds to locally cache the encryption keys that are read from the KMIP hosts. The longer the encryption keys are cached, the fewer requests are made to the KMIP key server, but the longer it takes for changes, like revocation, to propagate to the DataStax Enterprise node. DataStax Enterprise uses concurrent encryption, so multiple threads fetch the secret key from the KMIP key server at the same time. Default: 300000. DataStax recommends using the default value.

timeout

Socket timeout in milliseconds. Default: 1000.

DSE Search index encryption settings

solr_encryption_options:
    decryption_cache_offheap_allocation: true
    decryption_cache_size_in_mb: 256

solr_encryption_options

Specify settings to tune encryption of search indexes.

decryption_cache_offheap_allocation

Specify whether to allocate shared DSE Search decryption cache off JVM heap. Default: true

decryption_cache_size_in_mb

Sets the maximum size of shared DSE Search decryption cache, in megabytes (MB). Default: 256

DSE Search options

Scheduler settings for DSE Search indexes

ttl_index_rebuild_options:
    fixed_rate_period: 300
    initial_delay: 20
    max_docs_per_batch: 4096
    thread_pool_size: 1

ttl_index_rebuild_options

To ensure that records with TTLs are purged from search indexes when they expire, the search indexes are periodically checked for expired documents. The ttl_index_rebuild_options settings control the schedulers in charge of querying for and removing expired records, and the execution of the checks.

fixed_rate_period

Schedules how often to check for expired data in seconds. Default: 300

initial_delay

Speeds startup time by delaying the first TTL checks in seconds. Default: 20

max_docs_per_batch

Sets the maximum number of documents to check and delete per batch by the TTL rebuild thread. Default: 4096

thread_pool_size

To manage system resource consumption and prevent many search cores from executing simultaneous TTL deletes, defines the maximum number of cores that can execute TTL cleanup concurrently. Default: 1

Reindexing of bootstrapped data

async_bootstrap_reindex: false

async_bootstrap_reindex

For DSE Search, configure whether to asynchronously reindex bootstrapped data. Default: false

• If enabled, the node joins the ring immediately after bootstrap and reindexing occurs asynchronously. Do not wait for post-bootstrap reindexing so that the node is not marked down.
• If disabled, the node joins the ring after reindexing the bootstrapped data.

CQL Solr paging

cql_solr_query_paging: off

cql_solr_query_paging

Options to specify the paging behavior.

• off - Default. Paging is off. Ignore driver paging settings for CQL Solr queries and use normal Solr paging unless:
  • The current workload is an analytics workload, including SearchAnalytics. SearchAnalytics nodes always use driver paging settings.
  • The cqlsh query parameter paging is set to driver.

    Even when cql_solr_query_paging: off, paging is dynamically enabled with the "paging":"driver" parameter in JSON queries.

• driver - Respects driver paging settings. Specifies to use Solr pagination (cursors) only when the driver uses pagination. Enabled automatically for DSE SearchAnalytics workloads.

Solr CQL query options

cql_solr_query_row_timeout: 10000

cql_solr_query_row_timeout

The maximum time in milliseconds to wait for each row to be read from the database during CQL Solr queries. Default: 10000 (10 seconds).

DSE Search resource upload limit

solr_resource_upload_limit_mb: 10

Shard transport options

This shard transport option for inter-node communication between DSE Search nodes controls timeout behavior during distributed queries.

shard_transport_options:
    netty_client_request_timeout: 60000

DSE Search indexing settings

DSE Search implements multi-threaded indexing to improve performance on multi-core machines. All index updates are internally dispatched to a per-core indexing thread pool and executed asynchronously, which allows for greater concurrency and parallelism. However, index requests can return a response before the indexing operation is executed.

max_solr_concurrency_per_core: 2
# enable_back_pressure_adaptive_nrt_commit: true
# back_pressure_threshold_per_core: 2000
# flush_max_time_per_core: 5
# load_max_time_per_core: 5
# enable_index_disk_failure_policy: false
# solr_data_dir: /MyDir
# solr_field_cache_enabled: false

max_solr_concurrency_per_core

Configures the maximum number of concurrent asynchronous indexing threads per DSE Search index. Default: number_of_available_CPU_cores.

If set to 1, DSE Search reverts to using synchronous indexing behavior, where data is synchronously written to the database in a single thread and indexed for DSE Search.

To achieve optimal performance, assign this value to number of available CPU cores divided by the number of search cores. For example, with 16 CPU cores and 4 search cores, the suggested value is 4. Also see Configuring and tuning indexing performance.

To prevent writes from overwhelming reads, reduce this value and adjust parallelDeleteTasks in the search index config.

Note: Dynamic switching to search concurrency level at 1 is disallowed.

enable_back_pressure_adaptive_nrt_commit

Allows back pressure system to adapt max auto soft commit time (defined per search index config) to the actual load. Setting is respected only for NRT (near real time) cores. When DSE search cores have real-time (RT) live indexing, adaptive commits are disabled regardless of this property value. See live indexing with RT.

Default: true

back_pressure_threshold_per_core

The total number of queued asynchronous indexing requests per search core. When this number is exceeded, back pressure prevents excessive resource consumption by throttling new incoming requests. DataStax recommends using a back_pressure_threshold_per_core value of 1000 * max_solr_concurrency_per_core.

Default:  2000

flush_max_time_per_core

The maximum time, in minutes, to wait for the flushing of asynchronous index updates, which occurs at DSE Search commit time or at flush time. Expert level knowledge is required to change this value. Always set the value reasonably high to ensure flushing completes successfully to fully sync DSE Search indexes with the database data. If the configured value is exceeded, index updates are only partially committed, and the commit log is not truncated to ensure data durability.

Note: When a timeout occurs, it usually means this node is being overloaded and cannot flush in a timely manner. Live indexing increases the time to flush asynchronous index updates.

Default: 5

load_max_time_per_core

The maximum time, in minutes, to wait for each DSE Search index to load on startup or create/reload operations, expressed. This advanced option should be changed only if exceptions happen during core loading.

Default: 5 (if not specified)

enable_index_disk_failure_policy

DSE Search activates the configured disk failure policy if IOExceptions occur during index update operations.

Default: false

solr_data_dir

The directory to store index data. By default, each DSE Search index is saved in solrconfig_data_dir/keyspace_name.table_name, or as specified by the dse.solr.data.dir system property. See Managing the location of DSE Search data.

solr_field_cache_enabled

The Apache Lucene® field cache is deprecated. Instead, for fields that are sorted, faceted, or grouped by, set docValues="true" on the field in the schema.xml file. Then reload the core and reindex. The default value is false. To override false, set useFieldCache=true in the request.

Performance Service options

Global Performance Service options

Available options to configure the thread pool that is used by most plug-ins. A dropped task warning is issued when the performance service requests more tasks than performance_max_threads + performance_queue_capacity. When a task is dropped, collected statistics might not be current.

performance_core_threads: 4
performance_max_threads: (cassandra.concurrent_writes)
performance_queue_capacity: 32000

CQL Performance Service options

These settings are used by the Performance Service to configure collection of performance metrics on transactional nodes. Performance metrics are stored in the dse_perf keyspace and can be queried with CQL using any CQL-based utility, such as cqlsh or any application using a CQL driver. To temporarily make changes for diagnostics and testing, use the dsetool perf subcommands.

graph_events:
    ttl_seconds: 600

cql_slow_log_options:
    enabled: true
    threshold: 200.0
    minimum_samples: 100
    ttl_seconds: 259200
    skip_writing_to_db: true
    num_slowest_queries: 5

cql_system_info_options:
    enabled: false
    refresh_rate_ms: 10000

resource_level_latency_tracking_options:
    enabled: false
    refresh_rate_ms: 10000

db_summary_stats_options:
    enabled: false
    refresh_rate_ms: 10000

cluster_summary_stats_options:
    enabled: false
    refresh_rate_ms: 10000

spark_cluster_info_options:
    enabled: false
    refresh_rate_ms: 10000

histogram_data_options:
  enabled: false
  refresh_rate_ms: 10000
  retention_count: 3

user_level_latency_tracking_options:
   enabled: false
   refresh_rate_ms: 10000
   top_stats_limit: 100
   quantiles: false

graph_events

Graph event information.

ttl_seconds

Defines the TTL in milliseconds. Default: 600

cql_slow_log_options

Report distributed sub-queries for search (query executions on individual shards) that take longer than a specified period of time. See Collecting slow queries.

enabled

Enables (true) or disables (false) log entries for slow queries. Default: true

threshold

Defines the threshold (in milliseconds or as a percentile). Default: 200.0

• A value greater than 1 is expressed in time and will log queries that take longer than the specified number of milliseconds.
• A value of 0 to 1 is expressed as a percentile and will log queries that exceed this percentile.

minimum_samples

Defines the initial number of queries before activating the percentile filter. Default: 100

ttl_seconds

Defines the time, in milliseconds, to keep the slow query log entries. Default: 259200

skip_writing_to_db

Keeps (true) slow queries in-memory only and does not write data to database. Default: true

Note: When false, the threshold must be >= 2000 ms to prevent a high load on database.

num_slowest_queries

The number of slow queries to keep in-memory. Default: 5

cql_system_info_options

CQL system information tables settings See Collecting system level diagnostics.

cql_system_info_options:
    enabled: false
    refresh_rate_ms: 10000

enabled

Default: false

refresh_rate_ms

Default: 10000

resource_level_latency_tracking_options

Data resource latency tracking settings. See Collecting system level diagnostics.

resource_level_latency_tracking_options:
    enabled: false
    refresh_rate_ms: 10000

enabled

Default: false

refresh_rate_ms

Default: 10000

db_summary_stats_options

Database summary statistics settings. See Collecting database summary diagnostics.

db_summary_stats_options:
    enabled: false
    refresh_rate_ms: 10000

enabled

Default: false

refresh_rate_ms

Default: 10000

cluster_summary_stats_options

Cluster summary statistics settings. See Collecting cluster summary diagnostics.

cluster_summary_stats_options:
    enabled: false
    refresh_rate_ms: 10000

enabled

Default: false

refresh_rate_ms

Default: 10000

spark_cluster_info_options

See Monitoring Spark with Spark Performance Objects.

spark_cluster_info_options:
    enabled: false
    refresh_rate_ms: 10000

histogram_data_options

Histogram data tables settings. See Collecting histogram diagnostics.

enabled

When true, the dropped mutation metrics are stored in the dropped_messages table in the dse_perf keyspace. Default: false

refresh_rate_ms

Default: 10000

retention_count

Default: 3

user_level_latency_tracking_options

User-resource latency tracking settings. See Collecting user activity diagnostics.

enabled

Default: false

refresh_rate_ms

Default: 10000

top_stats_limit

Default: 100

quantiles

Default: false

DSE Search Performance Service options

These settings are used by the Performance Service. See DSE Performance Service.

solr_indexing_error_log_options:
    enabled: false
    ttl_seconds: 604800
    async_writers: 1

solr_slow_sub_query_log_options:
    enabled: false
    ttl_seconds: 604800
    threshold_ms: 3000
    async_writers: 1

solr_update_handler_metrics_options:
    enabled: false
    ttl_seconds: 604800
    refresh_rate_ms: 60000

solr_request_handler_metrics_options:
    enabled: false
    ttl_seconds: 604800
    refresh_rate_ms: 60000

solr_index_stats_options:
    enabled: false
    ttl_seconds: 604800
    refresh_rate_ms: 60000

solr_cache_stats_options:
    enabled: false
    ttl_seconds: 604800
    refresh_rate_ms: 60000

solr_latency_snapshot_options:
    enabled: false
    ttl_seconds: 604800
    refresh_rate_ms: 60000

solr_indexing_error_log_options

Enable to collect record errors that occur during document indexing.

enabled

Default: false

ttl_seconds

Default: 604800

async_writers

Defines the number of server threads dedicated to writing in the log. More than one server thread might degrade performance. Default: 1

solr_slow_sub_query_log_options

See Collecting slow search queries.

enabled

Default: false

ttl_seconds

Default: 604800

async_writers

Defines the number of server threads dedicated to writing in the log. More than one server thread might degrade performance. Default: 1

threshold_ms

Default: 100

solr_update_handler_metrics_options

See Collecting handler statistics.

enabled

Determines whether the object is enabled at startup.

ttl_seconds

How many seconds a record survives before it is expired from the performance object.

refresh_rate_ms

Period (in milliseconds) between sample recordings for periodically updating statistics like the solr_result_cache_stats.

solr_request_handler_metrics_options

Records core-specific direct and request update handler statistics over time.

enabled

Default: false

ttl_seconds

Default: 604800

refresh_rate_ms

Default: 60000

solr_index_stats_options

See Collecting index statistics.

enabled

Default: false

ttl_seconds

Default: 604800

refresh_rate_ms

Default: 60000

solr_cache_stats_options

See Collecting cache statistics.

enabled

Default: false

ttl_seconds

Default: 604800

refresh_rate_ms

Default: 60000

solr_latency_snapshot_options

See Collecting Apache Solr performance statistics.

enabled

Default: false

ttl_seconds

Default: 604800

refresh_rate_ms

Default: 60000

Spark Performance Service options

spark_application_info_options:
    enabled: false
    refresh_rate_ms: 10000
    driver:
        sink: false
        connectorSource: false
        jvmSource: false
        stateSource: false
    executor:
        sink: false
        connectorSource: false
        jvmSource: false

spark_application_info_options

Statistics options.

enabled

Default: false

refresh_rate_ms

Default: 10000 milliseconds

driver

Enables collection of the metrics by the Spark Driver.

sink

Enables writing of the metrics collected from the Spark Driver. Default: false

connectorSource

Enables writing of the Spark Cassandra Connector metrics at the Spark Driver. Default: false

jvmSource

Enables JVM heap and GC metrics at the Spark Driver. Default: false

stateSource

Enables application state metrics. Default: false

executor

Enables collection of the metrics collected at Spark executors. Default: false

sink

Enables writing of the metrics collected at Spark executors. Default: false

connectorSource

Enables writing of the Spark Cassandra Connector metrics at Spark executors. Default: false

jvmSource

Enables JVM heap and GC metrics at Spark executors. Default: false

DSE Analytics options

• Spark
• Starting Spark drivers and executors
• DSE File System (DSEFS) options
• Spark Performance Service

Spark memory and Spark encryption options

initial_spark_worker_resources: 0.7
spark_shared_secret_bit_length: 256
spark_security_enabled: false
spark_security_encryption_enabled: false

spark_daemon_readiness_assertion_interval: 1000

spark_ui_options:
    encryption: inherit
    encryption_options:
        enabled: false
        keystore: .keystore
        keystore_password: cassandra
        require_client_auth: false
        truststore: .truststore
        truststore_password: cassandra
        # Advanced settings
        # protocol: TLS
        # algorithm: SunX509
        # store_type: JKS
        # cipher_suites: [TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_DHE_RSA_WITH_AES_128_CBC_SHA,TLS_DHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA]

initial_spark_worker_resources

DataStax Enterprise can control the memory and cores offered by particular Spark Workers in semi-automatic fashion. Specify the fraction of system resources that are made available to the Spark Worker.

The available resources are calculated in the following way:

• Spark Worker memory = initial_spark_worker_resources * (total system memory - memory assigned to DataStax Enterprise)
• Spark Worker cores = initial_spark_worker_resources * total system cores

The lowest values that you can assign to Spark Worker memory is 64 MB. The lowest value that you can assign to Spark Worker cores is 1 core. If the results are lower, no exception is thrown and the values are automatically limited. The range of the initial_spark_worker_resources value is 0.01 to 1. If the range is not specified, the default value 0.7 is used.

This mechanism is used by default to set the Spark Worker memory and cores. To override the default, uncomment and edit one or both SPARK_WORKER_MEMORY and SPARK_WORKER_CORES options in the spark-env.sh file.

spark-env.sh

The default location of the spark-env.sh file depends on the type of installation:

Package installations Installer-Services installations	/etc/dse/spark/spark-env.sh
Tarball installations Installer-No Services installations	installation_location/resources/spark/conf/spark-env.sh

spark_shared_secret_bit_length

The length of a shared secret used to authenticate Spark components and encrypt the connections between them. This value is not the strength of the cipher for encrypting connections. Default: 256

spark_security_enabled

Enables Spark security based on shared secret infrastructure. Enables mutual authentication and optional encryption between DSE Spark Master and Workers and of communication channels except the web UI. Default: false

spark_security_encryption_enabled

Enables encryption of Spark connections except the web UI. Uses DIGEST-MD5 SASL-based encryption mechanism. Requires spark_security_enabled: true.

spark_daemon_readiness_assertion_interval

Time interval, in milliseconds, between subsequent retries by the Spark plugin for Spark Master and Worker readiness to start. Default: 1000

spark_ui_options

Specify the source for SSL settings for Spark Master and Spark Worker UIs. The spark_ui_options apply only to Spark daemon UIs, and do not apply to user applications even when the user applications are run in cluster mode.

encryption

• inherit - inherit the SSL settings from the client encryption options. Default.
• custom - use the following encryption_options.

encryption_options

Set encryption options for HTTPS of Spark Master and Worker UI. The spark_encryption_options are not valid for DSE 5.1 and later.

enabled

Enable (true) or disable (false) Spark encryption for Spark client-to-Spark cluster and Spark internode communication. Default: false

keystore

The keystore for Spark encryption keys. The relative file path is the base Spark configuration directory that is defined by the SPARK_CONF_DIR environment variable. The default Spark configuration directory is resources/spark/conf. Default: .keystore

keystore_password

The password to access the key store. Default: cassandra

truststore

The truststore for Spark encryption keys. The relative file path is the base Spark configuration directory that is defined by the SPARK_CONF_DIR environment variable. The default Spark configuration directory is resources/spark/conf.

truststore_password

The password to access the truststore. Default: cassandra

protocol

Defines the encryption protocol. Default: TLS

algorithm

Defines the key manager algorithm. Default: SunX509

store_type

Defines the keystore type. Default: JKS

cipher_suites

Defines the cipher suites for Spark encryption. Default:

• TLS_RSA_WITH_AES_128_CBC_SHA
• TLS_RSA_WITH_AES_256_CBC_SHA
• TLS_DHE_RSA_WITH_AES_128_CBC_SHA
• TLS_DHE_RSA_WITH_AES_256_CBC_SHA
• TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
• TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA

Starting Spark drivers and executors

Options to configure how Spark driver and executor processes are created and managed.

spark_process_runner:
    runner_type: default
    run_as_runner_options: 
        user_slots:
            - slot1
            - slot2

runner_type

• default -
• run_as - Use the run_as_runner_options options. See Running Spark processes as separate users.

run_as_runner_options

Define the slot users for separating Spark processes users from the DSE service user. See Running Spark processes as separate users.

DSE File System (DSEFS) options

dsefs_options:
    enabled: false
    keyspace_name: dsefs
    work_dir: /var/lib/dsefs
    public_port: 5598
    private_port: 5599
    data_directories:
      - dir: /var/lib/dsefs/data
        storage_weight: 1.0
        min_free_space: 5368709120

# Advanced properties for DSEFS
# service_startup_timeout_ms: 30000
# service_close_timeout_ms: 600000
# server_close_timeout_ms: 600000
# compression_frame_max_size: 1048576
# query_cache_size: 2048
# query_cache_expire_after_ms: 2000
# gossip_options:
  #   round_delay_ms: 5000
  #   startup_delay_ms: 5000
  #   shutdown_delay_ms: 30000
# rest_options:
  #   request_timeout_ms: 330000
  #   connection_open_timeout_ms: 55000
  #   client_close_timeout_ms: 60000
  #   server_request_timeout_ms: 300000
  #   idle_connection_timeout_ms: 0
# transaction_options:
  #   transaction_timeout_ms: 3000
  #   conflict_retry_delay_ms: 200
  #   conflict_retry_count: 40
  #   execution_retry_delay_ms: 1000
  #   execution_retry_count: 3

dsefs_options

DSE File System (DSEFS) options determine whether DSEFS should be enabled on this node.

enabled

Enable or disable DSEFS. This parameter takes one of the following values:

• true - enables DSEFS on this node, regardless of the workload.
• false - disables DSEFS on this node, regardless of the workload. Default.
• blank or commented out (#) - DSEFS will start only if the node is configured to run analytics workloads.

keyspace_name

The keyspace where the DSEFS metadata is stored. You can optionally configure multiple DSEFS file systems within a single datacenter by specifying different keyspace names for each cluster. Default: dsefs

work_dir

The local directory for storing the local node metadata, including the node identifier. The volume of data stored in this directory is nominal and does not require configuration for throughput, latency, or capacity. This directory must not be shared by DSEFS nodes.

public_port

The public port on which DSEFS listens for clients. DataStax recommends that all nodes in the cluster have the same value. Firewalls must open this port to trusted clients. The service on this port is bound to the RPC address. Default: 5598

private_port

The private port for DSEFS inter-node communication. Do not open this port to firewalls; this private port must be not visible from outside of the cluster. Default: 5599

data_directories

One or more data locations where the DSEFS data is stored.

- dir

Mandatory attribute to identify the set of directories. DataStax recommends segregating these data directories on physical devices different than the devices that are used for DataStax Enterprise. Using multiple directories on JBOD improves performance and capacity. Default: /var/lib/dsefs/data

storage_weight

The weighting factor for this location specifies how much data to place in this directory, relative to other directories in the cluster. This soft constraint determines how DSEFS distributes the data. For example, a directory with a value of 3.0 receives about three times more data than a directory with a value of 1.0. Default: 1.0

min_free_space

The reserved space, in bytes, to not use for storing file data blocks. You can use a unit of measure suffix to specify other size units. For example: terabyte (1 TB), gigabyte (10 GB), and megabyte (5000 MB). Default: 5368709120

service_startup_timeout_ms

Wait time, in milliseconds, before the DSEFS server times out while waiting for services to bootstrap. Default: 30000

service_close_timeout_ms

Wait time, in milliseconds, before the DSEFS server times out while waiting for services to close. Default: 600000

server_close_timeout_ms

Wait time, in milliseconds, that the DSEFS server waits during shutdown before closing all pending connections.

compression_frame_max_size

The maximum accepted size of a compression frame defined during file upload. Default: 1048576

query_cache_size

Maximum number of elements in a single DSEFS Server query cache. Default: 2048

query_cache_expire_after_ms

The time to retain the DSEFS Server query cache element in cache. The cache element expires when this time is exceeded. Default: 2000

gossip options

Options to configure DSEFS gossip rounds.

round_delay_ms

The delay, in milliseconds, between gossip rounds. Default: 5000

startup_delay_ms

The delay time, in milliseconds, between registering the location and reading back all other locations from the database. Default: 5000

shutdown_delay_ms

The delay time, in milliseconds, between announcing shutdown and shutting down the node. Default: 30000

rest_options

Options to configure DSEFS rest times.

request_timeout_ms

The time, in milliseconds, that the client waits for a response that corresponds to a given request. Default: 330000

connection_open_timeout_ms

The time, in milliseconds, that the client waits to establish a new connection. Default: 55000

client_close_timeout_ms

The time, in milliseconds, that the client waits for pending transfer to complete before closing a connection. Default: 60000

server_request_timeout_ms

The time, in milliseconds, to wait for the server rest call to complete. Default: 300000

idle_connection_timeout_ms

The time, in milliseconds, to wait before closing an idle connection. Default: 0 (disabled)

transaction_options

Options to configure DSEFS transaction times.

transaction_timeout_ms

Transaction run time, in milliseconds, before the transaction is considered for timeout and rollback. Default: 3000

conflict_retry_delay_ms

Wait time, in milliseconds, before retrying a transaction that was ended due to a conflict. Default: 200

conflict_retry_count

The number of times to retry a transaction before giving up. Default: 40

execution_retry_delay_ms

Wait time, in milliseconds, before retrying a failed transaction payload execution. Default: 1000

execution_retry_count

The number of payload execution retries before signaling the error to the application. Default: 3

DSE Graph options

DSE Graph system-level options

These graph options are system-level configuration options and options that are shared between graph instances. Add an option if it is not present in the provided dse.yaml file.

graph:
  adjacency_cache_clean_rate: 1024
  adjacency_cache_max_entry_size_in_mb: 0
  adjacency_cache_size_in_mb: 128
  analytic_evaluation_timeout_in_minutes: 10080
  gremlin_server_enabled: true
  index_cache_clean_rate: 1024
  index_cache_max_entry_size_in_mb: 0
  index_cache_size_in_mb: 128
  max_query_queue: 10000
  #max_query_threads:
  realtime_evaluation_timeout_in_seconds: 30
  schema_agreement_timeout_in_ms: 10000
  schema_mode: Production
  system_evaluation_timeout_in_seconds: 180
  window_size: 100000
  max_query_params: 256

graph

These graph options are system-level configuration options and options that are shared between graph instances.

adjacency_cache_clean_rate

The number of stale rows per second to clean from each graph's adjacency cache. Default: 1024.

adjacency_cache_max_entry_size_in_mb

The maximum entry size in each graph's adjacency cache. When set to zero, the default is calculated based on the cache size and the number of CPUs. Entries that exceed this size are quietly dropped by the cache without producing an explicit error or log message. Default: 0.

adjacency_cache_size_in_mb

The amount of RAM to allocate to each graph's adjacency (edge and property) cache. Default: 128.

analytic_evaluation_timeout_in_minutes

Maximum time to wait for an analytic (Spark) traversal to evaluate. Default: 10080 (7 days).

Option names and values expressed in ISO 8601 format used in earlier DSE 5.0 releases are still valid. The ISO 8601 format is deprecated.

gremlin_server_enabled

Enables or disables Gremlin Server. Default: true.

index_cache_clean_rate

The number of stale entries per second to clean from the adjacency cache. Default: 1024.

index_cache_max_entry_size_in_mb

The maximum entry size in the index adjacency cache. When set to zero, the default is based on the cache size and the number of CPUs. Value: integer. + # default is calculated based on the cache size and the number of CPUs. Entries that exceed this size are quietly dropped by the cache without producing an explicit error or log message. Default: 0.

index_cache_size_in_mb

The amount of ram to allocate to the index cache. Default: 128.

max_query_queue

The maximum number of CQL queries that can be queued as a result of Gremlin requests. Incoming queries are rejected if the queue size exceeds this setting. Default: 10000.

max_query_threads

The maximum number of threads to use for queries to the database. When this option is not set, the default is:

• If gremlinPool is present and nonzero:

  10 * the gremlinPool setting

• If gremlinPool is not present in this file or set to zero:

  The number of available CPU cores

See gremlinPool.

realtime_evaluation_timeout_in_seconds

Maximum time to wait for a real-time traversal to evaluate. Default: 30 seconds.

Option names and values expressed in ISO 8601 format used in earlier DSE 5.0 releases are still valid. The ISO 8601 format is deprecated.

schema_agreement_timeout_in_ms

Maximum time to wait for cassandra to agree on schema versions before timing out. Default: 10000

Option names and values expressed in ISO 8601 format used in earlier DSE 5.0 releases are still valid. The ISO 8601 format is deprecated.

schema_mode

Controls the way that the schemas are handled. Valid values:

• Production = Schema must be created before data insertion. Schema cannot be changed after data is inserted. Full graph scans are disallowed unless the option graph.allow_scan is changed to TRUE.
• Development = No schema is required to write data to a graph. Schema can be changed after data is inserted. Full graph scans are allowed unless the option graph.allow_scan is changed to FALSE.

system_evaluation_timeout_in_seconds

Maximum time to wait for a system-based request to execute. Default: 180 (3 minutes).

Option names and values expressed in ISO 8601 format used in earlier DSE 5.0 releases are still valid. The ISO 8601 format is deprecated.

window_size

The number of samples to keep when aggregating log events. Only a small subset of graph's log events use this system. Modifying this setting is rarely necessary or helpful. Default: 100000.

max_query_params

The maximum number of parameters that can be passed on a graph query request for TinkerPop drivers and drivers using Cassandra native protocol. Passing very large numbers of parameters on requests is an anti-pattern, because the script evaluation time increases proportionally. DataStax recommends reducing the number of parameters to speed up script compilation times. Before you increase this value, consider alternate methods for parameterizing scripts, like passing a single map. If the graph query request requires many arguments, pass a list. Default: 256

DSE Graph id assignment and partitioning strategy options

ids:
    block_renew: 0.8
    community_reuse: 28
    consistency_mode: GLOBAL
    # datacenter_id: integer unique per DC when consistency_mode: DC_LOCAL
    id_hash_modulus: 20
    member_block_size: 512

ids

DSE Graph configuration options for standard vertex ID assignment and partitioning strategies.

block_renew

The graph standard vertex ID allocator operates on blocks of contiguous IDs. Each block is allocated using a database lightweight transaction that requires coordination latency. To hide the cost of allocating a standard ID block, the allocator begins asynchronously buffering a replacement block whenever a current block is nearly empty. This block_renew parameter defines "nearly empty" as a floating point number between 0 and 1. The value is how much of a standard ID block can be used before graph starts asynchronously allocating its replacement. This setting has no effect on custom IDs. Value must be between 0 and 1. Default: 0.8.

community_reuse

For graphs using standard vertex IDs, if a transaction creates multiple vertices, the allocator attempts to assign vertex IDs that colocate vertices on the same database replicas. If an especially large vertex cohort is created, the allocator chunks the vertex creation and assigns a random target location to avoid load hotspotting. This setting controls the vertex chunk size and has no effect on custom IDs. Default: 28.

consistency_mode

Must be set to DC_LOCAL or GLOBAL.

• DC_LOCAL - The node uses LOCAL_QUORUM when allocating an ID for a graph vertex. The datacenter_id option must be correctly configured on every node in the cluster.
• GLOBAL - (Default) The node uses QUORUM when allocating an ID for a graph vertex. The datacenter_id option is ignored.

This option must have the same value on every node in the cluster. Its value can only be changed when the entire cluster is stopped. This setting has no effect on custom IDs.

datacenter_id

Applies only when consistency_mode is DC_LOCAL. Set to an arbitrary value between 1 and 127, inclusive. This setting has no effect on custom IDs.

Warning: Each datacenter in the cluster must have a unique datacenter_id. Violating this constraint will corrupt the graph database without warning.

This setting has no effect on custom IDs. Default: no explicit default value.

id_hash_modulus

An integer between 1 and 2^24 (both inclusive) that affects maximum ID capacity and the maximum storage space used by ID allocations. Lower values reduce the storage space consumed and the lightweight transaction overhead imposed at startup. Lower values also reduce the total number of IDs that can be allocated over the life of a graph, because this parameter is proportional to the allocatable ID space. However, the proportion coefficient is Long.MAX_VALUE (2^63-1), so ID headroom should be sufficient, practically speaking, even if this is set to 1. This setting has no effect on custom IDs. Default: 20.

member_block_size

The graph standard vertex ID allocator claims uniformly-sized blocks of contiguous IDs using lightweight transactions on the database. This setting controls the size of each block. This setting has no effect on custom IDs. Default: 512.

DSE Graph listener options

listener:
    listener_name: string   
        black_types:  # This list is empty by default   
        interval_in_seconds: 3600
        type: slf4j
        white_types:  # This list is empty by default

listener

Options that contain all registered state listeners identified by their name.

listener_name

Replace listener_name with a string that identifies the listener. The string must begin with a lower case letter and can be composed of lowercase letters, numbers, and underscores.

black_types

The names of state types that are ignored. All state types but those given are listened to. Default: (empty).

interval_in_seconds

The interval in which the state values are logged. Default: 3600

Option names and values expressed in ISO 8601 format used in earlier DSE 5.0 releases are still valid. The ISO 8601 format is deprecated.

type

The type of the state listener. Must be one of the following values: slf4j. Default: slf4j.

white_types

The names of state types that should be listened. Only those state types are listened to and all others ignored. Default: (empty).

DSE Graph messaging options

msg:
    graph_msg_timeout_in_ms: 5000

msg

Options to configure DSE Graph internal query and lightweight messaging system.

graph_msg_timeout_in_ms

Graph messages must be acknowledged within this interval, or else the message is assumed dropped/failed. Graph retries the message or fails the responsible request if the retry limit is exceeded. Default: 5000

Option names and values expressed in ISO 8601 format used in earlier DSE 5.0 releases are still valid. The ISO 8601 format is deprecated.

DSE Graph event observers options

observer:
    observer_name: string
        black_types:  # This list is empty by default  
        observed_graphs:  # This list is empty by default
        slow_threshold_in_ms: 300000
        type: slf4j
        white_types:  # This list is empty by default

observer

Options to configure all registered event observers identified by their name.

observer_name

Replace observer_name with a string that identifies the event observers. This string is the names of event types that are ignored. All event types but those given are observed. The string must begin with a lower case letter and can be composed of lowercase letters, numbers, and underscores. Value: YAML-formatted list of strings.

black_types

The names of event types that are ignored. All event types but those given are observed. Value: YAML-formatted list of strings. Default: (empty).

observed_graphs

The names of the graphs for which events are observed. Value: YAML-formatted list of strings. Default: (empty).

slow_tx_graphs

The names of the graphs for which slow transactions are monitored. Default: (empty).

slow_threshold_in_ms

Threshold at which slow queries get reported. Default: 300000

Option names and values expressed in ISO 8601 format used in earlier DSE 5.0 releases are still valid. The ISO 8601 format is deprecated.

type

The type of the event observer. Must be one of the following values: slf4j, slow_request. Default: slf4j.

white_types

The names of event types that should be observed. Only those event types are observed and all others ignored. Value: YAML-formatted list of strings. Default: (empty).

DSE Graph shared data options

shared_data:
    refresh_interval_in_ms: 60000

shared_data

Options for shared data in DSE Graph.

refresh_interval_in_ms

The interval between refreshes in which the graph schema is reread from the database tables. Note that schema is also immediately updated when schema changes occur, so this parameter is a fail safe to poll for schema changes periodically. Default: 60000

Option names and values expressed in ISO 8601 format used in earlier DSE 5.0 releases are still valid. The ISO 8601 format is deprecated.

DSE Graph Gremlin Server options

The Gremlin Server is configured using Apache TinkerPop specifications.

gremlin_server:
    # port: 8182
    # threadPoolWorker: 2
    # gremlinPool: 0
#        scriptEngines:
#            gremlin-groovy:
#                config:
#                   sandbox_enabled: false
#                   sandbox_rules:
#                        whitelist_packages:
#                            - package.name
#                        whitelist_types:
#                            - fully.qualified.type.name
#                        whitelist_supers:
#                            - fully.qualified.class.name
#                        blacklist_packages:
#                            - package.name
#                        blacklist_supers:
#                            - fully.qualified.class.name