vectordotdev / vector

A high-performance observability data pipeline.
https://vector.dev
Mozilla Public License 2.0
17.74k stars 1.57k forks source link

Document ability to set a static concurrency for `request.concurrency` #18595

Open jszwedko opened 1 year ago

jszwedko commented 1 year ago

A note for the community

Problem

The documentation for request.concurrency doesn't indicate that you can set a static concurrency limit (a useful feature).

Screenshot 2023-09-18 at 8 43 08 AM

We should fix the docs to document how to set a static concurrency (like request.concurrency = 50).

Configuration

No response

Version

vector v0.32.1

Debug Output

No response

Example Data

No response

Additional Context

No response

References

jszwedko commented 1 year ago

I think this is still an issue as we the changes to document a static concurrency were backed out of https://github.com/vectordotdev/vector/pull/18651

neuronull commented 1 year ago

This seems to be related to how the docs are generated from the code, and the fact that the fixed concurrency isn't actually represented in the enum.

Perhaps a way forward is to add an example to showcase the static usage, which we don't have right now.

We can also see if the auto generation of docs could be improved to handle this use case.

https://github.com/vectordotdev/vector/blob/30a1e2613f63eaeed3e8768ee6423dba568fca4d/src/sinks/util/service/concurrency.rs#L24-L37