Loading TOC...
Ops Director Guide (PDF)

Ops Director Guide — Chapter 5

Manage View

The Manage view shows details for a selected MarkLogic resource or resource category, in form of charts, tables, and other displays.

The default Manage view displays an inventory list of resources within an enterprise.It displays the list of clusters across an enterprise, along with their key properties, in a data grid.

The panel on the left-hand side is a navigation tree with scrolling lists of all resources displayed according to the object hierarchy. The title of the content area displays the object name selected in the navigation tree. For individual resources, this area displays the resource name and key information related to the resource.

The content area of this view presents content tabs in different categories for the selected object or resource. In the Enterprise case, there are four tabs, one for each resource type: Clusters, Hosts, Databases, and App Servers. Each tab presents a table that lists the corresponding resources within the enterprise. The list includes the resource name and status indicator in first column, followed by other properties.

This chapter covers the following topics:

Resources Navigation Panel

The resources panel allows you to navigate across individual resources or groups of resources, as described in the following sections:

View All Resources

In the left navigation panel of the Manage view, select the All Resources tab and Enterprise to display a consolidated view of all of the resources in your enterprise. The lists can be expanded and collapsed with icons. Each Cluster will show Hosts, Databases, and App Servers that belong to that particular cluster. The health status of resources are shown at both parent and child level. The colors used to represent resource status are described in Terms.

You can drill down to more specific views of a particular cluster, a group of similar resource types in your cluster, or a specific resource within a resource type.

View Resource Groups

Select the Resource Groups tab and Enterprise to display a consolidated view of all the defined resource groups. If a group contains Clusters, collapsing or expanding each cluster hides or reveals members of the resource group.

For more information on resource groups, see Resource Groups.

You can drill down to more specific views of a resources in a particular group or a specific resource within a resource group.

Click on an object/resource in the navigation tree to display relevant information in the content area; the selection is highlighted in the navigation tree.

Manage Clusters Tab

The Clusters tab displays the list of clusters in your enterprise.

The columns displayed in the Manage Clusters tab are described in the table below.

ColumnDescription
NameThe name of the cluster.
GroupsThe number of groups in the cluster.
HostsThe number of hosts in the cluster.
DatabasesThe number of databases in the cluster.
ForestsThe number of forests in the cluster.
App ServersThe number of App Servers in the cluster.
Server VersionThe version of MarkLogic Server running on the cluster's hosts.
OSThe name and version of the operating system on the cluster's hosts.
UptimeThe duration (Days Hrs:Min) the cluster has been available.
EncryptionSpecifies whether data encryption is turned on or off in the cluster.

To drill down for a particular cluster, click on the cluster name in the clusters' table. You will see the following content tabs, each one representing an information category for the selected cluster:

To filter the data used for rendering the graphs, select a pre-defined time period or specify a custom time period, as described in Date and Time Filters.

Cluster Metrics

Metrics is the first tab displayed for any resource type. This tab displays key indicators allowing administrators to determine the selected resource's health.

The metrics displayed by charts on the Cluster Metrics tab are described in the table below.

ChartDefinition of Displayed Metric
Disk I/ODisk I/O in MB/sec. For descriptions of the lines displayed on this graph, see Disk Performance Data.
App Server Request RateThe total number of queries being processed per second, across all of the App Servers in the cluster. For descriptions of the lines displayed on this graph, see Server Performance Data.
App Server LatencyThe average time (in seconds) it takes to process queries, across all of the App Servers in the cluster. For descriptions of the lines displayed on this graph, see Server Performance Data.
CPUThe aggregate I/O performance data for the CPUs in the cluster. For descriptions of the lines displayed on this graph, see CPU Performance Data.
Memory Footprint

The total amount (in MB) of memory consumed by all of the hosts in the cluster.

The displayed metrics are:

  • RSS: The total amount of MB of Process Resident Size (RSS) consumed by the cluster.
  • Anon: The total amount of MB of Process Anonymous Memory consumed by the cluster.
Memory SizeThe amount of space (in MB) forest data files for this cluster take up in memory.
Memory I/O

The number of pages per second moved between memory and disk.

The displayed metrics are:

  • Page-In Rate: The page-in rate (from Linux /proc/vmstat) for the cluster in pages/sec.
  • Page-Out Rate: The page-out rate (from Linux /proc/vmstat) for the cluster in pages/sec.
  • Swap-In Rate: The swap-in rate (from Linux /proc/vmstat) for the cluster in pages/sec.
  • Swap-Out Rate: The swap-out rate (from Linux /proc/vmstat) for the cluster in pages/sec.

For more information, see Memory Performance Data.

NetworkVarious XDQP performance metrics, such as the sum of XDQP activity across the cluster. XDQP (XML Data Query Protocol) is a MarkLogic internal protocol used for communication between nodes in a cluster. For more detail, see Network Performance Data.

Cluster Information

Use the Information tab to access properties of the selected cluster.

The properties displayed in the Cluster Information tab are described in the table below.

FieldDescription
Bootstrap Host

The connection attributes for the bootstrap host on this cluster.

  • Bootstrap Connect Port: The bind port for the bootstrap host.
  • Bootstrap Host Name: The name of the bootstrap host.
  • Bootstrap Host ID: The ID used to identify the bootstrap host.

For details, see Bootstrap Hosts in the Concepts Guide.

Cluster IDThe ID used to identify this cluster.
Cluster NameThe name used to identify this cluster.
Data DirectoryThe MarkLogic default data directory. For details, see Installing MarkLogic in the Installation Guide.
Effective VersionThe effective version of MarkLogic Server that is installed on each host in this cluster. For details, see Effective version and software version in the Administrator's Guide.
Filesystem DirectoryThe MarkLogic installation directory. For details, see Installing MarkLogic in the Installation Guide.
RoleThe role (local or foreign) of the cluster in the current environment. For details, see Coupling Clusters in the Administrator's Guide.
Security VersionThe MarkLogic Server version number.
SSL Fips EnabledWhether FIPS-capable OpenSSL is enabled (true) or disabled (false). For details, see OpenSSL FIPS 140-2 Mode in the Administrator's Guide.
VersionThe software version of MarkLogic Server that is installed on each host in this cluster. For details, see Effective version and software version in the Administrator's Guide.
XDQP SSL CertificateThe SSL Certificate used for secure communication between the clusters. For details, see Ops Director Security and Inter-cluster Communication in the Concepts Guide.

Cluster Tasks

Use the Tasks tab for an up-to-date report on tasks across the hosts within the selected cluster. The report shows tasks that are currently running, are scheduled to run, or that have been delayed.

The columns displayed in the Cluster Tasks tab are described in the table below.

ColumnDescription
ClusterCluster on which the task host is located.
HostThe hostname of the host computer on which the scheduled module is to be invoked.
EnabledWhether the task is enabled (true) or disabled (false).
Task RootThe root directory (filesystem) or URI root (database) that contains the module.
Task PathThe module the task is to invoke.
Task TypeThe task type:
  • minutely specifies how many minutes between each invocation of the module.
  • hourly specifies how many hours and minutes between each invocation of the module.
  • daily specifies how many days between each invocation of the module and the time of day (in 24:00 notation).
  • weekly specifies how many weeks between each invocation of the module, check one or more days of the week, and the time of day (in 24:00 notation) for the task to start.
  • monthly specifies how many months between each invocation of the module, select one day of the month (1-31), and the time of day (in 24:00 notation) for the task to start.
  • one-time specifies the start date in MM/DD/YYYY notation (for example, 07/29/2009 for July 29, 2009) and time in 24:00 notation.
Task PeriodHow often the module is to be invoked (every n months, weeks, days, hours, or minutes).
Created onThe datetime the task was created.
DatabaseThe database to which the scheduled module connects for query execution.
Task ModulesThe name of the database in which the scheduled module locates the application code. If set to (file system), then any files in the specified task root directory are executable (given the proper permissions). If set to a database, then any documents in the database whose URI begins with the specified task root directory are executable.
UserThe user with permission to invoke the module.
PriorityThe priority of the task:
  • normal specifies the task should be queued with normal priority.
  • higher specifies the task should be queued with higher priority.

Cluster Logs

Use the Logs tab to access a tabular listing of log records that have been logged by various resources within the cluster.

The columns displayed in the Cluster Logs tab are described in the table below.

ColumnDescription
Date & TimeDatetime of the logged event.
LevelThe log level of the event. For a description of the log levels, see Understanding the Log Levels in the Administrator's Guide.
Cluster NameThe name of the cluster on which the logged event occurred.
Host NameThe name of the host on which the logged event occurred.
MessageThe logged error message.
Log FileThe full text of the logged event.

Cluster Hosts

Use the Hosts tab to get the list of all the hosts within the selected cluster. This tab shows host name as the first column, followed by other properties. Click on the host name to navigate to the manage view of the selected host.

The columns displayed in the Cluster Hosts tab are described in the table below.

ColumnDescription
NameThe hostname of each host.
GroupThe name of the group that contains each host.
OSThe name and version of the operating system on which each host runs.
Server VersionThe version of MarkLogic Server on each host.
ForestsThe number of forests on each host.
DatabasesThe number of databases on each host.
App ServersThe number of App Servers on each host.
Disk Space (MB)The amount of disk space (in MB) used on each host.
UptimeThe duration (Days Hrs:Min) each host has been available.
Maint. ModeThe host maintenance mode (normal or maintenance) for each host. For details, see Rolling Upgrades in the Administrator's Guide.
ZoneThe Amazon Web Services (AWS) zone in which each host resides, if applicable. For details, see MarkLogic Server on Amazon EC2 Guide.

Cluster Databases

Use the Databases tab to get the list of all the databases within the cluster, with database name as the first column followed by other properties. Click on the database name to navigate to the manage view of the selected database.

The columns displayed in the Cluster Databases tab are described in the table below.

ColumnDescription
NameName of the database.
ForestsThe number of forests used by the database.
Disk Size (MB)The amount of disk space used by the database forests, in megabytes.
DocumentsThe number of documents in the database.
Last BackupThe data-time of the last backup of the database. No value, if the database has never been backed up. For details on backing up a database, see Backing Up and Restoring a Database in the Administrator's Guide.
EncryptionSpecifies whether or not encryption at rest should be enabled for the database. For details, see Encryption at Rest in the Security Guide.
HASpecifies whether or not shared disk failover is enabled. For details, see High Availability of Data Nodes With Failover in the Scalability, Availability, and Failover Guide.
ReplicationSpecifies whether or not database replication is enabled (On/Off). For details, see the Database Replication Guide.
Replication StatusSpecifies whether or not database replication is configured for the database.
Security DBThe name of the security database used by the database. For details, see Administering Security in the Security Guide.
Schemas DBThe name of the schemas database used by the database. For details, see Understanding and Defining Schemas in the Administrator's Guide.
Triggers DBThe name of the schemas database used by the database. For details, see Using Triggers to Spawn Actions in the Application Developer's Guide.

Cluster App Servers

Use the App Servers tab to get the list of all the application servers within the cluster, with App Server name as the first column followed by other properties. Click on the App Server name to navigate to the manage view of the selected application server.

The columns displayed in the Cluster App Servers tab are described in the table below.

ColumnDescription
NameThe name of the App Server.
TypeThe App Server type (HTTP, WebDAV, XDBC, ODBC).
DatabaseThe name of the App Server content database.
PortThe port number used to access the App Server.
SSLWhether the App Server has SSL enabled (yes) or disabled (no). For details, see Configuring SSL on App Servers in the Security Guide.
GroupThe name of the group to which the App Server belongs
Modules DB+RootThe name of the modules database, or if filesystem, the root directory.
SecurityThe type of security (internal or external).

Cluster Forests

Use the Forests tab to get the list of all the forests within the cluster, with forest name as the first column followed by other properties. Click on the forest name to navigate to the manage view of the selected forest.

The columns displayed in the Cluster Forests tab are described in the table below.

ColumnDescription
NameThe name of the forest.
HostThe forest host.
DocumentsThe number of documents in the forest.
StatusThe status of the forest. Enabled or Disabled.
AvailabilityThe availability of the forest. Online or Offline.
FragmentsThe number of active fragments (the fragments available to queries) in the forest.
Deleted FragmentsThe number of deleted fragments (the fragments to be removed by the next merge operation) in the forest.
StandsThe number of stands in the forest. For more information on stands, see Databases, Forests, and Stands in the Concepts Guide.
Size (MB)The size of the forest, in MB.
Encrypted Size (MB)The amount of encrypted data in the forest. For details on data encryption, see Encryption at Rest in the Security Guide.
Free Space (MB)The number of MB of free space on this forest.
Large Data Size (MB)The amount of data in the large data directories of the forest. For more information on Large Data, see Working With Binary Documents in the Application Developer's Guide.
Fast Data Size (MB)The amount of data in the fast data directories of the forest. For more information on Fast Data, see Fast Data Directory on Forests in the Query Performance and Tuning Guide.
Failover EnabledWhether failover is enabled for the forest. For more information on stands, see High Availability of Data Nodes With Failover in the Scalability, Availability, and Failover Guide.
ReplicationSpecifies whether or not database replication is enabled for this forest. For details, see the Database Replication Guide.

Manage Hosts Tab

The Hosts tab displays the list of hosts in your enterprise.

You can only see the hosts to which you have access.

The columns displayed in the Manage Hosts tab are described in the table below.

ColumnDescription
NameThe hostname of the host.
ClusterThe name of the cluster on which the host resides.
GroupThe name of the group that contains the host.
OSThe name and version of the operating system on which the host runs.
Server VersionThe version of MarkLogic Server on the host.
ForestsThe number of forests on the host.
DatabasesThe number of databases on the host.
App ServersThe number of App Servers on the host.
Disk Space (MB)The amount of disk space (in MB) used on the host.
UptimeThe duration (Days Hrs:Min) the host has been available.
Maint. ModeThe host maintenance mode (normal or maintenance). For details, see Rolling Upgrades in the Administrator's Guide.
ZoneThe Amazon Web Services (AWS) zone in which the host resides, if applicable. For details, see MarkLogic Server on Amazon EC2 Guide.

To drill down for a particular host, click on the host name in the hosts' table. You will see the following content tabs, each one representing an information category for the selected host:

To filter the data used for rendering the graphs, select a pre-defined time period or specify a custom time period, as described in Date and Time Filters.

Host Metrics

Select a single host from the navigation tree. The Metrics tab displays key indicators allowing administrators to determine the selected resource's health.

The metrics displayed by charts on the Host Metrics tab are described in the table below.

ChartDefinition of Displayed Metric
Disk I/ODisk I/O in MB/sec. For details, see Disk Performance Data.
CPUThe aggregate I/O performance data for the CPUs in the host. For details, see CPU Performance Data.
Memory Footprint

The total amount (in MB) of memory consumed by this host.

The displayed metrics are:

  • RSS: The total amount of MB of Process Resident Size (RSS) consumed by the host.
  • Anon: The total amount of MB of Process Anonymous Memory consumed by the host.
Memory SizeThe amount of space (in MB) forest data files for this host take up in memory.
Memory I/O

The number of pages per second moved between memory and disk.

The displayed metrics are:

  • Page-In Rate: The page-in rate (from Linux /proc/vmstat) for the host in pages/sec.
  • Page-Out Rate: The page-out rate (from Linux /proc/vmstat) for the host in pages/sec.
  • Swap-In Rate: The swap-in rate (from Linux /proc/vmstat) for the host in pages/sec.
  • Swap-Out Rate: The swap-out rate (from Linux /proc/vmstat) for the host in pages/sec.
NetworkVarious XDQP performance metrics as the sum of XDQP activity for this host. For details, see Network Performance Data.

Host Information

Use the Information tab to access properties of the selected host.

The properties displayed in the Host Information tab are described in the table below.

FieldDescription
Bind PortThe port on which the host to handle inter-host communication within this cluster. For details, see Inter-cluster Communication in the Concepts Guide.
Bootstrap Host

Whether this host is a bootstrap host (true). If not, the value is false.

For details, see Bootstrap Hosts in the Concepts Guide.

Foreign Bind PortThe port used by the host to handle XDQP communication with foreign clusters. For details, see Bootstrap Hosts in the Concepts Guide.
GroupThe group to which this host belongs. For details on groups, see Groups in the Administrator's Guide.
Host ModeThe host maintenance mode (normal or maintenance). For details, see Rolling Upgrades in the Administrator's Guide.
Host Mode DescriptionDescription of the host mode, if set.
Host NameThe name of the host.
ZoneThe Amazon Web Services (AWS) zone in which the host resides, if applicable. For details, see MarkLogic Server on Amazon EC2 Guide.

Host Tasks

Use the Tasks tab for an up-to-date report on tasks that are currently running or scheduled to run on this host.

You can only see the tasks for the hosts to which you have access.

The columns displayed in the Host Tasks tab are described in the table below.

ColumnDescription
ClusterCluster on which the task host is located.
HostThe hostname of the host computer on which the scheduled module is to be invoked.
EnabledWhether the task is enabled (true) or disabled (false).
Task RootThe root directory (filesystem) or URI root (database) that contains the module.
Task PathThe module the task is to invoke.
Task TypeThe task type:
  • minutely specifies how many minutes between each invocation of the module.
  • hourly specifies how many hours and minutes between each invocation of the module.
  • daily specifies how many days between each invocation of the module and the time of day (in 24:00 notation).
  • weekly specifies how many weeks between each invocation of the module, check one or more days of the week, and the time of day (in 24:00 notation) for the task to start.
  • monthly specifies how many months between each invocation of the module, select one day of the month (1-31), and the time of day (in 24:00 notation) for the task to start.
  • one-time specifies the start date in MM/DD/YYYY notation (for example, 07/29/2009 for July 29, 2009) and time in 24:00 notation.
Task PeriodHow often the module is to be invoked (every n months, weeks, days, hours, or minutes).
Created onThe datetime the task was created.
DatabaseThe database to which the scheduled module connects for query execution.
Task ModulesThe name of the database in which the scheduled module locates the application code. If set to (file system), then any files in the specified task root directory are executable (given the proper permissions). If set to a database, then any documents in the database whose URI begins with the specified task root directory are executable.
UserThe user with permission to invoke the module.
PriorityThe priority of the task:
  • normal specifies the task should be queued with normal priority.
  • higher specifies the task should be queued with higher priority.

Host Logs

Use the Logs tab to access a tabular listing of log records of the host.

You can only see the logs from the hosts to which you have access.

The columns displayed in the Host Logs tab are described in the table below.

ColumnDescription
Date & TimeDatetime of the logged event.
LevelThe log level of the event. For a description of the log levels, see Understanding the Log Levels in the Administrator's Guide.
Cluster NameThe name of the cluster on which the logged event occurred.
Host NameThe name of the host on which the logged event occurred.
MessageThe logged error message.
Log FileThe full text of the logged event.

Host Databases

Use the Databases tab to get the list of all the databases within the host, with database name as the first column followed by other properties. Click on the database name to navigate to the manage view of the selected database.

Access to databases is not implicit with host access. You must have explicit access to the host databases to be able to drill down for them. For details, see Role Based Access Control (RBAC) Settings.

The columns displayed in the Host Databases tab are described in the table below.

ColumnDescription
NameName of the database.
ForestsThe number of forests used by the database.
Disk Size (MB)The amount of disk space used by the database forests, in megabytes.
DocumentsThe number of documents in the database.
Last BackupThe data-time of the last backup of the database. No value, if the database has never been backed up. For details on backing up a database, see Backing Up and Restoring a Database in the Administrator's Guide.
EncryptionSpecifies whether or not encryption at rest should be enabled for the database. For details, see Encryption at Rest in the Security Guide.
HASpecifies whether or not shared disk failover is enabled. For details, see High Availability of Data Nodes With Failover in the Scalability, Availability, and Failover Guide.
ReplicationSpecifies whether or not database replication is enabled. For details, see the Database Replication Guide.
Replication StatusSpecifies whether or not database replication is configured for the database.
Security DBThe name of the security database used by the database. For details, see Administering Security in the Security Guide.
Schemas DBThe name of the schemas database used by the database. For details, see Understanding and Defining Schemas in the Administrator's Guide.
Triggers DBThe name of the schemas database used by the database. For details, see Using Triggers to Spawn Actions in the Application Developer's Guide.

Host App Servers

Use the App Servers tab to get the list of all the application servers within the host, with App Server name as the first column followed by other properties. Click on the App Server name to navigate to the manage view of the selected application server.

Access to App Servers is not implicit with host access. You must have explicit access to the host's App Servers to be able to drill down for them. For details, see Role Based Access Control (RBAC) Settings.

The columns displayed in the Host App Servers tab are described in the table below.

ColumnDescription
NameThe name of the App Server.
TypeThe App Server type (HTTP, WebDAV, XDBC, ODBC).
DatabaseThe name of the App Server content database.
PortThe port number used to access the App Server.
SSLWhether the App Server has SSL enabled (yes) or disabled (no). For details, see Configuring SSL on App Servers in the Security Guide.
GroupThe name of the group to which the App Server belongs
Modules DB+RootThe name of the modules database, or if filesystem, the root directory.
SecurityThe type of security (internal or external).

Host Forests

Use the Forests tab to get the list of all the forests within the host, with forest name as the first column followed by other properties. Click on the forest name to navigate to the manage view of the selected forest.

The columns displayed in the Host Forests tab are described in the table below.

ColumnDescription
NameThe name of the forest.
DocumentsThe number of documents in the forest.
StatusThe status of the forest. Enabled or Disabled.
AvailabilityThe availability of the forest. Online or Offline.
FragmentsThe number of active fragments (the fragments available to queries) in the forest.
Deleted FragmentsThe number of deleted fragments (the fragments to be removed by the next merge operation) in the forest.
StandsThe number of stands in the forest. For more information on stands, see Databases, Forests, and Stands in the Concepts Guide.
Size (MB)The size of the forest, in MB.
Encrypted Size (MB)The amount of encrypted data in the forest. For details on data encryption, see Encryption at Rest in the Security Guide.
Free Space (MB)The number of MB of free space on this forest.
Large Data Size (MB)The amount of data in the large data directories of the forest. For more information on Large Data, see Working With Binary Documents in the Application Developer's Guide.
Fast Data Size (MB)The amount of data in the fast data directories of the forest. For more information on Fast Data, see Fast Data Directory on Forests in the Query Performance and Tuning Guide.
Failover EnabledWhether failover is enabled for the forest. For more information on stands, see High Availability of Data Nodes With Failover in the Scalability, Availability, and Failover Guide.
ReplicationSpecifies whether or not database replication is enabled for this forest. For details, see the Database Replication Guide.

Manage Databases Tab

The Databases tab displays the list of databases in your enterprise.

The columns displayed in the Manage Databases tab are described in the table below.

ColumnDescription
NameName of the database.
ClusterCluster on which the database resides.
ForestsThe number of forests used by the database.
Disk Size (MB)The amount of disk space used by the database forests, in megabytes.
DocumentsThe number of documents in the database.
Last BackupThe data-time of the last backup of the database. No value, if the database has never been backed up. For details on backing up a database, see Backing Up and Restoring a Database in the Administrator's Guide.
EncryptionSpecifies whether or not encryption at rest should be enabled for the database. For details, see Encryption at Rest in the Security Guide.
HASpecifies whether or not shared disk failover is enabled. For details, see High Availability of Data Nodes With Failover in the Scalability, Availability, and Failover Guide.
ReplicationSpecifies whether or not database replication is enabled. For details, see the Database Replication Guide.
Security DBThe name of the security database used by the database. For details, see Administering Security in the Security Guide.
Schemas DBThe name of the schemas database used by the database. For details, see Understanding and Defining Schemas in the Administrator's Guide.
Triggers DBThe name of the schemas database used by the database. For details, see Using Triggers to Spawn Actions in the Application Developer's Guide.

To drill down for a particular database, click on the database name in the databases' table. You will see the following content tabs, each one representing an information category for the selected database:

To filter the data used for rendering the graphs, select a pre-defined time period or specify a custom time period, as described in Date and Time Filters.

Database Metrics

Select a single database or all databases from the navigation tree. The Metrics tab displays key indicators allowing administrators to determine the selected resource or resource group's health.

The metrics displayed by charts on the Database Metrics tab are described in the table below.

ChartDefinition of Displayed Metric
Disk I/ODisk I/O in MB/sec. The displayed metrics are described in Disk Performance Data.
Memory Footprint

The total amount (in MB) of memory consumed by the database.

The displayed metrics are:

  • RSS: The total amount of MB of Process Resident Size (RSS) consumed by the database.
  • Anon: The total amount of MB of Process Anonymous Memory consumed by the database.
Memory SizeThe amount of space (in MB) forest data files for the database take up in memory.
Memory I/O

The number of pages per second moved between memory and disk.

The displayed metrics are:

  • Page-In Rate: The page-in rate (from Linux /proc/vmstat) for the database in pages/sec.
  • Page-Out Rate: The page-out rate (from Linux /proc/vmstat) for the database in pages/sec.
  • Swap-In Rate: The swap-in rate (from Linux /proc/vmstat) for the database in pages/sec.
  • Swap-Out Rate: The swap-out rate (from Linux /proc/vmstat) for the database in pages/sec.
Lock Rate

The number of locks set per second across all of the databases in the cluster.

The displayed lines are:

  • Read: The number of read locks set per second.
  • Write: The number of write locks set per second.
  • Deadlock: The number of deadlocks per second.
Lock Wait Load

The aggregate time (in seconds) transactions wait for locks;

The displayed lines are:

  • Read: The time transactions wait for read locks.
  • Write: The time transactions wait for write locks.

Database Information

Use the Information tab to access properties of the selected database.

The properties displayed in the Database Information tab are described in the table below.

FieldDescription
Assignment PolicyDatabase rebalancer assignment policy. For details, see Rebalancer Document Assignment Policies in the Administrator's Guide.
Attribute Value PositionsSpecifies whether index data is included which speeds up the performance of proximity queries that use the cts:field-value-query function. Turn this index off if you are not interested in proximity queries and if you want to conserve disk space and decrease loading time.
Collection LexiconSpecifies whether to create a lexicon of all of the collection URIs in the database. The collection lexicon allows you to quickly list all of the collection URIs in the database and to perform lexicon-based queries on the URIs.
Data EncryptionSpecifies whether or not encryption at rest is enabled. For details, see Encryption at Rest in the Security Guide.
Database NameThe name of the database.
Database ReplicationSpecifies whether or not database replication is enabled.
Directory CreationSpecifies whether directories are automatically created in the database when documents are created. The default for a new database is manual. The settings are:
  • automatic -- Specifies that a directory hierarchy is automatically created to match the URI of a document or a directory that is created. This is the recommended setting, especially if you are accessing the database with a WebDAV Server or if you are using it as a Modules database.
  • manual -- Specifies that directories must be manually created. No directory hierarchy is enforced.
  • manual-enforced -- The same as manual, except it raises an error if the parent directory does not exist when creating a document or directory. For example, in order to create a document with the URI http://marklogic/file.xml, the directory http://marklogic/ must first exist.
Element Value PositionsSpecifies whether index data is included for faster element-based phrase and cts:near-query searches that use cts:element-value-query.
Element Word PositionsSpecifies whether index data should be included in the database files to enable proximity searches (cts:near-query) within specific XML elements or JSON properties. You must also enable word positions in order to perform element position searches. When this setting is true, positional searches are possible within an XML element or JSON property, but document loading is slower and the database files are larger.
Element Word Query Through

The element markup to be searched through in searches that use the cts:element-word-query constructor.

Words contained in text node children of a phrase through or Element Word Query Through element node match words in a cts:element-word-query for both the element and for the element's parent. If the parent is also a Phrase Through or Element Word Query Through element, then the words also match words in a cts:element-word-query for the grandparent.

  • Namespace URI -- The namespace for an element or an attribute.
  • Localname -- The localname for an XML element/attribute or the name for a JSON property.

For details, see Element Word Query Throughs in the Administrator's Guide.

Enabled Whether data encryption is enabled. For details, see Encryption at Rest in the Security Guide.
Encryption Key IDData encryption key ID. For details, see Encryption at Rest in the Security Guide.
Expunge Locks Specifies if MarkLogic Server automatically expunges any lock fragments created using xdmp:lock-acquire with specified timeouts. The possible values are:
  • automatic -- Cleans up the locks as they expire. This is the default value and is recommended for most installations.
  • none -- The lock fragments remain in the database after the locks expire (although they will no longer be locking any documents) until they are explicitly removed with xdmp:lock-release. This setting is only recommended to speed cluster startup time for extremely large clusters.
Fast Case Sensitive SearchesSpecifies whether index terms should be included in the database files to support fast case-sensitive searches. When this setting is true, case-sensitive searches are faster, but document loading is slower and the database files are larger.
Fast Diacritic Sensitive SearchesSpecifies whether index terms should be included in the database files to support fast diacritic-sensitive searches. When this setting is true, diacritic-sensitive searches are faster, but document loading is slower and the database files are larger.
Fast Element Character SearchesSpecifies whether wildcard searches are enabled to speed up element-based wildcard searches. For details about wildcard searches, see Understanding and Using Wildcard Searches in the Search Developer's Guide.
Fast Element Phrase SearchesSpecifies whether index terms should be included in the database files to enable fast element-phrase searches. When set to true, element-phrase searches are faster, but document loading is slower and the database files are larger.
Fast Element Trailing Wildcard SearchesSpecifies whether index terms should be included in the database files to enable element trailing wildcard searches and faster character-based XQuery predicates. When set to true, element-trailing-wildcard searches are faster, but document loading is slower and the database files are larger.
Fast Element Word SearchesSpecifies whether index terms should be included in the database files to support fast element-word searches. When set to true, element-word searches are faster, but document loading is slower and the database files are larger.
Fast Phrase SearchesSpecifies whether index terms should be included in the database files to support fast phrase searches. When set to true, phrase searches are faster, but document loading is slower and the database files are larger.
Fast Reverse SearchesSpecifies whether index terms should be included in the database files to support fast reverse searches. When set to true, cts:reverse-query searches are faster, but document loading is slower and the database files are larger.

Valid alerting license key is required.

FieldThe configuration of any fields in the database. For details on fields, see Fields Database Settings in the Administrator's Guide.
Field Value PositionsSpecifies whether index data is included which speeds up the performance of proximity queries that use the cts:field-value-query function. Turn this index off if you are not interested in proximity queries and if you want to conserve disk space and decrease loading time.
Field Value SearchesSpecifies whether index data is included which speeds up the performance of field value queries that use the cts:field-value-query function. Turn this index off if you are not interested in field value queries and if you want to conserve disk space and decrease loading time.
ForestThe names of the forests used by the database.
Format CompatibilityThe version compatibility that MarkLogic Server applies to the indexes for the database during request evaluation. A value other than automatic specifies that all forest data has the specified on-disk format, and it disables the automatic checking for index compatibility information. The automatic detection occurs during database startup and after any database configuration changes, and can take some time and system resources for very large forests and for very large clusters. The default value of automatic is recommended for most installations.
In-memory Geospatial Region Index SizeThe amount of cache and buffer memory to be allocated for managing geospatial region index data for an in-memory stand.
In-memory LimitThe maximum number of fragments in an in-memory stand. An in-memory stand contains the latest version of any new or changed fragments. Periodically, in-memory stands are written to disk as a new stand in the forest. Also, if a stand accumulates a number of fragments beyond this limit, it is automatically saved to disk by a background thread.
In-memory List SizeThe amount of cache and buffer memory allocated for managing termlist data for an in-memory stand.
In-memory Range Index SizeThe amount of cache and buffer memory allocated for managing range index data for an in-memory stand.
In-memory Reverse Index SizeThe amount of cache and buffer memory allocated for managing reverse index data for an in-memory stand.
In-memory Tree SizeThe size, in megabytes, of the in-memory tree storage. The In-memory Tree Size should be at least 1 or 2 megabytes larger than the largest text or small binary document you plan on loading into the database. The largest small binary file size is always constrained by the Large Size Threshold database configuration setting.
In-memory Triple Index SizeThe amount of cache and buffer memory allocated for managing triple index data for an in-memory stand.
Index DetectionSpecifies whether to auto-detect index compatibility between the content and the current database settings. This detection occurs during database startup and after any database configuration changes, and can take some time and system resources for very large forests and for very large clusters. The possible values are:
  • automatic -- Auto-detect index. This is the default value and is recommended for most installations.
  • none -- Causes queries to use the current database index settings, even if some settings have not completed reindexing.
Inherit CollectionsWhen set to true, documents and directories automatically inherit collection settings from their parent directory (if collections are not set explicitly when creating the document or directory). If there are any default collections on the user who is creating the document or directory, those permissions are combined with any inherited collections.
Inherit PermissionsWhen set to true, documents and directories automatically inherit permissions from their parent directory (if permissions are not set explicitly when creating the document or directory). If there are any default permissions on the user who is creating the document or directory, those permissions are combined with any inherited permissions.
Inherit QualityWhen set to true, documents and directories automatically inherit any quality settings from their parent directory (if quality is not set explicitly when creating the document or directory).
Journal CountThe number of journal files for the database.
Journal Size

The size, in megabytes, of each journal file. The system uses journal files for recovery operations if a transaction fails to complete successfully. The default value should be sufficient for most systems; it is calculated at database configuration time based on the size of your system. If you change the other memory settings, however, the journal size should equal the sum of the In-memory List Size and the In-memory Tree Size. Additionally, you should add space to the journal size if you use range indexes (particularly if you use a lot of range indexes or have extremely large range indexes), as range index data can take up journal space. Also, if your transactions span multiple forests, you may also need to add journal size, as each journal must keep the lock information for all of the documents in the transaction, not just for the documents that reside in the forest in which the journal exists.

When you change the journal size, the next time the system creates a new journal, it will use the new size limit; existing journals will continue to use the old size limit until they are replaced with new ones (for example, when a journal fills up, when a forest is cleared, or when the system is cleanly shutdown and restarted).

JournalingSpecifies how robust transaction journaling should be. The possible values are:
  • strict -- The journal protects against MarkLogic Server process failures, host operating system kernel failures, and host hardware failures.
  • fast -- The journal protects against MarkLogic Server process failures but not against host operating system kernel failures or host hardware failures.
  • off -- The journal does not protect against MarkLogic Server process failures, host operating system kernel failures, or host hardware failures.
LanguageThe default language for content in the database. Any content without an xml:lang attribute will be indexed in the language specified here.
Large Size ThresholdThe size, in kilobytes, beyond which large binary documents are stored in the Large Data Directory instead of directly in a stand. Binaries smaller than or equal to the threshold are considered small binary files and stored in stands. Binaries larger the threshold are considered large binary files and stored in the Large Data Directory.
LockingSpecifies how robust transaction locking should be. The possible values are:
  • strict -- Locking enforces mutual exclusion on existing documents and on new documents.
  • fast -- Locking enforces mutual exclusion on existing and new documents. Instead of locking all the forests on new documents, it uses a hash function to select one forest to lock. In general, this is faster than strict. However, for a short period of time after a new forest is added, some of the transactions need to be retried internally.
  • off -- Locking does not enforce mutual exclusion on existing documents or on new documents; only use this setting if you are sure all documents you are loading are new (a new bulk load, for example), otherwise you might create duplicate URIs in the database.
Maintain Directory Last ModifiedSpecifies whether to include a timestamp on the properties for each directory in the database. If set to true, update operations on documents in a directory also update the directory last-modified timestamp, which can cause some contention when multiple documents in the directory are being updated. If your application is experiencing contention during these type of updates (for example, if you see deadlock-detected messages in the error log), set this property to false. The default is false.
Maintain Last ModifiedSpecifies whether to include a timestamp on the properties document for each document in the database. The default is true.
Merge Max Size

The maximum size, in megabytes, of a stand that will result from a merge. If a stand grows beyond the specified size, it will not be merged. If two stands would be larger than the specified size if merged, they will not be merged together. If you set this to smaller sizes, large merges (which may require more disk and CPU resources) will be prevented. The default is 48 GB (49152 MB), which is recommended because it provides a good balance between keeping the number of stands low and preventing very large merges from using large amounts of disk space. Set this to 0 to allow any sized stand to merge. Use care when setting this to a non-zero value lower than the default value, as this can prevent merges which are ultimately required for the system to maintain performance levels and to allow optimized updates to the system.

For details on controlling merges, see Understanding and Controlling Database Merges in the Administrator's Guide.

Merge Min RatioA positive integer indicating the minimum ratio between the number of fragments in a stand and the number of fragments in all of the other smaller stands (that is stands with fewer fragments) in the forest. Stands with a fragment count below this ratio relative to all smaller stands are automatically merged with the smaller stands. For an example, see If You Want to Reduce the Number of ‘Large' Merges in the Administrator's Guide.
Merge Min Size

The minimum number of fragments that a stand can contain. Two or more stands with fewer than this number of fragments are automatically merged.

For details on controlling merges, see Understanding and Controlling Database Merges in the Administrator's Guide.

Merge Priority

Specifies the CPU scheduler priority at which merges should run. The settings are:

  • normal -- Specifies the same CPU scheduler priority as for requests.
  • lower -- Specifies a lower CPU scheduler priority than for requests.

Merges always run with normal priority on forests with more than 16 stands.

For details on controlling merges, see Understanding and Controlling Database Merges in the Administrator's Guide.

Merge TimestampThe timestamp stored on merged stands. This is used for point-in-time queries, and determines when space occupied by deleted fragments and old versions of fragments may be reclaimed by the database. If a fragment is deleted or updated at a time after the merge timestamp, then the old version of the fragment is retained for use in point-in-time queries. Set this to 0 (the default) to let the system reclaim the maximum amount of disk space during merge activities. A setting of 0 will remove all deleted and updated fragments when a merge occurs. Set this to 1 before loading or updating any content to create a complete archive of the changes to the database over time. Set this to the current timestamp to preserve all versions of content from this point on. Set this to a negative number to specify a window of timestamp values, relative to the last merge, at ten million ticks per second. The timestamp is a number maintained by MarkLogic Server that increments every time a change occurs in any of the databases in a system (including configuration changes from any host in a cluster). For details on point-in-time queries, see Point-In-Time Queries in the Application Developer's Guide.
One Character SearchesSpecifies whether wildcard searches are enabled so that the search pattern contains a single non-wildcard characters (for example, a*). This index is not needed if you have Three Character Searches and a word lexicon. For details about wildcard searches, see Understanding and Using Wildcard Searches in the Search Developer's Guide.
Phrase Around

Specifies the element markup phrased around in searches. Searches for phrases can skip around element boundaries when a phrase-around is configured for that element. For example, if there is a Phrase Around configured on a <b> tag, then the following XML snippet would not return a match for a search for the phrase 'to be or not to be':

<p>to <b>be</b> or not to be</p> 

The phrase indexer needs to know phrases may cross these markup boundaries at load time and reindex time so that it includes the right information in the indexes supporting phrase search.

Each phrase-around has the following settings:

  • Namespace URI -- The namespace for an element or an attribute.
  • Localname -- The localname for an XML element/attribute.

For more detail, see Phrasing and Element-Word-Query Boundary Control in the Administrator's Guide.

Phrase Through

Specifies the element markup to be phrased through in searches. Searches for phrases can cross element boundaries when a phrase-through is configured for that element. For example, if there is a phrase-through configured on a <b> tag, then the following XML snippet would return a match for a search for the phrase 'to be or not to be':

<p>to <b>be</b> or not to be</p> 

The phrase indexer needs to know phrases may cross these markup boundaries at load time and reindex time so that it includes the right information in the indexes supporting phrase search.

Words contained in text node children of a phrase-through or Element Word Query Through element node match words in a cts:element-word-query for both the element and for the element's parent. If the parent is also a phrase-through or Element Word Query Through element, then the words also match words in a cts:element-word-query for the grandparent.

If you delete a phrase-through, the system will not automatically reindex away the indexed phrase-throughs, even if reindexing is enabled; to reindex deleted phrase-throughs, force a reindex (for example, by clicking the reindex button on the database configuration page).

Each phrase-through has the following settings:

  • Namespace URI -- Specifies the namespace for an element or an attribute.
  • Localname -- Specifies the localname for an XML element/attribute.

For more detail, see Phrasing and Element-Word-Query Boundary Control in the Administrator's Guide.

Positions List Max SizeThe maximum size, in megabytes, of the position list portion of the index for a given term. If the position list size for a given term grows larger than the limit specified, then the position information for that term is discarded. The default value is 256, the minimum value is 1, and the maximum value is 512. For example, position queries (cts:near-query) for frequently occurring words that have reached this limit (words like a, an, the, and so on) are resolved without using the indexes. Even though those types of words are resolved without using the indexes, this limit helps improve performance by making the indexes smaller and more efficient to the data actually loaded in the database.
Preallocate JournalsHas no effect as of MarkLogic, Version 8.0-4.
Preload Mapped DataSpecifies whether memory mapped data (for example, range indexes and word lexicons) is loaded into memory when a forest is mounted to the database. Preloading the memory mapped data improves query performance, but uses more memory, especially if you have a lot of range indexes and/or lexicons. Also, it will cause a lot of disk I/O at database startup time, slowing the system performance during the time the mapped data is read into memory. If you do not preload the mapped data, it will be paged into memory dynamically when a query requests data that needs it, slowing the query response time.
Preload Replica Mapped DataSpecifies whether memory mapped data (for example, range indexes and word lexicons) are loaded immediately into memory when a stand is opened. The setting of preload-replica-mapped-data is ignored if Preload Mapped Data is set to false.
Range Element Attribute Index

The range indexes on attributes in XML elements.

The fields are as follows:

  • Range Value Positions -- Specifies whether index data should be included that speeds up the performance of proximity queries involving range queries. Turn this index off if you are not interested in proximity queries and if you want to conserve disk space and decrease loading time.
  • Parent Namespace URI -- The namespace URI of the parent element.
  • Parent Localname -- The local name of the parent XML element or the name of the parent JSON property.
  • Invalid Values -- Specifies whether server should allow insertion of documents that contain XML elements or JSON properties on which range index is configured and their contents cannot be coerced to the index data type. It can be configured to either ignore or reject. By default server rejects insertion of such documents. However, if a user configures invalid values to ignore, these documents can be inserted. This setting does not change the behavior of queries on invalid values after documents are inserted in the database. Performing an operation on an invalid value at query time can still result in an error.
  • Namespace URI -- The namespace for an element or an attribute.
  • Collation -- The collation to use in the comparison operations.
  • Scalar Type -- The ordered domain for the index. Each of the types correspond with an XQuery type.
  • Localname -- The localname for an XML element/attribute or the name for a JSON property.

For details, see Defining Attribute Range Indexes in the Administrator's Guide.

Range Element Index

The range indexes on XML elements or JSON properties.

The fields are as follows:

  • Range Value Positions -- Specifies whether index data should be included that speeds up the performance of proximity queries involving range queries. Turn this index off if you are not interested in proximity queries and if you want to conserve disk space and decrease loading time.
  • Invalid Values -- Specifies whether server should allow insertion of documents that contain XML elements or JSON properties on which range index is configured and their contents cannot be coerced to the index data type. It can be configured to either ignore or reject. By default server rejects insertion of such documents. However, if a user configures invalid values to ignore, these documents can be inserted. This setting does not change the behavior of queries on invalid values after documents are inserted in the database. Performing an operation on an invalid value at query time can still result in an error.
  • Namespace URI -- The namespace for an element or an attribute.
  • Collation -- The collation to use in the comparison operations.
  • Scalar Type -- The ordered domain for the index. Each of the types correspond with an XQuery type.
  • Localname -- The localname for an XML element/attribute or the name for a JSON property.

For details, see Defining Element Range Indexes in the Administrator's Guide.

Range Index OptimizeSpecifies how range indexes are to be optimized. The values are defined as follows:
  • facet-time -- Range indexes are optimized to minimize the amount of CPU time used.
  • memory-size -- Range indexes are optimized to minimize the amount of memory used.
Rebalancer Enable

Specifies whether rebalancing are automatically performed in the background after configuration settings are changed. When set to true, the database rebalancer automatically redistributes the content across the database forests. When set to false, rebalancing is disabled.

For details, see Configuring the Rebalancer on a Database in the Administrator's Guide.

Rebalancer Throttle

The priority of system resources devoted to rebalancing. Higher numbers give rebalancing a higher priority.

For details, see How the Rebalancer Moves Documents in the Administrator's Guide.

Reindexer Enable

Specifies whether indexes are automatically rebuilt in the background after index configuration settings are changed. When set to true, index configuration changes automatically initiate a background reindexing operation on the entire database. When set to false, any new index settings take effect for future documents loaded into the database; existing documents retain the old settings until they are reloaded or until you set reindexer enabled to true.

For details, see Understanding the Reindexer Enable Settings in the Administrator's Guide.

Reindexer Throttle

The priority of system resources devoted to reindexing. Reindexing occurs in batches, where each batch is approximately 200 fragments. When set to 5 (the default), the reindexer works aggressively, starting the next batch of reindexing soon after finishing the previous batch. When set to 4, it waits longer between batches, when set to 3 it waits longer still, and so on until when it is set to 1, it waits the longest. Therefore, higher numbers give reindexing a higher priority and uses the most system resources.

For details, see Understanding the Reindexer Enable Settings in the Administrator's Guide.

Reindexer TimestampThe timestamp of fragments to force a reindex/refragment operation. If Reindex Enable is set to true, a reindex and refragment operation are done on all fragments in the database that have a timestamp equal to or less than the displayed timestamp. Note that if you restore a database that has a timestamp set, if there are fragments in the restored content that are older than the specified content, they will start to reindex as soon as they are restored.
Retain Until Backup

Specifies whether the deleted fragments are retained since the last full or incremental backup. When enabled, Retain Until Backup supersedes Merge Timestamp. Deleted fragments are not merged until backups are finished, regardless of the Merge Timestamp setting. Enabling Retain Until Backup is same to setting the Merge Timestamp to the timestamp of the last backup.

For more information, see Incremental Backup with Journal Archiving in the Administrator's Guide.

Retired Forest Count

The number of forests used by the database to be retired.

For more information, see Retiring a Forest from the Database in the Administrator's Guide.

Security Database

The security database used by the database.

For more information, see Overview of the Security Database in the Security Guide.

Stemmed SearchesThe level of stemming applied to word searches. Stemmed searches match not only the exact word in the search, but also words that come from the same stem and mean the same thing (for example, a search for be will also match the term is). For details on stemmed searches, see Understanding and Using Stemmed Searches in the Search Developer's Guide.
TF Normalization

Specifies the term-frequency normalization. The values are described as follows:

  • scaled-log -- The default term-frequency normalization, which specifies the maximum scaling of the document based on document size.
  • unscaled-log -- No scaling based on document size.
  • weakest-scaled-log, weakly-scaled-log, moderately-scaled-log, strongly-scaled-log -- Have increasing degrees of scaling in between least and the most scaling.

For more information, see Term Frequency Normalization in the Search Developer's Guide.

Three Character Searches

Specifies whether to enable wildcard searches where the search pattern contains three or more consecutive non-wildcard characters (for example, abc*x, *abc, a?bcd). When combined with a codepoint word lexicon, speeds the performance of any wildcard search (including searches with fewer than three consecutive non-wildcard characters). MarkLogic recommends combining the three character search index with a codepoint collation word lexicon.

For details about wildcard searches, see Understanding and Using Wildcard Searches in the Search Developer's Guide.

Three Character Word Positions

Specifies whether index data should be included in the database files to enable proximity searches (cts:near-query) within wildcard queries. You must also enable Three Character Searches in order to perform wildcard position searches. When set to true, positional searches are possible within a wildcard query, but document loading is slower and the database files are larger.

For details about wildcard searches, see Understanding the Wildcard Indexes in the Search Developer's Guide.

Trailing Wildcard Searches

Specifies whether indexes should be created to enable wildcard searches where the search pattern contains one or more consecutive non-wildcard characters at the beginning of the word, with the wildcard at the end of the word (for example, abc*). When this setting is true, character searches are faster, but document loading is slower and the database files are larger.

For details about wildcard searches, see Understanding and Using Wildcard Searches in the Search Developer's Guide.

Trailing Wildcard Word Positions

Specifies whether index data should be included in the database files to enable proximity searches (cts:near-query) within trailing wildcard queries. You must also enable trailing wildcard searches in order to perform trailing wildcard position searches. When this setting is true, positional searches are possible within a trailing wildcard query, but document loading is slower and the database files are larger.

For details about wildcard searches, see Understanding the Wildcard Indexes in the Search Developer's Guide.

Triple IndexSpecifies whether the RDF triple index is enabled to support SPARQL execution over RDF triples. When set to true, sem:sparql can be used, but document loading is slower and the database files are larger. This index must also be enabled to support Optic and SQL queries.

This feature requires a valid semantics license key.

For details, see Triple Index Overview in the Semantics Developer's Guide.
Triple Positions

Specifies whether index data is included which speeds up the performance of proximity queries that use the cts:triple-range-query function. Triple positions also improve the accuracy of the item-frequency option of cts:triples.

For details, see Triple Positions in the Semantics Developer's Guide.

Two Character Searches

Specifies whether to enable wildcard searches where the search pattern contains two or more consecutive non-wildcard characters (for example, ab*). This index is not needed if you have Three Character Searches and a word lexicon.

For details about wildcard searches, see Understanding and Using Wildcard Searches in the Search Developer's Guide.

URI Lexicon

Specifies whether to create a lexicon of all of the URIs used in a database. The URI lexicon speeds up queries that constrain on URIs. It is like a range index of all of the URIs in the database. To access values from the URI lexicon, use the cts:uris or cts:uri-match APIs.

For details, see URI and Collection Lexicons in the Search Developer's Guide.

Word Positions

Specifies whether index data should be included in the database files to enable proximity searches (cts:near-query). When set to true, positional searches are possible, but document loading is slower and the database files are larger.

For details, see Positions Indexes Can Help Speed Phrase Searches in the Query Performance and Tuning Guide.

Word Searches

Specifies whether index terms should be included in the database files to support fast word searches. When this setting is true, word searches are faster, but document loading is slower and the database files are larger.

For details, see the Search Developer's Guide.

Database Tasks

Use the Tasks tab to get the list of the database tasks.

You can only see the tasks for the databases to which you have access.

The columns displayed in the Database Tasks tab are described in the table below.

ColumnDescription
ClusterCluster on which the task host is located.
HostThe hostname of the host computer on which the scheduled module is to be invoked.
EnabledWhether the task is enabled (true) or disabled (false).
Task RootThe root directory (filesystem) or URI root (database) that contains the module.
Task PathThe module the task is to invoke.
Task TypeThe task type:
  • minutely specifies how many minutes between each invocation of the module.
  • hourly specifies how many hours and minutes between each invocation of the module.
  • daily specifies how many days between each invocation of the module and the time of day (in 24:00 notation).
  • weekly specifies how many weeks between each invocation of the module, check one or more days of the week, and the time of day (in 24:00 notation) for the task to start.
  • monthly specifies how many months between each invocation of the module, select one day of the month (1-31), and the time of day (in 24:00 notation) for the task to start.
  • one-time specifies the start date in MM/DD/YYYY notation (for example, 07/29/2009 for July 29, 2009) and time in 24:00 notation.
Task PeriodHow often the module is to be invoked (every n months, weeks, days, hours, or minutes).
Created onThe datetime the task was created.
DatabaseThe database to which the scheduled module connects for query execution.
Task ModulesThe name of the database in which the scheduled module locates the application code. If set to (file system), then any files in the specified task root directory are executable (given the proper permissions). If set to a database, then any documents in the database whose URI begins with the specified task root directory are executable.
UserThe user with permission to invoke the module.
PriorityThe priority of the task:
  • normal specifies the task should be queued with normal priority.
  • higher specifies the task should be queued with higher priority.

Database Hosts

Use the Hosts tab to get the list of hosts on which the database is deployed. This tab shows host name as the first column, followed by other properties. Click on the host name to navigate to the manage view of the selected host.

Access to hosts is not implicit with database access. You must have explicit access to the hosts to be able to drill down for them. For details, see Role Based Access Control (RBAC) Settings.

The columns displayed in the Database Hosts tab are described in the table below.

ColumnDescription
NameThe hostname of the host.
GroupThe name of the group that contains the host.
OSThe name and version of the operating system on which the host runs.
Server VersionThe version of MarkLogic Server on each host.
ForestsThe number of forests on the host.
DatabasesThe number of databases on the host.
App ServersThe number of App Servers on the host.
Disk Space (MB)The amount of disk space (in MB) used on the host.
UptimeThe duration (Days Hrs:Min) the host has been available.
Maint. ModeThe host maintenance mode (normal or maintenance). For details, see Rolling Upgrades in the Administrator's Guide.
ZoneThe Amazon Web Services (AWS) zone in which the host resides, if applicable. For details, see MarkLogic Server on Amazon EC2 Guide.

Database App Servers

Use the App Servers tab to get the list of all the application servers that use the database, with App Server name as the first column followed by other properties. Click on the App Server name to navigate to the manage view of the selected application server.

Access to App Servers is not implicit with database access. You must have explicit access to the App Servers to be able to drill down for them. For details, see Role Based Access Control (RBAC) Settings.

The columns displayed in the Database App Servers tab are described in the table below.

ColumnDescription
NameThe name of the App Server.
TypeThe App Server type (HTTP, WebDAV, XDBC, ODBC).
DatabaseThe name of the App Server content database.
PortThe port number used to access the App Server.
SSLWhether the App Server has SSL enabled (yes) or disabled (no). For details, see Configuring SSL on App Servers in the Security Guide.
GroupThe name of the group to which the App Server belongs
Modules DB+RootThe name of the modules database, or if filesystem, the root directory.
SecurityThe type of security (internal or external).

Database Forests

Use the Forests tab to get the list of all the forests within the database, with forest name as the first column followed by other properties. Click on the forest name to navigate to the manage view of the selected forest.

The columns displayed in the Database Forests tab are described in the table below.

ColumnDescription
NameThe name of the forest.
HostThe forest host.
DocumentsThe number of documents in the forest.
StatusThe status of the forest. Enabled or Disabled.
AvailabilityThe availability of the forest. Online or Offline.
FragmentsThe number of active fragments (the fragments available to queries) in the forest.
Deleted FragmentsThe number of deleted fragments (the fragments to be removed by the next merge operation) in the forest.
StandsThe number of stands in the forest. For more information on stands, see Databases, Forests, and Stands in the Concepts Guide.
Size (MB)The size of the forest, in MB.
Encrypted Size (MB)The amount of encrypted data in the forest. For details on data encryption, see Encryption at Rest in the Security Guide.
Free Space (MB)The number of MB of free space on this forest.
Large Data Size (MB)The amount of data in the large data directories of the forest. For more information on Large Data, see Working With Binary Documents in the Application Developer's Guide.
Fast Data Size (MB)The amount of data in the fast data directories of the forest. For more information on Fast Data, see Fast Data Directory on Forests in the Query Performance and Tuning Guide.
Failover EnabledWhether failover is enabled for the forest. For more information on stands, see High Availability of Data Nodes With Failover in the Scalability, Availability, and Failover Guide.
ReplicationSpecifies whether or not database replication is enabled for this forest. For details, see the Database Replication Guide.

Manage App Servers Tab

The App Servers tab displays the list of App Servers in your enterprise.

The columns displayed in the Manage App Servers tab are described in the table below.

ColumnDescription
NameThe name of the App Server.
ClusterThe name of the cluster that hosts the App Server.
TypeThe App Server type (HTTP, WebDAV, XDBC, ODBC).
DatabaseThe name of the App Server content database.
PortThe port number used to access the App Server.
SSLWhether the App Server has SSL enabled (yes) or disabled (no). For details, see Configuring SSL on App Servers in the Security Guide.
GroupThe name of the group to which the App Server belongs
Modules DB+RootThe name of the modules database, or if filesystem, the root directory.
SecurityThe type of security (internal or external).

To drill down for a particular App Server, click on the App Server name in the App Servers' table. You will see the following content tabs, each one representing an information category for the selected App Server:

To filter the data used for rendering the graphs, select a pre-defined time period or specify a custom time period, as described in Date and Time Filters.

App Server Metrics

Select a single App Server or all App Servers from the navigation tree. The Metrics tab displays key indicators allowing administrators to determine the selected resource or resource group's health.

The metrics displayed by charts on the App Server Metrics tab are described in the table below.

ChartDefinition of Displayed Metric
App Server Request RateThe total number of queries being processed per second, across all of the App Servers in the cluster.
App Server LatencyThe average time (in seconds) it takes to process queries, across all of the App Servers in the cluster.
Expanded Tree Cache Hits/MissesThe aggregate I/O performance data for the CPUs in the cluster.
NetworkVarious XDQP performance metrics as the sum of XDQP activity across the cluster. (For further detail, see Cluster Metrics.

App Server Information

Use the Information tab to access properties of the selected application server.

The properties displayed in the App Server Information tab are described in the table below.

Most of these properties are described in detail in the HTTP Servers, XDBC Servers, WebDAV Servers, and ODBC Servers chapters in the Administrator's Guide.

FieldDescription
AddressThe IP address for the App Server.
AuthenticationThe authentication scheme used by this App Server. The authentication scheme can be one of: digest, basic, digestbasic, certificate, kerberos-ticket, or application-level. For details, see Types of Authentication in the Security Guide.
BacklogThe maximum number of pending connections allowed on the App Server socket.
CollationThe default collation for queries run in this App Server. This is the collation used for string comparison and sorting if none is specified in the query. For details, see Encodings and Collations in the Search Developer's Guide.
Compute Content LengthSpecifies whether to compute content length when using a webDAV server. A value of true indicates to compute content length; otherwise false.
Concurrent Request LimitThe maximum number of requests any user may have been running at a specific time. 0 indicates no maximum. For details, see Managing Concurrent User Sessions in the Administrator's Guide.
Content DatabaseThe content database for this App Server.
Coordinate SystemThe default coordinate system for queries run in this App Server. This will be the coordinate system used for geospatial operations if none is specified in the query. For details, see Understanding Coordinate Systems in the Search Developer's Guide.
Debug AllowSpecifies whether to allow requests against this App Server to be stopped for debugging, using the MarkLogic Server debugging APIs. A value of true allows the App Server to be stopped; otherwise false.
Default Error Format

The default format for protocol errors for this server. The value can be:

  • html -- Errors formatted as HTML.
  • xml -- Errors formatted as XML.
  • json -- Errors formatted as JSON.
  • compatible -- Match as closely as possible the format used in prior releases for the type of request and error.

For more information, see set-error-format in the Application Developer's Guide.

Default Inference SizeThe amount of memory available to use for semantic inference queries. By default the amount of memory available for inference is 100mb (size=100). For details, see Memory Available for Inference in the Semantics Developer's Guide.
Default Time LimitThe default value for any request's time limit (in seconds), when otherwise unspecified. A request can change its time limit using the xdmp:set-request-time-limit function. The time limit, in turn, is the maximum number of seconds allowed for servicing a query request. The App Server gives up on queries that take longer, and returns an error.
Default UserThe user used as the default user in application-level authentication. Setting the admin user as the default user is equivalent to turning security off. For details, see Application Level in the Security Guide.
Default Xquery VersionThe default XQuery language for this App Server if an XQuery module does explicitly declare its language version.
Display Last LoginSpecifies whether the xdmp:display-last-login API should return true or false in the display-last-login element. For details, see Storing and Monitoring the Last User Login Attempt in the Administrator's Guide.
Distribute TimestampsSpecifies how the latest timestamp is distributed after updates. This affects performance of updates and the timeliness of read-after-write query results from other hosts in the group. The possible values are:
  • fast -- Updates return as quickly as possible. No special timestamp notification messages are broadcasted to other hosts. Instead, timestamps are distributed to other hosts when any other message is sent. The maximum amount of time that could pass before other hosts see the timestamp is one second, because a heartbeat message is sent to other hosts every second.
  • strict -- Updates immediately broadcast timestamp notification messages to every other host in the group. Updates do not return until their timestamp has been distributed. This ensures timeliness of read-after-write query results from other hosts in the group, so requests made to this app server on other hosts in the group will see immediately consistent results.
  • cluster -- Updates immediately broadcast timestamp notification messages to every other host in the cluster. Updates do not return until their timestamp has been distributed. This ensures timeliness of read-after-write query results from any host in the cluster, so requests made to any app server on any host in the cluster will see immediately consistent results.
EnabledWhether this App Server is enabled (true) or disabled (false).
Error HandlerThe page to internally redirect to in case of any 400 or 500 errors. For details, see Controlling App Server Access, Output, and Errors in the Application Developer's Guide.
ExecuteSpecifies whether this App Server executes XQuery modules (for example, a WevDAV server does not). If true, the App Server executes XQuery modules; otherwise false.
File Log LevelThe minimum log level for log messages sent to the MarkLogic Server log file (ErrorLog.txt). For a description of the log levels, see Understanding the Log Levels in the Administrator's Guide.
Group NameThe group to which this App Server belongs. For details on groups, see Groups in the Administrator's Guide.
Internal SecuritySpecifies whether the security database is used for authentication and authorization if the user is found in the security database. If true, use the security database; if false, external authentication/authorization is used. For details, see External Security in the Security Guide.
Keep Alive TimeoutThe maximum number of seconds before a socket receives a timeout for subsequent requests over the same connection.
Log ErrorsSpecifies whether to log uncaught errors for this App Server to the ErrorLog.txt file. This is useful to log exceptions that might occur on an App Server for later debugging. If true, log errors; if false, do not log errors.
Max Inference SizeThe maximum memory limit for semantic inference queries. For details, see Memory Available for Inference in the Semantics Developer's Guide.
Max Time LimitThe upper bound for any request's time limit. No request may set its time limit (for example with xdmp:set-request-time-limit) higher than this number. The time limit, in turn, is the maximum number of seconds allowed for servicing a query request. The App Server gives up on queries which take longer, and returns an error.
Multi Version Concurrency Control

Specifies how the latest timestamp is chosen for lock-free queries. This only affects query statements, not update statements. The following are the possible values:

  • contemporaneous -- App Server chooses the latest timestamp for which any transaction is known to have committed, even though there still may be other transactions for that timestamp that have not yet fully committed. Queries will see more timely results, but may block waiting for contemporaneous transactions to fully commit.
  • nonblocking -- App Server chooses the latest timestamp for which all transactions are known to have committed, even though there may be a slightly later timestamp for which another transaction has committed. Queries won't block waiting for transactions, but they may see less timely results.

For details about queries and transactions in MarkLogic Server, see Understanding Transactions in MarkLogic Server in the Application Developer's Guide.

Output Byte Order Mark

Output Cdata Section Localname

Output Cdata Section Namespace URI

Output Doctype Public

Output Doctype System

Output Encoding

Output Escape URI Attributes

Output Include Content Type

Output Include Default Attributes

Output Indent

Output Indent Tabs

Output Indent Untyped

Output Media Type

Output Method

Output Normalization Form

Output Omit Xml Declaration

Output Sgml Character Entities

Output Standalone

Output Undeclare Prefixes

Output Version

The output options for the App Server.

For details about controlling App Server output, see Controlling App Server Access, Output, and Errors in the Application Developer's Guide and Setting Output Options for an HTTP Server, Setting Output Options for an XDBC Server, Setting Output Options for an ODBC Server, and Setting Output Options for a WebDAV Server in the Administrator's Guide.

For details on setting the serialization options in XQuery, see Declaring Options in the XQuery and XSLT Reference Guide. For XSLT output details, see the XSLT specification (http://www.w3.org/TR/xslt20#serialization).

PortThe port number applications use to access this App Server.
Pre Commit Trigger DepthThe maximum depth (how many triggers can cause other triggers to fire, which in turn cause others to fire, and so on) for pre-commit triggers that are executed against this App Server. For more information on triggers, see Using Triggers to Spawn Actions in the Application Developer's Guide.
Pre Commit Trigger LimitThe maximum number of pre-commit triggers this App Server can invoke for a single statement. For more information on triggers, see Using Triggers to Spawn Actions in the Application Developer's Guide.
PrivilegeThe execute privilege required to access this App Server.
Profile AllowSpecifies whether to allow requests against this App Server to be profiled, using the MarkLogic Server profiling APIs. For details, see Profiling Requests to Evaluate Performance in the Query Performance and Tuning guide.
Request TimeoutThe maximum number of seconds before a socket receives a timeout for the first request.
Rewrite Resolves GloballySpecifies whether to allow rewritten URLs to be resolved from the global MarkLogic/Modules directory or App Server root.
Root

The directory in which programs executed against this App Server are stored. If the Modules field is set to a database, then the root must be a directory URI in the specified modules database.

If the Modules field is set to file system, then the root directory is either a fully-qualified pathname or is relative to the directory in which MarkLogic Server is installed. For details on where the MarkLogic Server is installed by default on your platform, see Installing MarkLogic in the Installation Guide.

Server NameThe name of this App Server.
Server TypeThe App Server type (http, odbc, xdbc, or WebDAV).
Session TimeoutThe maximum number of seconds before an inactive session times out.
SSL Allow SSLv3Specifies whether to allow this App Server to communicate with applications by means of the SSLv3 security protocol.
SSL Allow TLSSpecifies whether to allow this App Server to communicate with applications by means of the TLSv1 security protocol.
SSL CiphersThe SSL ciphers that may be used. For details, see Configuring SSL on App Servers in the Security Guide.
SSL Disable SSLv3Specifies whether to prevent this App Server from communicating with applications by means of the SSLv3 security protocol.
SSL Disable TLSv1Specifies whether to prevent this App Server from communicating with applications by means of the TLSv1 security protocol.
SSL Disable TLSv11Specifies whether to prevent this App Server from communicating with applications by means of the TLSv11 security protocol.
SSL Disable TLSv12Specifies whether to prevent this App Server from communicating with applications by means of the TLSv12 security protocol.
SSL HostnameThe hostname for this App Server's SSL certificate. This is useful when many App Servers are running behind a load balancer. If not specified, each host will use a certificate for its own hostname. For details, see Configuring SSL on App Servers in the Security Guide.
SSL Require Client CertificateSpecifies whether to enable mutual authentication, where the client also holds a digital certificate that it sends to the server. Select which certificate authority is to be used to sign client certificates for the server. For details, see Configuring SSL on App Servers in the Security Guide.
Static ExpiresThe number of seconds before an expires HTTP header is added for static content.
ThreadsThe maximum number of App Server threads.
URL RewriterThe path to the script to run to rewrite URLs. For details, see Setting Up URL Rewriting for an HTTP App Server in the Application Developer's Guide.
WebDAVSpecifies whether this App Server is a WebDAV App Server.

App Server Hosts

Use the Hosts tab to see the host that contains the selected App Server. This tab shows the host name as the first column, followed by other properties. Click on the host name to navigate to the manage view of the host.

The columns displayed in the App Server Hosts tab are described in the table below.

ColumnDescription
NameThe hostname of the host.
GroupThe name of the group that contains the host.
OSThe name and version of the operating system on which the host runs.
Server VersionThe version of MarkLogic Server on the host.
ForestsThe number of forests on the host.
DatabasesThe number of databases on the host.
App ServersThe number of App Servers on the host.
Disk Space (MB)The amount of disk space (in MB) used on the host.
UptimeThe duration (Days Hrs:Min) the host has been available.
Maint. ModeThe host maintenance mode (normal or maintenance). For details, see Rolling Upgrades in the Administrator's Guide.
ZoneThe Amazon Web Services (AWS) zone in which the host resides, if applicable. For details, see MarkLogic Server on Amazon EC2 Guide.

App Server Databases

Use the Databases tab to get the list of databases used by this App Server, with database name as the first column followed by other properties. Click on the database name to navigate to the manage view of the selected database.

The columns displayed in the App Server Databases tab are described in the table below.

ColumnDescription
NameName of the database.
ForestsThe number of forests used by the database.
Disk Size (MB)The amount of disk space used by the database forests, in megabytes.
DocumentsThe number of documents in the database.
Last BackupThe data-time of the last backup of the database. No value, if the database has never been backed up. For details on backing up a database, see Backing Up and Restoring a Database in the Administrator's Guide.
EncryptionSpecifies whether or not encryption at rest should be enabled for the database. For details, see Encryption at Rest in the Security Guide.
HASpecifies whether or not shared disk failover is enabled. For details, see High Availability of Data Nodes With Failover in the Scalability, Availability, and Failover Guide.
ReplicationSpecifies whether or not database replication is enabled. For details, see the Database Replication Guide.
Replication StatusSpecifies whether or not database replication is configured for the database.
Security DBThe name of the security database used by the database. For details, see Administering Security in the Security Guide.
Schemas DBThe name of the schemas database used by the database. For details, see Understanding and Defining Schemas in the Administrator's Guide.
Triggers DBThe name of the schemas database used by the database. For details, see Using Triggers to Spawn Actions in the Application Developer's Guide.

« Previous chapter
Next chapter »
Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy