Get machine learning memory usage info
- GET /_ml/memory/{node_id}/_stats
- GET /_ml/memory/_stats
Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM.
- Cluster privileges:
monitor_ml
Path Parameters
-
node_idstring Idoptional -
The names of particular nodes in the cluster to target. For example,
nodeId1,nodeId2orml:trueLeave it out to use
/_ml/memory/_stats.
Query Parameters
-
master_timeoutstring Duration · default: 30s Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
-
timeoutstring Duration · default: 30s Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
Response
-
_nodesNodeStatisticsrequired -
failuresErrorCause -
typestringrequired -
The type of error
-
reasonstringnullable -
A human-readable explanation of the error, in English.
-
stack_tracestring -
The server stack trace. Present only if the
error_trace=trueparameter was sent with the request. -
caused_byErrorCause -
root_causeErrorCause -
suppressedErrorCause -
totalnumberrequired -
Total number of nodes selected by the request.
-
successfulnumberrequired -
Number of nodes that responded successfully to the request.
-
failednumberrequired -
Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.
-
cluster_namestring Namerequired -
nodesmap string to Memoryrequired -
<string>Memory -
attributesmap string to stringrequired -
jvmJvmStatsrequired -
Contains Java Virtual Machine (JVM) statistics for the node.
-
heap_maxnumber | string ByteSize -
Maximum amount of memory available for use by the heap.
-
heap_max_in_bytesnumberrequired -
Maximum amount of memory, in bytes, available for use by the heap.
-
java_inferencenumber | string ByteSize -
Amount of Java heap currently being used for caching inference models.
-
java_inference_in_bytesnumberrequired -
Amount of Java heap, in bytes, currently being used for caching inference models.
-
java_inference_maxnumber | string ByteSize -
Maximum amount of Java heap to be used for caching inference models.
-
java_inference_max_in_bytesnumberrequired -
Maximum amount of Java heap, in bytes, to be used for caching inference models.
-
memMemStatsrequired -
Contains statistics about memory usage for the node.
-
adjusted_totalnumber | string ByteSize -
If the amount of physical memory has been overridden using the es.total_memory_bytes system property then this reports the overridden value. Otherwise it reports the same value as total.
-
adjusted_total_in_bytesnumberrequired -
If the amount of physical memory has been overridden using the
es.total_memory_bytessystem property then this reports the overridden value in bytes. Otherwise it reports the same value astotal_in_bytes. -
totalnumber | string ByteSize -
Total amount of physical memory.
-
total_in_bytesnumberrequired -
Total amount of physical memory in bytes.
-
mlMemMlStatsrequired -
Contains statistics about machine learning use of native memory on the node.
-
anomaly_detectorsnumber | string ByteSize -
Amount of native memory set aside for anomaly detection jobs.
-
anomaly_detectors_in_bytesnumberrequired -
Amount of native memory, in bytes, set aside for anomaly detection jobs.
-
data_frame_analyticsnumber | string ByteSize -
Amount of native memory set aside for data frame analytics jobs.
-
data_frame_analytics_in_bytesnumberrequired -
Amount of native memory, in bytes, set aside for data frame analytics jobs.
-
maxnumber | string ByteSize -
Maximum amount of native memory (separate to the JVM heap) that may be used by machine learning native processes.
-
max_in_bytesnumberrequired -
Maximum amount of native memory (separate to the JVM heap), in bytes, that may be used by machine learning native processes.
-
native_code_overheadnumber | string ByteSize -
Amount of native memory set aside for loading machine learning native code shared libraries.
-
native_code_overhead_in_bytesnumberrequired -
Amount of native memory, in bytes, set aside for loading machine learning native code shared libraries.
-
native_inferencenumber | string ByteSize -
Amount of native memory set aside for trained models that have a PyTorch model_type.
-
native_inference_in_bytesnumberrequired -
Amount of native memory, in bytes, set aside for trained models that have a PyTorch model_type.
-
namestring Namerequired -
Human-readable identifier for the node. Based on the Node name setting setting.
-
rolesstringrequired -
Roles assigned to the node.
-
transport_addressstringrequired -
The host and port where transport HTTP connections are accepted.
-
ephemeral_idstring Idrequired