IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Monitoring APIs Plugins Info API »
Elastic Docs ›Logstash Reference [5.3] ›Monitoring APIs

Node Info API

edit

Node Info API

edit

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

The node info API retrieves information about the node.

GET /_node/<types>

Where <types> is optional and specifies the types of node info you want to return.

You can limit the info that’s returned by combining any of the following types in a comma-separated list:

pipeline

Gets pipeline-specific information and settings.

os

Gets node-level info about the OS.

jvm

Gets node-level JVM info, including info about threads.

See Common Options for a list of options that can be applied to all Logstash monitoring APIs.

Pipeline Info

edit

The following request returns a JSON document that shows pipeline info, such as the number of workers, batch size, and batch delay:

GET /_node/pipeline

If you want to view additional information about the pipeline, such as stats for each configured input, filter, or output stage, see the Pipeline Stats section under the Node Stats API.

Example response:

{
  "pipeline": {
    "workers": 8,
    "batch_size": 125,
    "batch_delay": 5,
    "config_reload_automatic": true,
    "config_reload_interval": 3

  }

OS Info

edit

The following request returns a JSON document that shows the OS name, architecture, version, and available processors:

GET /_node/os

Example response:

{
  "os": {
    "name": "Mac OS X",
    "arch": "x86_64",
    "version": "10.12.1",
    "available_processors": 8
  }

JVM Info

edit

The following request returns a JSON document that shows node-level JVM stats, such as the JVM process id, version, VM info, memory usage, and info about garbage collectors:

GET /_node/jvm

Example response:

{
  "jvm": {
    "pid": 59616,
    "version": "1.8.0_65",
    "vm_name": "Java HotSpot(TM) 64-Bit Server VM",
    "vm_version": "1.8.0_65",
    "vm_vendor": "Oracle Corporation",
    "start_time_in_millis": 1484251185878,
    "mem": {
      "heap_init_in_bytes": 268435456,
      "heap_max_in_bytes": 1037959168,
      "non_heap_init_in_bytes": 2555904,
      "non_heap_max_in_bytes": 0
    },
    "gc_collectors": [
      "ParNew",
      "ConcurrentMarkSweep"
    ]
  }
}
« Monitoring APIs Plugins Info API »