Skip to content

Commit

Permalink
[DOCS] Adds description to pipeline settings.
Browse files Browse the repository at this point in the history
  • Loading branch information
szabosteve committed Aug 16, 2023
1 parent 26350c8 commit f8e4f8a
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions specification/logstash/_types/Pipeline.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,35 @@ export class PipelineMetadata {
}

export class PipelineSettings {
/**
* The number of workers that will, in parallel, execute the filter and output stages of the pipeline.
* @doc_id logstash-logstash-settings-file
*/
'pipeline.workers': integer
/**
* The maximum number of events an individual worker thread will collect from inputs before attempting to execute its filters and outputs.
*/
'pipeline.batch.size': integer
/**
* When creating pipeline event batches, how long in milliseconds to wait for each event before dispatching an undersized batch to pipeline workers.
*/
'pipeline.batch.delay': integer
/**
* The internal queuing model to use for event buffering.
* @doc_id logstash-logstash-settings-file
*/
'queue.type': string
/**
* The total capacity of the queue (`queue.type: persisted`) in number of bytes.
*/
'queue.max_bytes.number': integer
/**
* The total capacity of the queue (`queue.type: persisted`) in terms of units of bytes.
*/
'queue.max_bytes.units': string
/**
* The maximum number of written events before forcing a checkpoint when persistent queues are enabled (`queue.type: persisted`).
*/
'queue.checkpoint.writes': integer
}
export class Pipeline {
Expand Down

0 comments on commit f8e4f8a

Please sign in to comment.