Docs/kafka settings validation 4389 #248
Open
Conversation
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
- Add missing URL query parameters (offsetReset, consumerTimeout) - Document consumer timeout constraints with validation examples - Add consumer watchdog behavior and configuration - Document TLS requirements and mutual TLS constraints - Expand service usage mappings for all services - Add practical configuration examples (high-throughput, slow processing, low-latency, TLS) - Separate sync vs async producer parameters with correct defaults - Fix mkdocs list rendering with proper blank lines
- Add missing configuration details (pipe-delimited format, PEM format) - Document hardcoded internal settings (PeerBanDuration, DisableRPCVerification) - Add database query parameters (sslmode) and timeout values - Clarify network-specific topic name prefixing behavior - Add auto-generated private key example - Update validation rules with timing and supported schemes Related to #4389
- Remove unused settings (HTTPPublicAddress, HTTPPort) - Add global settings (StatsPrefix, Dashboard.Enabled, P2P.PrivateKey) - Clarify HTTPAddress validation and Centrifuge requirements - Document response signing behavior (non-fatal errors, X-Signature header) - Add validation timing (Init() vs Start()) - Add missing service dependencies (BlockvalidationClient, P2PClient) - Add response signing and stats endpoints examples Related to #4389
- Remove unused LocalDAHCache setting - Add missing MiningCandidateSmartCacheMaxAge setting (10s default) - Clarify GRPCListenAddress startup behavior (service won't start if empty) - Update DoubleSpendWindow to show calculation formula (BlockTime * 6) - Clarify Disabled setting as service-level kill switch - Add hardcoded settings section (5 non-configurable settings) - Add service startup behavior documentation - Enhance mining candidate caching explanation - Update validation rules with timing information Related to #4389
- Remove unused settings (StoreDBTimeoutMillis, InitializeNodeInState, FSMStateRestore) - Clarify GRPCListenAddress is optional (service runs without it) - Update HTTPListenAddress validation timing (fails during Start()) - Update StoreURL validation timing (fails during daemon startup) - Document -localTestStartFromState CLI argument for FSM state - Add validation timing column to rules table - Note FSM restore mode triggered by RPC service, not blockchain setting Related to #4389
- Add missing BlockPersisterEnableDefensiveReorgCheck setting (default: true) - Add Reorg Detection configuration section - Document defensive reorg detection checks behavior - Update configuration examples with new setting Related to #4389
- Fix CatchupChBufferSize default (100, not 10) - Add missing settings: MaxBlocksBehindBlockAssembly, MaxParallelForks, MaxTrackedForks - Add missing settings: NearForkThreshold, FetchLargeBatchSize, FetchNumWorkers - Add missing settings: FetchBufferSize, SubtreeFetchConcurrency, GetBlockTransactionsConcurrency - Update configuration examples with fetch workers setting Related to #4389
- Fix BootstrapAddresses to BootstrapPeers (correct env var: p2p_bootstrap_peers) - Remove non-existent RelayPeers setting - Remove non-existent PeerHealthCheckInterval from validation rules - Remove unimplemented PeerMapMaxSize and PeerMapTTL settings - Add SyncCoordinatorPeriodicEvaluationInterval default (30s) - Mark EnableNAT, EnableMDNS, AllowPrivateIPs as CRITICAL (security/scanning) - Add Network Scanning Prevention section - Update validation rules with network scanning warnings - Update configuration examples Related to #4389
- Add missing OrphanageMaxSize setting (default: 100000) - Clarify BlockHeightRetentionAdjustment and OrphanageTimeout descriptions - Update configuration examples with OrphanageMaxSize Related to #4389
- Add missing QueryPolicyURL setting (default: defaultQueryPolicy) - Add Query Policy section describing query operation configuration - Update validation rules to include QueryPolicyURL - Update complete UTXO store example with QueryPolicyURL Related to #4389
- Fix DBTimeout default (5s, not 30s) - Fix UseExternalTxCache default (true, not false) - Fix PostgresMaxOpenConns default (80, not 100) - Fix MaxMinedRoutines default (128, not 10) - Fix MaxMinedBatchSize default (1024, not 1000) - Add missing circuit breaker settings (SpendWaitTimeout, SpendCircuitBreaker*) - Add missing batcher settings (Increment, SetDAH, Locked, LongestChain, Get) - Add missing pruner settings (PrunerParentUpdate*, PrunerDelete*, PrunerMaxConcurrentOperations) - Fix environment variable names for PostgresMaxOpenConns and VerboseDebug Related to #4389
Contributor
|
🤖 Claude Code Review Status: Complete Current Review: This PR significantly improves Kafka and service settings documentation with expanded descriptions, validation rules, and practical examples. The changes are documentation-only and add valuable context about configuration constraints, service dependencies, and when validations occur. Documentation Quality Improvements:
No issues found. The documentation enhancements provide clearer guidance for operators and developers configuring Teranode services. |
|
sugh01
approved these changes
Dec 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.