Supported telemetry types
The MarkLogic integration supports these telemetry types:Prerequisites
The MarkLogic integration has the following prerequisites:- Make the
MarkLogic Management REST API
reachable from the CXDOT Collector. The default port is
8002. - Create a MarkLogic monitoring user with the
manage-userrole. If you collect database and forest health metrics, assign themanage-adminrole instead. - Configure the Management REST API to accept HTTP Digest or HTTP Basic authentication.
Configure
The MarkLogic integration is enabled by default. You can configure targets either by annotating pods in your Kubernetes cluster or by listing static endpoints in your Helm values. To configure the integration, follow these steps:-
To collect from MarkLogic pods in Kubernetes, add a CXDOT integration annotation to
the pod template. The annotation key must end with the container name, and its value
can reference credentials stored in a Kubernetes Secret in the same namespace. For
example, add the following annotation to your MarkLogic workload:
The Collector replaces
${target.host}with the pod IP address,${target.port.manage}with the container port namedmanage, and${k8s_secret:marklogic-monitor/password}with thepasswordkey of themarklogic-monitorSecret. To allow the Collector to read the Secret, add the pod’s namespace toapiServer.metadataServer.secretAllowlistin the Helm values for your CXDOT Collector. -
Optional: To collect from MarkLogic servers outside your Kubernetes cluster, configure
static targets. In cluster mode, the leader-elected
cluster Collector scrapes static targets. For more information, see
architecture.
Make the password available to the cluster Collector process. For example, add the
following to
values.yamlfor your CXDOT Collector Helm chart:A nonemptyendpointslist disables annotation discovery for that integration instance. The CXDOT Collector collects from only the listed targets. -
Optional: Configure a second integration instance to collect from annotated pods and
static targets at the same time. For example, add the following to
values.yamlfor your CXDOT Collector Helm chart:Themarklogic/externalkey defines a named integration instance for static targets. The baremarklogickey continues to discover pods. Make theMARKLOGIC_PASSWORDenvironment variable available to both Collector processes. -
Optional: Collect database and forest health metrics after you assign the
monitoring user the
manage-adminrole. For example, add the following tovalues.yamlfor your CXDOT Collector Helm chart: -
Optional: Disable the integration. For example, add the following to
values.yamlfor your CXDOT Collector Helm chart:
Validate
To validate the MarkLogic integration, follow these steps:-
In
Live Telemetry Analyzer,
filter for
__name__=cxdot.integration.target.healthandcxdot.integration.name=marklogic. Confirm that each reachable target reports1forcxdot.integration.target.health. A value of0means the Collector hit an error collecting from that target. Theserver.addressandserver.portattributes identify each target. -
In
Metrics Explorer,
run the following query while MarkLogic handles active requests:
Confirm that the query returns a value greater than
0for each target.
Configuration reference
Configure one MarkLogic integration instance with the following settings. In Helm values, place these settings undercollection.cxdot.integrations.marklogic. In a Collector configuration
file, place them under cxdot.integrations.marklogic.
Optional settings
-
enabledType:boolean. Optional. Default:true. Whether to run this MarkLogic integration instance. If true, the Collector collects MarkLogic metrics. If false, the Collector doesn’t run this integration instance. -
endpointsType:array of object. Optional. Default:[]. MarkLogic Management REST API targets. Each entry can contain ahost:portvalue or a full HTTP or HTTPS base URL. When this list isn’t empty, the integration collects from exactly these targets instead of targets found through annotation discovery. -
endpoints[].endpointType:string. Required. MarkLogic Management REST API target as ahost:portvalue or a full HTTP or HTTPS base URL. Ahost:portvalue uses HTTP. -
auth_typeType:string. Optional. Default:digest. Authentication method for the targets inendpoints. Set todigestfor HTTP Digest authentication orbasicfor HTTP Basic authentication. Allowed values:basic,digest. -
usernameType:string. Optional. MarkLogic username for the targets inendpoints. -
passwordType:string. Optional. MarkLogic password for the targets inendpoints. The Collector masks this value in diagnostic output, logs, and errors. -
collection_intervalType:duration. Optional. Default:15s. Time between metric collections from each MarkLogic target. -
timeoutType:duration. Optional. Default:10s. Maximum time allowed to collect metrics from one MarkLogic target. The value must not exceedcollection_interval. -
enable_health_metricsType:boolean. Optional. Default:false. Whether to collect database and forest health states. If true, the integration queries/manage/v2?view=health, and the configured user must have themanage-adminrole. If false, the integration doesn’t query that endpoint or collect database and forest health metrics. -
resource_filtersType:array of object. Optional. Default:[]. The integration collects metrics for a resource only if it matches at least one inclusion rule and no exclusion rule. Exclusion rules take precedence over inclusion rules. -
resource_filters[].resource_typeType:string. Required. MarkLogic resource type to filter. Allowed values:database,forest,host,server. -
resource_filters[].patternType:regex. Required. Go regular expression matched against the resource name from the beginning. -
resource_filters[].includeType:boolean. Optional. Default:true. Whether matching resources are eligible for per-resource metric collection. If true, matching resources are eligible. If false, matching resources are excluded. -
resource_filters[].groupType:string. Optional. Default: empty string. Match only resources in this MarkLogic group. Leave empty to match resources in every group. -
tlsType:object. Optional. TLS certificate and client authentication settings for HTTPS MarkLogic Management REST API targets. -
tls.ca_fileType:string. Optional. Path to a PEM-encoded certificate authority (CA) certificate file used to verify the MarkLogic server certificate. If omitted, the Collector uses the system certificate authority pool. -
tls.ca_pemType:string. Optional. PEM-encoded certificate authority certificate content used to verify the MarkLogic server certificate. -
tls.cert_fileType:string. Optional. Path to the PEM-encoded client certificate file to present when the MarkLogic target requires mutual TLS authentication. -
tls.cert_pemType:string. Optional. PEM-encoded client certificate content to present when the MarkLogic target requires mutual TLS authentication. -
tls.cipher_suitesType:array of string. Optional. TLS cipher suites that the Collector can use, in preference order. If omitted, the Collector uses the secure defaults from the Go TLS library. For supported names, see https://go.dev/src/crypto/tls/cipher_suites.go. -
tls.curve_preferencesType:array of string. Optional. Elliptic curves that the Collector can use for an elliptic curve Diffie-Hellman ephemeral handshake, in preference order. If omitted, the Collector uses the Go TLS library defaults. -
tls.include_system_ca_certs_poolType:boolean. Optional. Whether to add certificates from the system certificate authority pool to the configured certificate authorities. If true, the Collector trusts both sources. If false, the Collector trusts only the configured certificate authorities. -
tls.insecureType:boolean. Optional. Whether to disable transport security. If true, the Collector uses an unencrypted connection. If false, the endpoint scheme controls whether the connection uses TLS. -
tls.insecure_skip_verifyType:boolean. Optional. Whether to skip verification of the MarkLogic server certificate. If true, the connection is encrypted but isn’t authenticated and is vulnerable to man-in-the-middle attacks. If false, the Collector verifies the certificate. -
tls.key_fileType:string. Optional. Path to the PEM-encoded client private key file used withcert_filefor mutual TLS authentication. -
tls.key_pemType:string. Optional. PEM-encoded client private key content used withcert_pemfor mutual TLS authentication. -
tls.max_versionType:string. Optional. Maximum TLS protocol version the Collector can use. If omitted, the Collector uses the maximum version supported by the Go TLS library. -
tls.min_versionType:string. Optional. Minimum TLS protocol version the Collector can use. If omitted, the minimum version is TLS 1.2. -
tls.reload_intervalType:duration. Optional. How often the Collector reloads certificate and key files. If omitted, the Collector doesn’t reload the files. -
tls.server_name_overrideType:string. Optional. Server name to verify in the MarkLogic certificate instead of the endpoint hostname. Use this setting when the certificate name differs from the endpoint hostname. -
tls.tpmType:object. Optional. Trusted platform module settings for the TLS private key. -
tls.tpm.authType:string. Optional. Authorization value for the trusted platform module key. -
tls.tpm.enabledType:boolean. Optional. Whether to use a trusted platform module for the TLS private key. If true, the Collector loads the key from the configured device or socket. If false, the Collector uses the configured key file or in-memory key. -
tls.tpm.owner_authType:string. Optional. Owner authorization value for the trusted platform module. -
tls.tpm.pathType:string. Optional. Path to the trusted platform module device or Unix domain socket, such as/dev/tpm0or/dev/tpmrm0.