This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Search pipeline metrics

To view search pipeline metrics, use the Nodes Stats API:

  1. GET /_nodes/stats/search_pipeline

copy

The response contains statistics for all search pipelines:

  1. {
  2.   "_nodes" : {
  3.     "total" : 1,
  4.     "successful" : 1,
  5.     "failed" : 0
  6.   },
  7.   "cluster_name" : "runTask",
  8.   "nodes" : {
  9.     "CpvTK7KuRD6Oww8TTp8g2Q" : {
  10.       "timestamp" : 1689007282929,
  11.       "name" : "runTask-0",
  12.       "transport_address" : "127.0.0.1:9300",
  13.       "host" : "127.0.0.1",
  14.       "ip" : "127.0.0.1:9300",
  15.       "roles" : [
  16.         "cluster_manager",
  17.         "data",
  18.         "ingest",
  19.         "remote_cluster_client"
  20.       ],
  21.       "attributes" : {
  22.         "testattr" : "test",
  23.         "shard_indexing_pressure_enabled" : "true"
  24.       },
  25.       "search_pipeline" : {
  26.         "total_request" : {
  27.           "count" : 5,
  28.           "time_in_millis" : 158,
  29.           "current" : 0,
  30.           "failed" : 0
  31.         },
  32.         "total_response" : {
  33.           "count" : 2,
  34.           "time_in_millis" : 1,
  35.           "current" : 0,
  36.           "failed" : 0
  37.         },
  38.         "pipelines" : {
  39.           "public_info" : {
  40.             "request" : {
  41.               "count" : 3,
  42.               "time_in_millis" : 71,
  43.               "current" : 0,
  44.               "failed" : 0
  45.             },
  46.             "response" : {
  47.               "count" : 0,
  48.               "time_in_millis" : 0,
  49.               "current" : 0,
  50.               "failed" : 0
  51.             },
  52.             "request_processors" : [
  53.               {
  54.                 "filter_query:abc" : {
  55.                   "type" : "filter_query",
  56.                   "stats" : {
  57.                     "count" : 1,
  58.                     "time_in_millis" : 0,
  59.                     "current" : 0,
  60.                     "failed" : 0
  61.                   }
  62.                 }
  63.               },
  64.               {
  65.                 "filter_query" : {
  66.                   "type" : "filter_query",
  67.                   "stats" : {
  68.                     "count" : 4,
  69.                     "time_in_millis" : 2,
  70.                     "current" : 0,
  71.                     "failed" : 0
  72.                   }
  73.                 }
  74.               }
  75.             ],
  76.             "response_processors" : [ ]
  77.           },
  78.           "guest_pipeline" : {
  79.             "request" : {
  80.               "count" : 2,
  81.               "time_in_millis" : 87,
  82.               "current" : 0,
  83.               "failed" : 0
  84.             },
  85.             "response" : {
  86.               "count" : 2,
  87.               "time_in_millis" : 1,
  88.               "current" : 0,
  89.               "failed" : 0
  90.             },
  91.             "request_processors" : [
  92.               {
  93.                 "script" : {
  94.                   "type" : "script",
  95.                   "stats" : {
  96.                     "count" : 2,
  97.                     "time_in_millis" : 86,
  98.                     "current" : 0,
  99.                     "failed" : 0
  100.                   }
  101.                 }
  102.               },
  103.               {
  104.                 "filter_query:abc" : {
  105.                   "type" : "filter_query",
  106.                   "stats" : {
  107.                     "count" : 1,
  108.                     "time_in_millis" : 0,
  109.                     "current" : 0,
  110.                     "failed" : 0
  111.                   }
  112.                 }
  113.               },
  114.               {
  115.                 "filter_query" : {
  116.                   "type" : "filter_query",
  117.                   "stats" : {
  118.                     "count" : 3,
  119.                     "time_in_millis" : 0,
  120.                     "current" : 0,
  121.                     "failed" : 0
  122.                   }
  123.                 }
  124.               }
  125.             ],
  126.             "response_processors" : [
  127.               {
  128.                 "rename_field" : {
  129.                   "type" : "rename_field",
  130.                   "stats" : {
  131.                     "count" : 2,
  132.                     "time_in_millis" : 1,
  133.                     "current" : 0,
  134.                     "failed" : 0
  135.                   }
  136.                 }
  137.               }
  138.             ]
  139.           }
  140.         }
  141.       }
  142.     }
  143.   }
  144. }

For descriptions of each field in the response, see the Nodes Stats search pipeline section.