Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[OTLP Registry] Document batch size configuration #5578

Closed
joaopgrassi opened this issue Oct 9, 2024 · 1 comment
Closed

[OTLP Registry] Document batch size configuration #5578

joaopgrassi opened this issue Oct 9, 2024 · 1 comment
Labels
doc-update A documentation update registry: otlp OpenTelemetry Protocol (OTLP) registry-related
Milestone

Comments

@joaopgrassi
Copy link
Contributor

Please describe the feature request.
The current docs only mention the step config which is the equivalent to the export interval in OTel SDKs. But I saw that there's also a "batch size" which would also be nice to have in the docs.

Rationale
Usually these two properties go together so I think it's a good idea to demonstrate to users that those options are available.

Additional context
It is common for metric back-ends to have limits on the size or/and the amount of metrics in a single export request. With both the interval and batch size, users can tweak things to make sure their metric requests stay under the limits.

@shakuzen shakuzen added doc-update A documentation update and removed waiting-for-triage labels Oct 10, 2024
@shakuzen shakuzen added this to the 1.12.x milestone Oct 10, 2024
@shakuzen shakuzen added registry: otlp OpenTelemetry Protocol (OTLP) registry-related help wanted An issue that a contributor can help us with labels Oct 10, 2024
@shakuzen
Copy link
Member

Thanks for bringing it to our attention. A pull request would be welcome. As a side note, we have been thinking about ways to keep the docs about configuration options in sync with the code but we haven't implemented anything so far, so these things happen from time to time.

@shakuzen shakuzen modified the milestones: 1.12.x, 1.12.11 Oct 11, 2024
@shakuzen shakuzen removed the help wanted An issue that a contributor can help us with label Oct 11, 2024
@shakuzen shakuzen changed the title [OTLP Registry] Documentation not showing the batch size configuration [OTLP Registry] Document batch size configuration Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-update A documentation update registry: otlp OpenTelemetry Protocol (OTLP) registry-related
Projects
None yet
Development

No branches or pull requests

2 participants