MarkLogic 12 Product Documentation

Groups Help

A Group is a set of similarly configured hosts within a cluster.

• group name specifies the name of the group.
• Turning on this option enables dynamic hosts join this group.
• cache sizing specifies 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 specifies 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 specifies 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 specifies 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 specifies 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 specifies 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 specifies 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 specifies 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 specifies 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 specifies 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 specifies 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 specifies the size of the block for random access when reading compressed tree files.
• triple cache timeout specifies 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 specifies 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 specifies 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.
• SMTP timeout specifies the time, in seconds, before an SMTP request times out and issues an error.
• HTTP user agent specifies the User-agent string issued when making HTTP requests from an App Server in the group.
• HTTP timeout specifies the time, in seconds, before an HTTP request times out.
• XDQP timeout specifies 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 specifies 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 specifies 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 specifies the time, in seconds, before a MarkLogic Server stops retrying a request.
• module cache timeout specifies 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 specifies the minimum log level for log messages sent to the operating system logging facility.
• file log level specifies the minimum log level for log messages sent to the MarkLogic Server log file (ErrorLog.txt).
• rotate log files specifies the when new log files are opened and old log files rotated.
• keep log files specifies the number of log files to keep on rotation.
• If you have the failover option enabled, setting failover-enable to true enables failover for the hosts in the group. To use failover, you must also enable failover for individual forests. If you set this 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.
• XDQP-SSL-min-allow-TLS specifies whether the minimum Transport Layer Security protocol is allowed for XDQP.
• XDQP-SSL ciphers specifies the SSL ciphers that may be used for TLS 1.2 in XDQP.
• XDQP-SSL ciphersuites specifies the SSL ciphersuites that may be used for TLS 1.3 in XDQP.
• background I/O limit specifies 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.
• metering database specifies the name of the database in which usage metering and historic performance data will be stored.
• performance metering period specifies the performance metering period in minutes.
• metering retain raw specifies the number of days raw performance metering data is retained.
• metering retain hourly specifies the number of days hourly performance metering data is retained.
• metering retain daily specifies the number of days daily performance metering data is retained.
• telemetry-log-level specifies the minimum log level for log messages collected and sent by telemetry
• telemetry-metering specifies the set of Metering data collected by telemetry.
• telemetry-config specifies the frequency of Config file changes collected by telemetry.
• telemetry-usage specifies whether the usage data is collected by telemetry.
• telemetry proxy specifies 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.
• s3 domain specifies 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 specifies 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 specifies the method of data encryption for data at rest on the simple storage 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 specifies the custom AWS KMS key of encryption for data at rest on the simple storage service. If you choose "kms:key" in s3 server side encryption and want to use your own KMS key, this field is required. Otherwise the default KMS key will be used. The AWS KMS key must be in the same region as the S3 bucket that you want to use.
• s3 proxy specifies the URL of the proxy used by S3. 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.
• azure storage proxy specifies the URL of the proxy used by Azure Blob Storage. 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.
• security database specifies the security database where global security data are kept for hosts in the group. This database is where Amazon Web Services access keys and secret keys are kept for use with the simple storage service.
• temporary directory specifies the directory for temporary files for disk based sorting/joining, converters and plugins. Mount fast storage.
• optimized-plan-cache-timeout The optimized plan cache timeout in seconds.

Buttons and Tabs:

• Clicking the delete button on the group configuration page deletes the current group from the cluster.
• The Status tab for each group displays current information on hosts, App Servers, and forests in the group.
• Use the Create tab to create a new group.