diff options
| author |   mpriyank <priyank.maheshwari@est.tech> | 2024-12-19 10:48:12 +0000 |
|---|---|---|
| committer | mpriyank <priyank.maheshwari@est.tech> | 2024-12-19 12:22:44 +0000 |
| commit | c4b060846b8e1c12c73f1e5b2209c333379d32f0 (patch) | |
| tree | b35b8c6ff46c092c4784449b0b6a4c10a5be6c0a | |
| parent | 764c8e07c355ed976724b347eeb2487a70815592 (diff) | |
RTD docs for async use case
- Documented the suggestion to tune the kafka parameter for the case
when client provides a non existent topic for the async batch usecase.
Issue-ID: CPS-2069
Change-Id: I93e1b3006c901b6b4fc3a61df16d3cb82e6c9906
Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
| -rw-r--r-- | docs/ncmp-data-operation.rst | 7 | ||||
| -rw-r--r-- | docs/release-notes.rst | 1 |
2 files changed, 7 insertions, 1 deletions
diff --git a/docs/ncmp-data-operation.rst b/docs/ncmp-data-operation.rst index 3352e03cf0..f2f3a476bb 100644 --- a/docs/ncmp-data-operation.rst +++ b/docs/ncmp-data-operation.rst @@ -21,6 +21,13 @@ For all data operations on cm handle(s), we have a post endpoint: - When asynchronous (with topic) operations are executed, a request id (UUID) will be returned. +**Note.** The client topic is validated to ensure it adheres to Kafka's topic naming conventions. Additionally, if a client specifies a topic that does not exist, the request might be delayed. To enable a fail-fast mechanism, the max.block.ms parameter can be adjusted to define the maximum duration the request is allowed to block. The parameter is 60000ms by default but can be set to a lower value. + +.. code:: bash + + spring.kafka.producer.properties.max.block.ms: <value_in_ms> + + Request Body ============ diff --git a/docs/release-notes.rst b/docs/release-notes.rst index d60c2c0d73..9c825e4d35 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -38,7 +38,6 @@ Release Data Bug Fixes --------- - Features -------- |