docs: batching mode for Prometheus Remote Write protocol#2392
Open
docs: batching mode for Prometheus Remote Write protocol#2392
Conversation
### Add batching mode for Prometheus Remote Write - **Configuration Updates**: Enhanced `[prom_store]` section in `configuration.md` to include new batching options such as `pending_rows_flush_interval`, `max_batch_rows`, `max_concurrent_flushes`, `worker_channel_capacity`, and `max_inflight_requests`. - **Documentation Enhancements**: Added detailed descriptions for new batching mode options in `prometheus.md` to improve ingestion throughput. - **Localization**: Updated Chinese documentation in `configuration.md` and `prometheus.md` to reflect new batching mode features and options. Signed-off-by: Lei, HUANG <mrsatangel@gmail.com>
Deploying greptime-docs with
|
| Latest commit: |
b0ed3d2
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://efed87ad.greptime-docs.pages.dev |
| Branch Preview URL: | https://docs-prom-batching.greptime-docs.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates GreptimeDB documentation to describe the new Prometheus Remote Write batching mode and its configuration, including localized (zh) docs, to address #2375.
Changes:
- Added a “Batching mode” section to Prometheus Remote Write performance tuning docs (EN + ZH), describing behavior and listing new tuning knobs.
- Extended
[prom_store]configuration examples and option tables (EN + ZH) with batching-related parameters and defaults. - Added cross-links from configuration docs to the new batching-mode documentation sections.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/user-guide/ingest-data/for-observability/prometheus.md | Documents batching mode behavior and batching-related [prom_store] options (EN). |
| docs/user-guide/deployments-administration/configuration.md | Adds batching-related [prom_store] keys to the sample config and option reference table (EN). |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-observability/prometheus.md | Chinese localization of batching mode section and option table (ZH). |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/configuration.md | Chinese localization of [prom_store] batching config keys and reference table (ZH). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
evenyag
reviewed
Apr 7, 2026
Signed-off-by: Lei, HUANG <mrsatangel@gmail.com>
fengjiachun
reviewed
Apr 8, 2026
Contributor
|
@codex review |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4ac1cb04ef
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Remove duplicate entry in Prometheus documentation - Removed a duplicate description for `max_inflight_requests` in `prometheus.md`. Signed-off-by: Lei, HUANG <mrsatangel@gmail.com>
This file contains hidden or 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
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.
What's Changed in this PR
closes #2375
Add batching mode for Prometheus Remote Write
[prom_store]section inconfiguration.mdto include new batching options such aspending_rows_flush_interval,max_batch_rows,max_concurrent_flushes,worker_channel_capacity, andmax_inflight_requests.prometheus.mdto improve ingestion throughput.configuration.mdandprometheus.mdto reflect new batching mode features and options.Checklist
sidebars.tsmatches the current document structure when you changed the document structure.