24 April 2018 04:52 PM
This article gives a brief summary of the MarkLogic Telemetry feature available in MarkLogic Server version 9
What is Telemetry used for?
Telemetry is a communication channel between customer's MarkLogic Server instances and the MarkLogic Support team. When enabled, historical configuration, system log and performance data is efficiently collected for immediate access by the Support team who can begin working on your support incident. Having immediate access to this critical system data will often lead to quicker diagnostics and resolution of your logged support incidents.
When Telemetry is enabled, MarkLogic Server collects data locally and periodically uploads it encrypted and anonymised to a secure cloud storage. Data collected locally follows MarkLogic encryption settings and can be reviewed at any time. Telemetry has very low impact on the server performance as it does not require any communication between nodes and it does not depend on any database or index settings. Telemetry does require some local disk space and an SSL connection (Port 443) to access *telemetry.services.marklogic.com.
What is Captured and What is Not
Telemetry data is only collected from:
Telemetry neither collects nor sends application specific logs or customer data.
How to enable
Telemetry can be enabled at any time after MarkLogic 9 is installed through the Admin-UI, Admin-API or Rest interfaces. It is recommended that you enable Telemetry in order to have data uploaded and available before an incident is reported to MarkLogic Technical Support. The following script is an example of how to enable Telemetry from Query Console with recommended settings for all nodes in a cluster:
Telemetry will be enabled during run time (doesn't require a restart) and starts uploading as soon as some data is collected and a connection to *telemetry.services.marklogic.com is established. All configuration settings can be changed at any time and are not dependent on other log level settings. Currently the following data types are configurable:
In addition, Telemetry supports uploading a Support Request on demand to the secure cloud storage. Uploading a Support Request is independent of all configured Telemetry settings as long as a connection to *.telemetry.services.marklogic.com over SSL can be established.
Who has access
Telemetry data is stored at a secured cloud storage using the Cluster-ID as identifier. A Cluster-ID is a randomly generated number during a MarkLogic installation. Access to the data is restricted and requires an open Support Ticket with a provided Cluster-ID. Data will be accessed and downloaded only by the Support Team for the period of time a Support Ticket is open. As soon as the ticket is closed all downloaded data will be destroyed. Data uploaded to the cloud storage will be held for a few month until it is deleted.
More details can be found in the Telemetry (Monitoring MarkLogic Guide) in our documentation.