MarkLogic

MarkLogic

Agent Check Agent Check

Linux Mac OS Windows OS Supported

Overview

This check monitors MarkLogic through the Datadog Agent. MarkLogic Server is a multi-model database designed to be a data hub for operational and analytical data.

Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.

Installation

The MarkLogic check is included in the Datadog Agent package. No additional installation is needed on your server.

Prepare MarkLogic

Using the API or the Admin interface, create a user for the Datadog Agent with the manage-user role permissions at minimum. If you plan to use the enable_health_service_checks configuration, give the Datadog MarkLogic user at least the manage-admin role.

Using the API
  1. Create the Datadog user by modifying this request with your specific values:

    curl -X POST --anyauth --user <ADMIN_USER>:<ADMIN_PASSWORD> -i -H "Content-Type: application/json" -d '{"user-name": "<USER>", "password": "<PASSWORD>", "roles": {"role": "manage-user"}}' http://<HOSTNAME>:8002/manage/v2/users
    

    Use the correct <ADMIN_USER> and <ADMIN_PASSWORD>, and replace <USER> and <PASSWORD> with the username and password that the Datadog Agent uses. For more information about the endpoint, see the MarkLogic documentation.

  2. To verify the user was created with enough permissions:

    curl -X GET --anyauth --user <USER>:<PASSWORD> -i http://<HOSTNAME>:8002/manage/v2
    
Using the Admin interface
  1. Log into the QConsole with an admin account. By default, the QConsole is available at http://<HOSTNAME>:8000/qconsole.

  2. Select Security as Database and XQuery as query type.

  3. Run this query, replacing <USER> and <PASSWORD> with the ones that the Datadog Agent uses:

    xquery version "1.0-ml";
    import module namespace sec="http://marklogic.com/xdmp/security" at 
        "/MarkLogic/security.xqy";
    
    sec:create-user(
        "<USER>",
        "Datadog Agent user",
        "<PASSWORD>",
        "manage-user",
        (xdmp:permission("security", "read")),
        ("http://marklogic.com/dev_modules"))
       
    

    For more information about the query, see the MarkLogic documentation.

  4. To verify that the user was created with enough permissions, use <USER> and <PASSWORD> to authenticate at http://<HOSTNAME>:8002 (default port).

Configuration

Host

  1. Edit the marklogic.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your MarkLogic performance data. See the sample marklogic.d/conf.yaml file for all available configuration options. For user-related settings in the config file, use the Datadog Agent user you created.

  2. Restart the Agent.

Log collection

Available for Agent versions >6.0

  1. Collecting logs is disabled by default in the Datadog Agent, you need to enable it in datadog.yaml:

    logs_enabled: true
    
  2. Add this configuration block to your marklogic.d/conf.yaml file to start collecting your MarkLogic logs:

      logs:
        - type: file
          path: /var/opt/MarkLogic/Logs/ErrorLog.txt
          source: marklogic
        - type: file
          path: /var/opt/MarkLogic/Logs/80002_AccessLog.txt
          source: marklogic
    

    Change the path value and configure it for your environment. See the sample marklogic.d/conf.yaml file for all available configuration options.

  3. Restart the Agent.

Validation

Run the Agent’s status subcommand and look for marklogic under the Checks section.

Data Collected

Metrics

marklogic.databases.average_forest_size
(gauge)
The average forest size attached to database.
Shown as mebibyte
marklogic.databases.backup_count
(gauge)
The maximum number of forests that are backing up.
Shown as unit
marklogic.databases.backup_read_load
(gauge)
Disk read time threads spent for backup, in proportion to the elapsed time.
marklogic.databases.backup_read_rate
(gauge)
The moving average throughput of reading backup data from disk.
Shown as mebibyte
marklogic.databases.backup_write_load
(gauge)
Disk writing time threads spent for backups, in proportion to the elapsed time.
marklogic.databases.backup_write_rate
(gauge)
The moving average throughput of writing data for backups.
Shown as mebibyte
marklogic.databases.compressed_tree_cache_hit_rate
(gauge)
The average number of hits on the compressed cache.
Shown as hit
marklogic.databases.compressed_tree_cache_miss_rate
(gauge)
The average number of misses on the compressed cache.
Shown as miss
marklogic.databases.data_size
(gauge)
The total size of the database on disk.
Shown as mebibyte
marklogic.databases.database_replication_receive_load
(gauge)
Time threads spent receiving data for database replication, in proportion to the elapsed time.
marklogic.databases.database_replication_receive_rate
(gauge)
The moving average throughput of receiving data for database replication.
Shown as mebibyte
marklogic.databases.database_replication_send_load
(gauge)
Time threads spent sending data for database replication, in proportion to the elapsed time.
marklogic.databases.database_replication_send_rate
(gauge)
The moving average throughput of sending data for database replication.
Shown as mebibyte
marklogic.databases.deadlock_rate
(gauge)
The rate of deadlock occurrances.
Shown as lock
marklogic.databases.deadlock_wait_load
(gauge)
Time threads spent waiting for locks that eventually result in deadlocks in proportion to the elasped time.
marklogic.databases.device_space
(gauge)
The amount of space left on the device.
Shown as mebibyte
marklogic.databases.fast_data_size
(gauge)
The total size of the fast storage on disk.
Shown as mebibyte
marklogic.databases.forests_count
(gauge)
The number of forests for the database.
Shown as unit
marklogic.databases.in_memory_size
(gauge)
The total memory used for the database.
Shown as mebibyte
marklogic.databases.journal_write_load
(gauge)
Journal writing time threads spent in proportion to the elapsed time.
marklogic.databases.journal_write_rate
(gauge)
The moving average of writing data to the journal.
Shown as mebibyte
marklogic.databases.large_binary_cache_hit_rate
(gauge)
The average number of hits on the large binary cache.
Shown as hit
marklogic.databases.large_binary_cache_miss_rate
(gauge)
The average number of misses on the large binary cache.
Shown as miss
marklogic.databases.large_data_size
(gauge)
The total size of the large data on disk.
Shown as mebibyte
marklogic.databases.large_read_load
(gauge)
Disk read time threads spent on large documents, in proportion to the elapsed time.
marklogic.databases.large_read_rate
(gauge)
The moving average throughput of reading large documents from disk.
Shown as mebibyte
marklogic.databases.large_write_load
(gauge)
Disk write time threads spent for large documents, in proportion to the elapsed time.
marklogic.databases.large_write_rate
(gauge)
The moving average throughput of writing data for large documents.
Shown as mebibyte
marklogic.databases.largest_forest_size
(gauge)
The size of largest forest attached to database.
Shown as mebibyte
marklogic.databases.least_remaining_space_forest
(gauge)
The lowest free remaining space size.
Shown as mebibyte
marklogic.databases.list_cache_hit_rate
(gauge)
The average number of hits on the list cache.
Shown as hit
marklogic.databases.list_cache_miss_rate
(gauge)
The average number of misses on the list cache.
Shown as miss
marklogic.databases.merge_count
(gauge)
The maximum number of forests that are merging.
marklogic.databases.merge_read_load
(gauge)
Disk read time threads spent during merge, in proportion to the elapsed time.
marklogic.databases.merge_read_rate
(gauge)
The moving average throughput of reading merge data from disk.
Shown as mebibyte
marklogic.databases.merge_write_load
(gauge)
Disk writing time threads spent for merges, in proportion to the elapsed time.
marklogic.databases.merge_write_rate
(gauge)
The moving average throughput of writing data for merges.
Shown as mebibyte
marklogic.databases.min_capacity
(gauge)
The least capacity for a forest as a percentage.
marklogic.databases.query_read_load
(gauge)
Disk reading time threads spent for a query in proportion to the elapsed time.
marklogic.databases.query_read_rate
(gauge)
The moving average of throughput reading query data from disk.
Shown as mebibyte
marklogic.databases.read_lock_hold_load
(gauge)
Time threads spent holding read locks in proportion to the elapsed time.
marklogic.databases.read_lock_rate
(gauge)
The rate of read lock acquistions.
Shown as mebibyte
marklogic.databases.read_lock_wait_load
(gauge)
Time threads spent waiting to acquire read locks in proportion to the elasped time.
marklogic.databases.reindex_count
(gauge)
The total number of reindexing forests for the database.
marklogic.databases.restore_count
(gauge)
The maximum number of forests that are restoring.
marklogic.databases.restore_read_load
(gauge)
Disk read time threads spent for restores, in proportion to the elapsed time.
marklogic.databases.restore_read_rate
(gauge)
The moving average throughput of reading restore data from disk.
Shown as mebibyte
marklogic.databases.restore_write_load
(gauge)
Disk write time threads spent for restores, in proportion to the elasped time.
marklogic.databases.restore_write_rate
(gauge)
The moving average throughput of writing data for restores.
Shown as mebibyte
marklogic.databases.save_write_load
(gauge)
The moving average of time threads spent writing to in-memory stands, in proportion to the elapsed time.
marklogic.databases.save_write_rate
(gauge)
The moving average of writing data to in-memory stands.
Shown as mebibyte
marklogic.databases.total_load
(gauge)
The sum of the processing load factors.
marklogic.databases.total_merge_size
(gauge)
The total size of active forest merging for the database.
Shown as mebibyte
marklogic.databases.total_rate
(gauge)
The sum of the processing rate factors.
marklogic.databases.triple_cache_hit_rate
(gauge)
The average number of hits on the list cache.
Shown as hit
marklogic.databases.triple_cache_miss_rate
(gauge)
The average number of misses on the list cache.
Shown as miss
marklogic.databases.triple_value_cache_hit_rate
(gauge)
The average number of hits on the list cache.
Shown as hit
marklogic.databases.triple_value_cache_miss_rate
(gauge)
The average number of misses on the list cache.
Shown as miss
marklogic.databases.write_lock_hold_load
(gauge)
Time threads spent holding write locks in proportion to the elapsed time.
marklogic.databases.write_lock_rate
(gauge)
The rate of write lock acquistions.
Shown as lock
marklogic.databases.write_lock_wait_load
(gauge)
Time threads spent waiting to acquire write locks in proportion to the elapsed time.
marklogic.forests.backup_count
(gauge)
The maximum number of forests that are backing up.
Shown as unit
marklogic.forests.backup_read_load
(gauge)
Disk read time threads spent for backup, in proportion to the elapsed time.
marklogic.forests.backup_read_rate
(gauge)
The moving average throughput of reading backup data from disk.
Shown as mebibyte
marklogic.forests.backup_write_load
(gauge)
Disk writing time threads spent for backups, in proportion to the elapsed time.
marklogic.forests.backup_write_rate
(gauge)
The moving average throughput of writing data for backups.
Shown as mebibyte
marklogic.forests.compressed_tree_cache_hit_rate
(gauge)
The average number of hits on the compressed cache.
Shown as hit
marklogic.forests.compressed_tree_cache_miss_rate
(gauge)
The average number of misses on the compressed cache.
Shown as miss
marklogic.forests.compressed_tree_cache_ratio
(gauge)
The compressed cache ratio
Shown as percent
marklogic.forests.current_foreign_master_cluster
(gauge)
The cluster ID coupled with the local cluster.
Shown as unit
marklogic.forests.current_foreign_master_fsn
(gauge)
The ID of the last journal frame received from the foreign master
Shown as unit
marklogic.forests.current_master_fsn
(gauge)
The journal frame ID of the local master
Shown as unit
marklogic.forests.database_replication_receive_load
(gauge)
Time threads spent receiving data for database replication, in proportion to the elapsed time.
marklogic.forests.database_replication_receive_rate
(gauge)
The moving average throughput of receiving data for database replication.
Shown as mebibyte
marklogic.forests.database_replication_send_load
(gauge)
Time threads spent sending data for database replication, in proportion to the elapsed time.
marklogic.forests.database_replication_send_rate
(gauge)
The moving average throughput of sending data for database replication.
Shown as mebibyte
marklogic.forests.deadlock_rate
(gauge)
The rate of deadlock occurrances.
Shown as lock
marklogic.forests.deadlock_wait_load
(gauge)
Time threads spent waiting for locks that eventually result in deadlocks in proportion to the elasped time.
marklogic.forests.device_space
(gauge)
The amount of space left on forest device.
Shown as mebibyte
marklogic.forests.forest_reserve
(gauge)
The amount of space needed for merging.
Shown as mebibyte
marklogic.forests.journal_write_load
(gauge)
Journal writing time threads spent in proportion to the elapsed time.
marklogic.forests.journal_write_rate
(gauge)
The moving average of writing data to the journal.
Shown as mebibyte
marklogic.forests.journals_size
(gauge)
The amount of space the journals take up on disk.
Shown as mebibyte
marklogic.forests.large_binary_cache_hit_rate
(gauge)
The average number of hits on the large binary cache.
Shown as hit
marklogic.forests.large_binary_cache_hits
(gauge)
The number of hits on the large binary cache.
Shown as hit
marklogic.forests.large_binary_cache_miss_rate
(gauge)
The average number of misses on the large binary cache.
Shown as miss
marklogic.forests.large_binary_cache_misses
(gauge)
The number of misses on the large binary cache.
Shown as miss
marklogic.forests.large_data_size
(gauge)
The amount of space large objects take up on disk.
Shown as mebibyte
marklogic.forests.large_read_load
(gauge)
Disk read time threads spent on large documents, in proportion to the elapsed time.
marklogic.forests.large_read_rate
(gauge)
The moving average throughput of reading large documents from disk.
Shown as mebibyte
marklogic.forests.large_write_load
(gauge)
Disk write time threads spent for large documents, in proportion to the elapsed time.
marklogic.forests.large_write_rate
(gauge)
The moving average throughput of writing data for large documents.
Shown as mebibyte
marklogic.forests.list_cache_hit_rate
(gauge)
The average number of hits on the list cache.
Shown as hit
marklogic.forests.list_cache_miss_rate
(gauge)
The average number of misses on the list cache.
Shown as miss
marklogic.forests.list_cache_ratio
(gauge)
The list cache ratio
Shown as percent
marklogic.forests.max_query_timestamp
(gauge)
The largest timestamp a query has run at.
Shown as millisecond
marklogic.forests.max_stands_per_forest
(gauge)
The maximum number of stands for a forest.
Shown as unit
marklogic.forests.merge_count
(gauge)
The maximum number of forests that are merging.
Shown as unit
marklogic.forests.merge_read_load
(gauge)
Disk read time threads spent during merge, in proportion to the elapsed time.
marklogic.forests.merge_read_rate
(gauge)
The moving average throughput of reading merge data from disk.
Shown as mebibyte
marklogic.forests.merge_write_load
(gauge)
Disk writing time threads spent for merges, in proportion to the elapsed time.
marklogic.forests.merge_write_rate
(gauge)
The moving average throughput of writing data for merges.
Shown as mebibyte
marklogic.forests.min_capacity
(gauge)
The least capacity for a forest as a percentage.
Shown as percent
marklogic.forests.nonblocking_timestamp
(gauge)
The most current timestamp for which a query will execute without waiting for transactions to settle.
Shown as millisecond
marklogic.forests.orphaned_binaries
(gauge)
The count of orphaned large binaries.
Shown as item
marklogic.forests.query_read_load
(gauge)
Disk reading time threads spent for a query in proportion to the elapsed time.
marklogic.forests.query_read_rate
(gauge)
The moving average of throughput reading query data from disk.
Shown as mebibyte
marklogic.forests.read_lock_hold_load
(gauge)
Time threads spent holding read locks in proportion to the elapsed time.
marklogic.forests.read_lock_rate
(gauge)
The rate of read lock acquistions.
Shown as lock
marklogic.forests.read_lock_wait_load
(gauge)
Time threads spent waiting to acquire read locks in proportion to the elasped time.
marklogic.forests.restore_count
(gauge)
The maximum number of forests that are restoring.
Shown as unit
marklogic.forests.restore_read_load
(gauge)
Disk read time threads spent for restores, in proportion to the elapsed time.
marklogic.forests.restore_read_rate
(gauge)
The moving average throughput of reading restore data from disk.
Shown as mebibyte
marklogic.forests.restore_write_load
(gauge)
Disk write time threads spent for restores, in proportion to the elasped time.
marklogic.forests.restore_write_rate
(gauge)
The moving average throughput of writing data for restores.
Shown as mebibyte
marklogic.forests.save_write_load
(gauge)
The moving average of time threads spent writing to in_memory stands, in proportion to the elapsed time.
marklogic.forests.save_write_rate
(gauge)
The moving average of writing data to in_memory stands
Shown as mebibyte
marklogic.forests.state_not_open
(gauge)
The number of forests that aren't open.
Shown as unit
marklogic.forests.storage.disk_size
(gauge)
The amount of space the stand takes on disk.
Shown as mebibyte
marklogic.forests.storage.host.capacity
(gauge)
The percentage of storage space that is free.
Shown as percent
marklogic.forests.storage.host.device_space
(gauge)
The amount of space left on forest device.
Shown as mebibyte
marklogic.forests.storage.host.forest_reserve
(gauge)
The amount of space needed for merging.
Shown as mebibyte
marklogic.forests.storage.host.forest_size
(gauge)
The total ordinary storage for forests.
Shown as mebibyte
marklogic.forests.storage.host.large_data_size
(gauge)
The amount of space large objects take up on disk.
Shown as mebibyte
marklogic.forests.storage.host.remaining_space
(gauge)
The total free storage for forests.
Shown as mebibyte
marklogic.forests.total_forests
(gauge)
The total number of forests.
Shown as unit
marklogic.forests.total_load
(gauge)
The sum of the processing load factors.
marklogic.forests.total_rate
(gauge)
The sum of the processing rate factors.
Shown as mebibyte
marklogic.forests.triple_cache_hit_rate
(gauge)
The average number of hits on the list cache.
Shown as hit
marklogic.forests.triple_cache_miss_rate
(gauge)
The average number of misses on the list cache.
Shown as miss
marklogic.forests.triple_value_cache_hit_rate
(gauge)
The average number of hits on the list cache.
Shown as hit
marklogic.forests.triple_value_cache_miss_rate
(gauge)
The average number of misses on the list cache.
Shown as miss
marklogic.forests.write_lock_hold_load
(gauge)
Time threads spent holding write locks in proportion to the elapsed time.
marklogic.forests.write_lock_rate
(gauge)
The rate of write lock acquistions.
Shown as lock
marklogic.forests.write_lock_wait_load
(gauge)
Time threads spent waiting to acquire write locks in proportion to the elapsed time.
marklogic.hosts.backup_read_load
(gauge)
Disk read time threads spent for backup, in proportion to the elapsed time.
marklogic.hosts.backup_read_rate
(gauge)
The moving average throughput of reading backup data from disk.
Shown as mebibyte
marklogic.hosts.backup_write_load
(gauge)
Disk writing time threads spent for backups, in proportion to the elapsed time.
marklogic.hosts.backup_write_rate
(gauge)
The moving average throughput of writing data for backups.
Shown as mebibyte
marklogic.hosts.deadlock_rate
(gauge)
The rate of deadlock occurrances.
Shown as lock
marklogic.hosts.deadlock_wait_load
(gauge)
The total time spent waiting for locks that eventually deadlocked.
Shown as second
marklogic.hosts.external_binary_read_load
(gauge)
Disk read time threads spent on external binary documents, in proportion to the elapsed time.
marklogic.hosts.external_binary_read_rate
(gauge)
Disk read throughput of external binary documents.
Shown as mebibyte
marklogic.hosts.foreign_xdqp_client_receive_load
(gauge)
Time threads spent receiving data for the foreign xdqp client, in proportion to the elapsed time.
marklogic.hosts.foreign_xdqp_client_receive_rate
(gauge)
The moving average throughput of the foreign xdqp client receiving data.
Shown as mebibyte
marklogic.hosts.foreign_xdqp_client_send_load
(gauge)
Time threads spent sending data for the foreign xdqp client, in proportion to the elapsed time.
marklogic.hosts.foreign_xdqp_client_send_rate
(gauge)
The moving average throughput of the foreign xdqp client sending data.
Shown as mebibyte
marklogic.hosts.foreign_xdqp_server_receive_load
(gauge)
Time threads spent receiving data for the foreign xdqp server, in proportion to the elapsed time.
marklogic.hosts.foreign_xdqp_server_receive_rate
(gauge)
The moving average throughput of the foreign xdqp server receiving data.
Shown as mebibyte
marklogic.hosts.foreign_xdqp_server_send_load
(gauge)
Time threads spent sending data for the foreign xdqp server, in proportion to the elapsed time.
marklogic.hosts.foreign_xdqp_server_send_rate
(gauge)
The moving average throughput of the foreign xdqp server sending data.
Shown as mebibyte
marklogic.hosts.journal_write_load
(gauge)
Journal writing time threads spent in proportion to the elapsed time.
marklogic.hosts.journal_write_rate
(gauge)
The moving average of writing data to the journal.
Shown as mebibyte
marklogic.hosts.large_read_load
(gauge)
Disk read time threads spent on large documents, in proportion to the elapsed time.
marklogic.hosts.large_read_rate
(gauge)
The moving average throughput of reading large documents from disk.
Shown as mebibyte
marklogic.hosts.large_write_load
(gauge)
Disk write time threads spent for large documents, in proportion to the elapsed time.
marklogic.hosts.large_write_rate
(gauge)
The moving average throughput of writing data for large documents.
Shown as mebibyte
marklogic.hosts.memory_process_huge_pages_size
(gauge)
The size of huge pages for the MarkLogic process. Available on Linux platform. Sum of Sizes after /anon_hugepage in /proc/[MLpid]/smaps.
Shown as mebibyte
marklogic.hosts.memory_process_rss
(gauge)
The size of Process Resident Size (RSS) for the MarkLogic process
Shown as mebibyte
marklogic.hosts.memory_process_swap_rate
(gauge)
The swap rate for the MarkLogic process.
Shown as page
marklogic.hosts.memory_size
(gauge)
The amount of space the stand takes in memory.
Shown as mebibyte
marklogic.hosts.memory_system_free
(gauge)
The free system memory. MemFree from /proc/meminfo on Linux, ullAvailPhys from GlobalMemoryStatusEx on Windows.
Shown as mebibyte
marklogic.hosts.memory_system_pagein_rate
(gauge)
The page in rate for the system.
Shown as page
marklogic.hosts.memory_system_pageout_rate
(gauge)
The page out rate for the system.
Shown as page
marklogic.hosts.memory_system_swapin_rate
(gauge)
The swap in rate for the system.
Shown as page
marklogic.hosts.memory_system_swapout_rate
(gauge)
The swap out rate for the system.
Shown as page
marklogic.hosts.memory_system_total
(gauge)
The total system memory. MemTotal from /proc/meminfo on Linux, ullTotalPhys from GlobalMemoryStatusEx on Windows.
Shown as mebibyte
marklogic.hosts.merge_read_load
(gauge)
Disk read time threads spent during merge, in proportion to the elapsed time.
marklogic.hosts.merge_read_rate
(gauge)
The moving average throughput of reading merge data from disk.
Shown as mebibyte
marklogic.hosts.merge_write_load
(gauge)
Disk writing time threads spent for merges, in proportion to the elapsed time.
marklogic.hosts.merge_write_rate
(gauge)
The moving average throughput of writing data for merges.
Shown as mebibyte
marklogic.hosts.query_read_load
(gauge)
Disk reading time threads spent for a query in proportion to the elapsed time.
marklogic.hosts.query_read_rate
(gauge)
The moving average of throughput reading query data from disk.
Shown as mebibyte
marklogic.hosts.read_lock_hold_load
(gauge)
Time threads spent holding read locks in proportion to the elapsed time.
marklogic.hosts.read_lock_rate
(gauge)
The rate of read lock acquistions.
Shown as lock
marklogic.hosts.read_lock_wait_load
(gauge)
Time threads spent waiting to acquire read locks in proportion to the elasped time.
marklogic.hosts.restore_read_load
(gauge)
Disk read time threads spent for restores, in proportion to the elapsed time.
marklogic.hosts.restore_read_rate
(gauge)
The moving average throughput of reading restore data from disk.
Shown as mebibyte
marklogic.hosts.restore_write_load
(gauge)
Disk write time threads spent for restores, in proportion to the elasped time.
marklogic.hosts.restore_write_rate
(gauge)
The moving average throughput of writing data for restores.
Shown as mebibyte
marklogic.hosts.save_write_load
(gauge)
The moving average of time threads spent writing to in-memory stands, in proportion to the elapsed time.
marklogic.hosts.save_write_rate
(gauge)
The moving average of writing data to in-memory stands.
Shown as mebibyte
marklogic.hosts.total_cpu_stat_system
(gauge)
Total cpu utilization for system.
Shown as percent
marklogic.hosts.total_cpu_stat_user
(gauge)
Total cpu utilization for user.
Shown as percent
marklogic.hosts.total_hosts
(gauge)
The total number of hosts.
Shown as host
marklogic.hosts.total_hosts_offline
(gauge)
The total number of hosts offline.
Shown as host
marklogic.hosts.total_load
(gauge)
The sum of the processing load factors.
marklogic.hosts.total_rate
(gauge)
The sum of the processing rate factors.
Shown as mebibyte
marklogic.hosts.write_lock_hold_load
(gauge)
Time threads spent holding write locks in proportion to the elapsed time.
marklogic.hosts.write_lock_rate
(gauge)
The rate of write lock acquistions.
Shown as lock
marklogic.hosts.write_lock_wait_load
(gauge)
The total time spent holding write locks.
marklogic.hosts.xdqp_client_receive_load
(gauge)
Time threads spent receiving data for the xdqp client, in proportion to the elapsed time.
marklogic.hosts.xdqp_client_receive_rate
(gauge)
The moving average throughput of the XDQP client receiving data.
Shown as mebibyte
marklogic.hosts.xdqp_client_send_load
(gauge)
Time threads spent sending data for xdqp clients, in proportion to the elapsed time.
marklogic.hosts.xdqp_client_send_rate
(gauge)
The moving average throughput of the xdqp clients sending data.
Shown as mebibyte
marklogic.hosts.xdqp_server_receive_load
(gauge)
Time threads spent receiving data for the xdqp server, in proportion to the elapsed time.
marklogic.hosts.xdqp_server_receive_rate
(gauge)
The moving average throughput of the xdqp server receiving data.
Shown as mebibyte
marklogic.hosts.xdqp_server_send_load
(gauge)
Time threads spent sending data for the xdqp server, in proportion to the elapsed time.
marklogic.hosts.xdqp_server_send_rate
(gauge)
The moving average throughput of the xdqp server sending data.
Shown as mebibyte
marklogic.requests.max_seconds
(gauge)
The maximum length in seconds for the active requests.
Shown as second
marklogic.requests.mean_seconds
(gauge)
The mean length in seconds for the active requests or the open transactions.
Shown as second
marklogic.requests.median_seconds
(gauge)
The median length in seconds for the active requests or the open transactions.
Shown as second
marklogic.requests.min_seconds
(gauge)
The minimum length in seconds for the active requests or the open transactions.
Shown as second
marklogic.requests.ninetieth_percentile_seconds
(gauge)
The length in seconds for the ninetieth percentile of the active requests.
Shown as second
marklogic.requests.query_count
(gauge)
The total number of active query requests.
Shown as query
marklogic.requests.standard_dev_seconds
(gauge)
The standard deviation in seconds for the active requests or the open transactions.
Shown as second
marklogic.requests.total_requests
(gauge)
The total number of active requests.
Shown as request
marklogic.requests.update_count
(gauge)
The total number of active update requests.
Shown as request
marklogic.servers.expanded_tree_cache_hit_rate
(gauge)
The average number of hits on the expanded cache.
Shown as hit
marklogic.servers.expanded_tree_cache_miss_rate
(gauge)
The average number of misses on the expanded cache.
Shown as miss
marklogic.servers.request_count
(gauge)
The rate of a request.
Shown as request
marklogic.servers.request_rate
(gauge)
The total number of requests for the cluster.
Shown as request
marklogic.transactions.max_seconds
(gauge)
The maximum length in seconds for the active transactions.
Shown as second
marklogic.transactions.mean_seconds
(gauge)
The mean length in seconds for the active requests or the open transactions.
Shown as second
marklogic.transactions.median_seconds
(gauge)
The median length in seconds for the active requests or the open transactions.
Shown as second
marklogic.transactions.min_seconds
(gauge)
The minimum length in seconds for the active requests or the open transactions.
Shown as second
marklogic.transactions.ninetieth_percentile_seconds
(gauge)
The length in seconds for the ninetieth percentile of the active requests.
Shown as second
marklogic.transactions.standard_dev_seconds
(gauge)
The standard deviation in seconds for the active requests or the open transactions.
Shown as second
marklogic.transactions.total_transactions
(gauge)
The total number of open transactions.
Shown as transaction

Service Checks

marklogic.can_connect:
Returns CRITICAL if the Agent is enabled to reach the query endpoint. Returns OK otherwise.

marklogic.database.health:
Returns CRITICAL if the database state is critical; WARNING if it is maintenance, offline, or at-risk; and OK otherwise.

marklogic.forest.health:
Returns CRITICAL if the forest state is critical; WARNING if it is maintenance, offline, or at-risk; and OK otherwise.

Events

MarkLogic does not include any events.

Troubleshooting

Need help? Contact Datadog support.