Skip to main content

Monitor MarkLogic Server

Enable telemetry on the Group Configuration page

To enable telemetry from the Admin UI, navigate to the Group Configuration page and set the telemetry levels for logs, metering, configuration, and usage changes.

  1. In the Admin UI, click Groups in the left tree menu.

  2. On the Group Configuration page, scroll down to the Telemetry options.

Each of these types of telemetry can be configured individually. For example, you can configure telemetry for metering and not configure telemetry for log level or config. Select the type and level of MarkLogic telemetry you want to enable (logging, metering, configuration, or usage information) from the drop-down menu next to the option.

  • Telemetry Log Level: Enable and configure the log messages collected by telemetry. Possible values are finest, finer, fine, debug, config, info, notice, warning, error, critical, alert, emergency, or disabled. The default is disabled. A value of “disabled” disables all telemetry use of log data. We recommend setting log level to debug or config, as these values will allow MarkLogic Support to better assist and troubleshoot tickets.

  • Telemetry Metering: Enable telemetry for metering information. Possible values are raw, daily, hourly, or disabled. The default is disabled. A value of “disabled” disables all telemetry use of metering data. We recommend a setting of hourly or daily, as these values will allow MarkLogic Support to better assist and troubleshoot tickets.

  • Telemetry Config: Enable telemetry for any configuration changes in the cluster. Possible values are frequent, infrequent, or disabled. The default is disabled. A value of “disabled” disables all telemetry use of configuration data. We recommend a setting of infrequent, as these values will allow MarkLogic Support to better assist and troubleshoot tickets.

  • Telemetry Usage: Enable telemetry for usage data. Possible values are enabled and disabled. The default is enabled. If enabled, the usage data is collected per host when the server starts/restarts, and every 7 days since. A value of disabled disables all telemetry use of usage data.

Note

The level set for each telemetry setting affects the amount of data collected and has a small impact on storage and network use. Telemetry may use up to a maximum of 20GB of storage in the Stage directory, though typically the volume will be less than 100MB.

  • Telemetry Proxy: The URL of the local telemetry proxy. The proxy URL should start with https://, for example, https://proxy.marklogic.com:8080. If you don't specify the port number, it assumes the proxy server is listening on port 8080.

The system baseline data, which is sent regardless of what type of telemetry is enabled, includes the following information: system data (hostid, clusterid, license) and Standard HTTP Headers added by the system and internet routers (IP address, content type, and so on). Data containing Personally Identifiable Information (PII) is not collected.

So, if telemetry metering is enabled, the Usage and Feature Metrics data will be sent. The actual data in the Usage and Feature Metrics files is very small and consists of two types of data - Usage data (collected once an hour), which includes a few core values like OS, Memory size, License Key, and so on, and Feature Metrics (also collected once an hour), which is a set of name-counter pairs for feature usage.

A feature usage example would be measuring to see if the Optic API is being used. This helps MarkLogic understand the adoption of new features and guide us on how to improve the product.

See Log Files in Administrating MarkLogic Server for more about log files and log level descriptions. See Introduction for more about metering information.

In this section: