Skip to main content

Administrating MarkLogic Server

Group Settings

To access the settings for a particular group, follow these steps:

Log into the Admin Interface.
Click the Groups icon on the left tree menu.
Click the group for which you want to view settings.
Click the Configure tab.

This table contains the Group settings:

Field	Description
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.
list cache size	Note This setting appears only when cache sizing = manual. The amount of memory to dedicate to caching termlist data for all on-disk stands. This setting is only used when cache sizing is set to manual.
list cache partitions	Note This setting appears only when cache sizing = manual. 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. This setting is only used when cache sizing is set to manual.
compressed tree cache size	Note This setting appears only when cache sizing = manual. Available when cache sizing = `manual`. The amount of memory to dedicate to caching tree data in compressed form for all on-disk stands. This setting is only used when cache sizing is set to manual.
compressed tree cache partitions	Note This setting appears only when cache sizing = manual. 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. This setting is only used when cache sizing is set to manual.
expanded tree cache size	Note This setting appears only when cache sizing = manual. The amount of memory to dedicate to caching tree data in expanded form for the query evaluator. This setting is only used when cache sizing is set to manual.
expanded tree cache partitions	Note This setting appears only when cache sizing = manual. 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. This setting is only used when cache sizing is set to manual.
triple cache size	Note This setting appears only when cache sizing = manual. The amount of memory to dedicate to caching triple data for all on-disk stands. This setting is only used when cache sizing is set to manual.
triple cache partitions	Note This setting appears only when cache sizing = manual. 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. This setting is only used when cache sizing is set to manual.
triple value cache size	Note This setting appears only when cache sizing = manual. The amount of memory to dedicate to caching triple value data for all on-disk stands. This setting is only used when cache sizing is set to manual.
triple value cache partitions	Note This setting appears only when cache sizing = manual. 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. This setting is only used when cache sizing is set to manual.
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.
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.
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 [v10.0-8 and up]	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.

In this section: