Administrating MarkLogic Server

Group Name

The name of the group.

Cache Sizing

The cache sizing method. When the method is automatic, the cache size and cache partitions are computed automatically and the manual cache configuration settings are ignored. When the method is enode, the cache size and cache partitions are also computed automatically but they are tuned for better memory utilization of an Evaluation Node. The manual cache configuration settings are ignored when the method is enode. When the method is dnode, the cache size and cache partitions are also computed automatically but they are tuned for better memory utilization of a Data Node. The manual cache configuration settings are ignored when the method is dnode. When the method is manual, the manual cache configuration settings are used.

Compressed Tree Read Size

The size of the block for random access when reading compressed tree files.

Triple Cache Timeout

The time, in seconds, that a cached triple index page can be unused before being eligible to be flushed from the cache. Larger values can potentially cause more memory to be used for by the triple cache. Smaller values can potentially cause more time to be used reloading triple index pages.

Triple Value Cache Timeout

The time, in seconds, that a cached triple value index page can be unused before being eligible to be flushed from the cache. Larger values can potentially cause more memory to be used for by the triple value cache. Smaller values can potentially cause more time to be used reloading triple value index pages.

List Cache Size

The amount of memory to dedicate to caching termlist data for all on-disk stands.

List Cache Partitions

The number of independent list cache partitions to allocate. More partitions allow more concurrency, but make each individual cache partition smaller, which could make it more likely for the cache to fill up. The default is determined based on the amount of memory on your system and should work well for most installations. If you see a lot of CPU under-utilization under heavy concurrent query loads then raising this value can improve performance. The server may use fewer or more than the configured partitions to keep partition sizes between 2048 and 8192 megabytes.

Compressed Tree Cache Size

The amount of memory to dedicate to caching tree data in compressed form for all on-disk stands.

Compressed Tree Cache Partitions

The number of independent compressed tree cache partitions to allocate. More partitions allow more concurrency, but make each individual cache partition smaller, which could make it more likely for the cache to fill up. The default is determined based on the amount of memory on your system and should work well for most installations. If you see a lot of CPU under-utilization under heavy concurrent query loads then raising this value can improve performance. The server may use fewer or more than the configured partitions to keep partition sizes between 512 and 8192 megabytes.

Expanded Tree Cache Size

The amount of memory to dedicate to caching tree data in expanded form for the query evaluator.

Expanded Tree Cache Partitions

The number of independent expanded tree cache partitions to allocate. More partitions allow more concurrency, but make each individual cache partition smaller, which could make it more likely for the cache to fill up. The default is determined based on the amount of memory on your system and should work well for most installations. If you see a lot of CPU under-utilization under heavy concurrent query loads then raising this value can improve performance. The server may use fewer or more than the configured partitions to keep partition sizes between 1024 and 8192 megabytes.

Triple Cache Size

The amount of memory to dedicate to caching triple data for all on-disk stands.

Triple Cache Partitions

The number of independent triple cache partitions to allocate. More partitions allow more concurrency, but make each individual cache partition smaller, which could make it more likely for the cache to fill up. The default is determined based on the amount of memory on your system and should work well for most installations. If you see a lot of CPU under-utilization under heavy concurrent query loads, then raising this value can improve performance. The server may use fewer or more than the configured partitions to keep partition sizes between 1024 and 8192 megabytes.

Triple Value Cache Size

The amount of memory to dedicate to caching triple value data for all on-disk stands.

Smtp Relay

The network location (host:port) of the SMTP server. This server is used for all SMTP requests issued through the xdmp:email built-in function. The default port number of the SMTP server is 25. For details, see Configuring an SMTP Server.

Smtp Timeout

The time, in seconds, before an SMTP request times out and issues an error.

Http User Agent

The User-agent string issued when making HTTP requests from an App Server in the group.

Http Timeout

The time, in seconds, before an HTTP request times out.

Xdqp Timeout

The time, in seconds, before a request between a MarkLogic Server evaluator node (the node from which the query is issued) and a MarkLogic Server data node (the node from which the forest data is retrieved) times out.

Triple Value Cache Partitions

The number of independent triple value cache partitions to allocate. More partitions allow more concurrency, but make each individual cache partition smaller, which could make it more likely for the cache to fill up. The default is determined based on the amount of memory on your system and should work well for most installations. If you see a lot of CPU under-utilization under heavy concurrent query loads, then raising this value can improve performance. The server may use fewer or more than the configured partitions to keep partition sizes between 512 and 8192 megabytes.

Host Timeout

The time, in seconds, before a MarkLogic Server host-to-host request times out. The host-to-host requests are used for communication between nodes in a MarkLogic Server cluster.

Host Initial Timeout

The time, in seconds, that an instance of MarkLogic Server will wait for another node to come online when the cluster first starts up before deciding that the node is down, and initiating failover for any forests that are assigned to that offline host.

Retry Timeout

The time, in seconds, before a MarkLogic Server stops retrying a request.

Module Cache Timeout

The time, in seconds, that a cached module can be unused before being flushed from the cache. Larger values can potentially cause more memory to be used for cached modules. Smaller values can potentially cause more time to be used reloading uncached modules.

System Log Level

The minimum log level messages sent to the operating system. Log levels are listed in decreasing level of log details. You may change the system log level or leave it at the default level.

File Log Level

The minimum log level messages sent to the log file. Log levels are listed in decreasing level of log details. You may change the file log level or leave it at the default level.

Rotate Log Files

Specifies how often to start a new log file. You may change this field or use the default value provided.

Keep Log Files

Specifies how many log files are kept. You may change this field or use the default value provided.

Failover Enable

Set to true if you want to enable failover for the hosts in the group. To use failover, you must also enable failover for individual forests. If you set Failover Enable to false, failover is disabled for all the hosts in the group, regardless of their forest configurations.

Xdqp-Ssl-Enabled

Specifies whether SSL is enabled for XDQP. For details, see Enabling SSL Communication over XDQP.

Xdqp-Ssl-Allow-Sslv3

Specifies whether the SSL v3 protocol is allowed for XDQP.

Xdqp-Ssl-Allow-Tls

Specifies whether the Transport Layer Security protocol is allowed for XDQP.

Xdqp-Ssl Ciphers

The SSL ciphers that may be used.

Background Io Limit

The maximum megabytes per second that a host may use for background I/O (merge, backup, restore). A value of 0 means no limit.

Metering Enabled

Specifies if usage metering is enabled for this group. When usage metering is enabled, a small amount of statistics about resources being used is saved to the meters database.

Performance Metering Enabled

Specifies if performance metering is enabled for this group. When enabled, performance statistics are stored in the Meters database to enable historic views of cluster performance.

Meters Database

The name of the database in which usage metering and historic performance data will be stored.

Performance Metering Period

The performance metering period in minutes.

Performance Metering Retain Raw

The number of days raw performance metering data is retained.

Performance Metering Retain Hourly

The number of days hourly performance metering data is retained.

Performance Metering Retain Daily

The number of days daily performance metering data is retained.

Telemetry-Log-Level

The minimum log level for log messages collected and sent by telemetry. For details, see Configure Telemetry in the Admin Interface in the Monitoring MarkLogic Guide.

Telemetry-Metering

The set of Metering data collected by telemetry. For details, see Configure Telemetry in the Admin Interface in the Monitoring MarkLogic Guide.

Telemetry-Config

The frequency of Config file changes collected by telemetry. For details, see Telemetery in the Monitoring MarkLogic Guide.

Telemetry Usage

Indicates whether the usage data is collected by telemetry.

Telemetry Proxy

The URL of the proxy used by telemetry. Proxy URL should start with https://, for example, https://proxy.marklogic.com:8080. If you don't specify the port number, it assumes the proxy server is listening on port 8080. For details, see Telemetery in the Monitoring MarkLogic Guide.

S3 Domain

The internet domain name of the simple storage service. The default value is s3.amazonaws.com. To access a different simple storage service that is API compatible with Amazon S3, specify it here.

S3 Protocol

The network protocol to use when accessing the simple storage service. The default is https. To use a more secure protocol when accessing the simple storage service, choose https.

S3 Server Side Encryption

The method of data encryption for data at rest on the simple storage service. The default is aes256 To encrypt data at rest on the simple storage service, choose aes256. To encrypt data by custom AWS KMS key, choose aws:kms. You must use https to access an object protected by AWS KMS.

S3 Server Side Encryption Kms Key

The custom AWS KMS key of encryption for data at rest on the simple storage service. If you choose kms:key encryption and want to use your own KMS key, this field is required. Otherwise the default KMS key is used. The AWS KMS key must be in the same region as the S3 bucket.

S3 Proxy

The URL of the proxy server to access S3. The proxy URL should start with https:// (for example, https://proxy.marklogic.com:8080). If you don't specify the port number, MarkLogic assumes the proxy server is listening on port 8080.

Azure Storage Proxy

The URL of the proxy server to access Azure Blob Storage. The proxy URL should start with https:// (for example, https://proxy.marklogic.com:8080). If you don't specify the port number, MarkLogic assumes the proxy server is listening on port 8080.

Security Database

The security database where global security data are kept for hosts in this group. This database is where Amazon Web Services access keys and secret keys are kept for use with the simple storage service.

Temporary Directory

The directory used for disk-based sorting/joining, converters, and plugins.