Home

/logstash/pipelines/list

Returns the list of pipelines and their metrics in the logstash.

Request
GET http://unravel-host:3000/api/v1/logstash/pipelines/list?start_time=(date}&end_time={date}"
Path parameters

None.

Query parameters

Name

Type

Description

start_time

string

Start date for report.

Format: YYYY-MM-DD

end_time

string

End date for report.

Format: YYYY-MM-DD

Response body

Name

Type

Description

array

 

name

string

Name of the pipeline.

nodes

array

List of node names.

config_reload_interval

sec

Time interval that specifies how often Logstash checks the config files for changes in the pipeline (in seconds).

pipeline_batch_size

int

Maximum number of events that an individual worker thread collects before executing filters and outputs.

pipeline_duration_in_millis

ms

pipeline_num_events_filtered

int

Current number of events that are filtered.

pipeline_num_events_events_in

int

Total events flowing into the selected pipeline,

pipeline_num_events_out

int

Total events flowing out of the selected pipeline,

pipeline_num_workers

int

Number of threads that are run for filtering and output processing.

queue_type_memory

string

reload_failures

int

Total number of reload failures.

Example

Request:

curl -X GET "http://node.mycompany.com:3000/api/v1/logstash/pipelines/list?start_time=2020-01-01&end_time=2020-04-01" -H  "accept: application/json" -H  "Authorization: JWT JWT token

Response:

[  
 {    
  "name": "main",    
  "nodes": [      
    "node41.mycompany.com##9600##main"     
   ],    
  "config_reload_interval": 3000000000,    
  "pipeline_batch_size": 125,    
  "pipeline_duration_in_millis": 0,    
  "pipeline_num_events_filtered": 0,    
  "pipeline_num_events_in": 0,    
  "pipeline_num_events_out": 0,    
  "pipeline_num_workers": 16,    
  "queue_type_memory": "memory",    
  "reload_failures": 0,    
  "reload_successes": 0  
 }
]
In this section: