Update config pages for 4.3.1.4 - #635
Conversation
There was a problem hiding this comment.
Pull request overview
Updates ThingsBoard PE configuration reference docs to reflect new/updated configuration options associated with the 4.3.1.4 release line.
Changes:
- Expanded database configuration documentation to include Citus (distributed PostgreSQL) settings and related operational sizing notes.
- Added/updated cache-related configuration entries and clarified how Citus affects certain SQL batch threading settings.
- Updated report service Kafka compression documentation to include
lz4.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/content/docs/docs/pe/reference/configuration/report-service-config.mdx | Updates Kafka compression type description to include lz4. |
| src/content/docs/docs/pe/reference/configuration/core-rule-engine-config.mdx | Adds Citus-related database configuration entries and expands cache configuration documentation. |
Suppressed comments (1)
src/content/docs/docs/pe/reference/configuration/core-rule-engine-config.mdx:747
- This sentence now includes newly added Citus details; please also fix capitalization/punctuation to keep the config descriptions consistent and easier to scan.
<p class="config-def-desc">batch thread count has to be a prime number like 3 or 5 to gain perfect hash distribution. When database.citus.enabled=true this is overridden by database.citus.shard_count (see that property for pool sizing)</p>
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| <div class="config-def-item"> | ||
| <p class="config-def-meta"><code class="config-def-env">TB_KAFKA_COMPRESSION_TYPE</code> · <span class="config-def-label">Default</span> <code>none</code></p> | ||
| <p class="config-def-desc">none or gzip</p> | ||
| <p class="config-def-desc">none, gzip or lz4</p> |
There was a problem hiding this comment.
Not actionable in this repo. This page is generated by scripts/generate_config_pages.py, and the description is taken verbatim from the inline comment on tb-report.yml:97 upstream (# none, gzip or lz4). An edit here would be reverted the next time the page is regenerated, so a punctuation change would need to be made in the thingsboard-pe repo.
| ## Database parameters | ||
|
|
||
| <Banner variant="pe">Selects the storage backend (SQL, Cassandra, or TimescaleDB) for time-series and latest telemetry data, and sets the maximum query intervals.</Banner> | ||
| <Banner variant="pe">Selects the storage backend (SQL, Cassandra, or TimescaleDB) for time-series and latest telemetry data and the maximum query intervals,<br /> and configures optional Citus (distributed PostgreSQL) support.</Banner> |
There was a problem hiding this comment.
Fixed in 8df625f — in the generator rather than the page.
These pages are generated by scripts/generate_config_pages.py, and the <br /> was not authored here: generate_section joined every line of the source YAML comment with <br />, so this description (thingsboard.yml:328-329, which merely soft-wraps mid-sentence) got a line break in the middle of the clause. The generator now breaks only at sentence boundaries, and the page was regenerated from release/license/4.3.
| <div class="config-def-item"> | ||
| <p class="config-def-meta"><code class="config-def-env">SQL_ATTRIBUTES_BATCH_THREADS</code> · <span class="config-def-label">Default</span> <code>3</code></p> | ||
| <p class="config-def-desc">batch thread count has to be a prime number like 3 or 5 to gain perfect hash distribution</p> | ||
| <p class="config-def-desc">batch thread count has to be a prime number like 3 or 5 to gain perfect hash distribution. When database.citus.enabled=true this is overridden by database.citus.shard_count (see that property for pool sizing)</p> |
There was a problem hiding this comment.
Same as the lz4 comment: this page is generated, and the description is verbatim from the inline comment on thingsboard.yml:523 upstream (and :536 for the line 747 occurrence). Editing it here would be reverted on the next regeneration.
Worth noting the lowercase style is consistent across all five batch_threads properties upstream, so it reads as deliberate rather than a slip — a change would belong in thingsboard-pe and should cover all five together.
Section banners joined every line of the source YAML comment with <br />, so a comment that merely soft-wraps mid-sentence rendered with a line break in the middle of a clause. A line now continues the previous one unless it starts a new sentence. - Add _join_description_lines to generate_config_pages.py (PR #635) - Regenerate the PE core and rule engine config page from release/license/4.3 Claude-Session: https://claude.ai/code/session_018dTDP6H5jC98e2QFZ5GgXG
Description
Type of change
src/content/docs/**)src/content/_includes/**)src/components/**,src/styles/**)src/pages/**,src/data/**)src/data/redirects.ts)releaseskill)Affected products
Related issues
Checklist
pnpm checkpasses (Astro / TypeScript)pnpm lint:eslintpassespnpm lint:slugcheckpasses (required if pages were added/renamed/moved across languages)pnpm lint:linkcheckpasses locally — required to merge; run it before requesting review (usepnpm lint:linkcheck:nobuildif you already ran a build)src/data/redirects.ts, andpnpm generate:redirectswas runsrc/data/versions.ts