Add pipeline metrics to Node Stats API #16839
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add fields to display the number of workers, batch size, and batch delay for each pipeline
|
📃 DOCS PREVIEW ✨ https://logstash_bk_16839.docs-preview.app.elstc.co/diff |
donoghuc
reviewed
Jan 3, 2025
donoghuc
reviewed
Jan 3, 2025
There was a problem hiding this comment.
In general I dont understand the top level pipeline in the response. I verified that setting pipeine specific ones reports them correctly, but it is unclear to me what the top level one is indicating. Can you point me to what that actually is meant to describe? Essentially my question becomes, why do we have the top level one when it seems to me that the pipeline specific ones would be the only ones users would care about.
➜ /tmp curl "localhost:9600/_node/stats/pipelines?pretty"
{
"host" : "cass-MacBook-Pro.local",
"version" : "9.0.0",
"http_address" : "127.0.0.1:9600",
"id" : "452565a1-ab4f-4e85-8fcc-320d88338092",
"name" : "cass-MacBook-Pro.local",
"ephemeral_id" : "de2cb434-ccf7-48fa-994b-d347aed1107a",
"snapshot" : null,
"status" : "green",
"pipeline" : {
"workers" : 12,
"batch_size" : 125,
"batch_delay" : 50
},
💛 Build succeeded, but was flaky
Failed CI Steps
History
|
|
@donoghuc The top level |
|
|
📃 DOCS PREVIEW ✨ https://logstash_bk_16839.docs-preview.app.elstc.co/diff |
donoghuc
approved these changes
Jan 3, 2025
There was a problem hiding this comment.
Thanks for the background info!
Local test summary:
Set the global defaults and pipeline specifics
➜ myconfig git:(7756d471b2) ✗ tree
.
├── logstash.yml
├── pipeline1.conf
├── pipeline2.conf
└── pipelines.yml
1 directory, 4 files
➜ myconfig git:(7756d471b2) ✗ cat logstash.yml
pipeline.batch.size: 50
pipeline.batch.delay: 10
pipeline.workers: 1
➜ myconfig git:(7756d471b2) ✗ cat pipeline1.conf
input {
generator {
count => -1
message => "pipeline 1"
}
}
output {
null { }
}
➜ myconfig git:(7756d471b2) ✗ cat pipeline2.conf
input {
generator {
count => -1
message => "pipeline 2"
}
}
output {
null { }
}
➜ myconfig git:(7756d471b2) ✗ cat pipelines.yml
- pipeline.id: pipeline1
pipeline.workers: 2
pipeline.batch.size: 100
pipeline.batch.delay: 25
path.config: "myconfig/pipeline1.conf"
- pipeline.id: pipeline2
pipeline.workers: 4
pipeline.batch.size: 200
pipeline.batch.delay: 50
path.config: "myconfig/pipeline2.conf"Verfiied new objects in response:
➜ /tmp curl "localhost:9600/_node/stats/pipelines?pretty"
{
"host" : "cass-MacBook-Pro.local",
"version" : "9.0.0",
"http_address" : "127.0.0.1:9600",
"id" : "452565a1-ab4f-4e85-8fcc-320d88338092",
"name" : "cass-MacBook-Pro.local",
"ephemeral_id" : "aeae5a67-85dd-4a8d-b2c9-d16843a3c9eb",
"snapshot" : null,
"status" : "green",
"pipeline" : {
"workers" : 1,
"batch_size" : 50,
"batch_delay" : 10
},
"pipelines" : {
"pipeline2" : {
"events" : {
"filtered" : 4000,
"queue_push_duration_in_millis" : 13,
"out" : 4000,
"duration_in_millis" : 5,
"in" : 4712
},
"flow" : {
"filter_throughput" : {
"current" : 10500.0,
"lifetime" : 10500.0
},
"worker_utilization" : {
"current" : 0.3721,
"lifetime" : 0.3721
},
"output_throughput" : {
"current" : 11890.0,
"lifetime" : 11890.0
},
"worker_concurrency" : {
"current" : 0.01487,
"lifetime" : 0.01487
},
"input_throughput" : {
"current" : 12180.0,
"lifetime" : 12180.0
},
"queue_backpressure" : {
"current" : 0.03219,
"lifetime" : 0.03219
}
},
"plugins" : {
"inputs" : [ {
"id" : "7e09fb2522de763eb167fe43ecd7a192d82416aede0fd485c1820d57abffdc7b",
"events" : {
"queue_push_duration_in_millis" : 13,
"out" : 4932
},
"flow" : {
"throughput" : {
"current" : 12230.0,
"lifetime" : 12230.0
}
},
"name" : "generator"
} ],
"codecs" : [ {
"id" : "plain_80d41067-014a-446c-ab5f-694e12cfa279",
"encode" : {
"writes_in" : 0,
"duration_in_millis" : 0
},
"decode" : {
"writes_in" : 4951,
"out" : 4951,
"duration_in_millis" : 131
},
"name" : "plain"
}, {
"id" : "plain_a6cf75ca-c0e4-4abc-a88c-66ec2d3201c4",
"encode" : {
"writes_in" : 0,
"duration_in_millis" : 0
},
"decode" : {
"writes_in" : 0,
"out" : 0,
"duration_in_millis" : 0
},
"name" : "plain"
} ],
"filters" : [ ],
"outputs" : [ {
"id" : "69d48260d0e48d9a8577a91b9ad999ed17deeaf4b3b1c169eea3dd32cc927a35",
"events" : {
"out" : 4800,
"duration_in_millis" : 3,
"in" : 4800
},
"flow" : {
"worker_utilization" : {
"current" : 0.1858,
"lifetime" : 0.1858
},
"worker_millis_per_event" : {
"current" : 6.25E-4,
"lifetime" : 6.25E-4
}
},
"name" : "null"
} ]
},
"reloads" : {
"last_success_timestamp" : null,
"last_error" : null,
"last_failure_timestamp" : null,
"successes" : 0,
"failures" : 0
},
"queue" : {
"type" : "memory",
"events_count" : 0,
"queue_size_in_bytes" : 0,
"max_queue_size_in_bytes" : 0
},
"pipeline" : {
"workers" : 4,
"batch_size" : 200,
"batch_delay" : 50
},
"hash" : "ff6948030e96ca0426aff281ee72d82345076a1c513cffb24e69b2989ffd880b",
"ephemeral_id" : "bfe7776e-d25a-4e5c-8396-41709a7c3536"
},
"pipeline1" : {
"events" : {
"filtered" : 4800,
"queue_push_duration_in_millis" : 13,
"out" : 4800,
"duration_in_millis" : 11,
"in" : 4984
},
"flow" : {
"filter_throughput" : {
"current" : 11850.0,
"lifetime" : 11850.0
},
"worker_utilization" : {
"current" : 1.359,
"lifetime" : 1.359
},
"output_throughput" : {
"current" : 12090.0,
"lifetime" : 12090.0
},
"worker_concurrency" : {
"current" : 0.02716,
"lifetime" : 0.02716
},
"input_throughput" : {
"current" : 12310.0,
"lifetime" : 12310.0
},
"queue_backpressure" : {
"current" : 0.03208,
"lifetime" : 0.03208
}
},
"plugins" : {
"inputs" : [ {
"id" : "c76ae1baefa2272a5504e9d9e2d12552d18e6416190ed95fd645dd97b6b9ac0d",
"events" : {
"queue_push_duration_in_millis" : 12,
"out" : 5001
},
"flow" : {
"throughput" : {
"current" : 12360.0,
"lifetime" : 12360.0
}
},
"name" : "generator"
} ],
"codecs" : [ {
"id" : "plain_d1ad6a62-949f-4ccb-8e76-12adb2529bbd",
"encode" : {
"writes_in" : 0,
"duration_in_millis" : 0
},
"decode" : {
"writes_in" : 0,
"out" : 0,
"duration_in_millis" : 0
},
"name" : "plain"
}, {
"id" : "plain_9e7004b7-26e8-4c14-ba82-1e85e77014a2",
"encode" : {
"writes_in" : 0,
"duration_in_millis" : 0
},
"decode" : {
"writes_in" : 5006,
"out" : 5006,
"duration_in_millis" : 128
},
"name" : "plain"
} ],
"filters" : [ ],
"outputs" : [ {
"id" : "d4efe72c7aa3e2243d1e28cee8ac128ded032b501094f62c7977e936ad66e583",
"events" : {
"out" : 4900,
"duration_in_millis" : 6,
"in" : 4900
},
"flow" : {
"worker_utilization" : {
"current" : 0.7414,
"lifetime" : 0.7414
},
"worker_millis_per_event" : {
"current" : 0.001224,
"lifetime" : 0.001224
}
},
"name" : "null"
} ]
},
"reloads" : {
"last_success_timestamp" : null,
"last_error" : null,
"last_failure_timestamp" : null,
"successes" : 0,
"failures" : 0
},
"queue" : {
"type" : "memory",
"events_count" : 0,
"queue_size_in_bytes" : 0,
"max_queue_size_in_bytes" : 0
},
"pipeline" : {
"workers" : 2,
"batch_size" : 100,
"batch_delay" : 25
},
"hash" : "60845191f973ae51eb5c7e8a85f2e94dbb00704ec22a7e3c299c0a6a966ffdc8",
"ephemeral_id" : "5e765276-65aa-4441-84b8-406990dca509"
}
}
}
|
@logstashmachine backport 8.x |
github-actions bot
pushed a commit
that referenced
this pull request
Jan 3, 2025
This commit introduces three new metrics per pipeline in the Node Stats API:
- workers
- batch_size
- batch_delay
```
{
...
pipelines: {
main: {
events: {...},
flow: {...},
plugins: {...},
reloads: {...},
queue: {...},
pipeline: {
workers: 12,
batch_size: 125,
batch_delay: 5,
},
}
}
...
}
```
(cherry picked from commit de6a6c5)
5 tasks
kaisecheng
added a commit
that referenced
this pull request
Jan 3, 2025
This commit introduces three new metrics per pipeline in the Node Stats API:
- workers
- batch_size
- batch_delay
```
{
...
pipelines: {
main: {
events: {...},
flow: {...},
plugins: {...},
reloads: {...},
queue: {...},
pipeline: {
workers: 12,
batch_size: 125,
batch_delay: 5,
},
}
}
...
}
```
(cherry picked from commit de6a6c5)
Co-authored-by: kaisecheng <[email protected]>
|
@logstashmachine backport 8.17 |
github-actions bot
pushed a commit
that referenced
this pull request
Jan 7, 2025
This commit introduces three new metrics per pipeline in the Node Stats API:
- workers
- batch_size
- batch_delay
```
{
...
pipelines: {
main: {
events: {...},
flow: {...},
plugins: {...},
reloads: {...},
queue: {...},
pipeline: {
workers: 12,
batch_size: 125,
batch_delay: 5,
},
}
}
...
}
```
(cherry picked from commit de6a6c5)
5 tasks
kaisecheng
added a commit
that referenced
this pull request
Jan 7, 2025
This commit introduces three new metrics per pipeline in the Node Stats API:
- workers
- batch_size
- batch_delay
```
{
...
pipelines: {
main: {
events: {...},
flow: {...},
plugins: {...},
reloads: {...},
queue: {...},
pipeline: {
workers: 12,
batch_size: 125,
batch_delay: 5,
},
}
}
...
}
```
(cherry picked from commit de6a6c5)
Co-authored-by: kaisecheng <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Release notes
Added three pipeline metrics, workers, batch size and batch delay, to the Node Stats API
What does this PR do?
Add pipeline metrics to Node Stats API
This commit introduces three new metrics under each pipeline in the Node Stats API:
Example response from
curl localhost:9600/_node/stats/Why is it important/What is the impact to the user?
Prior to this change, the /_node/stats only displayed the default pipeline configuration in the global namespace. Pipelines with custom configurations were not represented.
Checklist
Author's Checklist
How to test this PR locally
case 1
case 2
Related issues
Use cases
Screenshots
Logs