Module: kamailio
Branch: master
Commit: c31c91fc36dda736b0c19f66ac38b1cc500bfe8b
URL: https://github.com/kamailio/kamailio/commit/c31c91fc36dda736b0c19f66ac38b1c…
Author: Stefan Mititelu <stefan.mititelu(a)net2phone.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2024-09-18T10:01:10+02:00
kafka: Update doc with the new modparams
---
Modified: src/modules/kafka/doc/kafka_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/c31c91fc36dda736b0c19f66ac38b1c…
Patch: https://github.com/kamailio/kamailio/commit/c31c91fc36dda736b0c19f66ac38b1c…
---
diff --git a/src/modules/kafka/doc/kafka_admin.xml b/src/modules/kafka/doc/kafka_admin.xml
index 8ada5e9fe07..666e7c2fc3d 100644
--- a/src/modules/kafka/doc/kafka_admin.xml
+++ b/src/modules/kafka/doc/kafka_admin.xml
@@ -154,6 +154,70 @@ modparam("kafka", "topic", "name=third_topic")
</programlisting>
</example>
</section>
+
+ <section id="kafka.p.init_without_kafka">
+ <title><varname>init_without_kafka</varname> (string)</title>
+ <para>
+ Set to anything but 0, specifies if kamailio starts even when kafka brokers are not available at startup time.
+ </para>
+ <para>
+ Default value is <emphasis>0</emphasis> (disabled).
+ </para>
+ <example>
+ <title>Set <varname>init_without_kafka</varname> parameter</title>
+ <programlisting format="linespecific">
+...
+modparam("kafka", "init_without_kafka", 1)
+...
+ </programlisting>
+ </example>
+ </section>
+
+ <section id="kafka.p.metadata_timeout">
+ <title><varname>metadata_timeout</varname> (string)</title>
+ <para>
+ Specifies, in milliseconds, how much time kamailio waits to get topic metadata info at startup time.
+ </para>
+ <para>
+ Default value is <emphasis>2000 milliseconds</emphasis> (2 seconds).
+ </para>
+ <example>
+ <title>Set <varname>metadata_timeout</varname> parameter</title>
+ <programlisting format="linespecific">
+...
+modparam("kafka", "metadata_timeout", 1000)
+...
+ </programlisting>
+ </example>
+ </section>
+
+ <section id="kafka.p.log_without_overflow">
+ <title><varname>log_without_overflow</varname> (string)</title>
+ <para>
+ Set to anything but 0, will skip logging most of the error messages that may happen to each kafka message sent to the broker.
+ This is useful when e.g. kafka broker goes down, not to overflow syslog with error messages.
+ </para>
+ <para>
+ One can alwyas check this module's stats e.g. via RPC commands and see that errors happened or not.
+ Those errors can have 2 causes:
+ <itemizedlist>
+ <listitem>Some errors happened with the config functions kafka_send()/kafka_send_key(). This means that the message wasn't even enqueued by librdkafka.</listitem>
+ <listitem>Some errors happened on delivery callback, managed by librdkafka. This means that the message was enqueued by librdkafka, but not managed to be delivered to the broker.</listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ Default value is <emphasis>0</emphasis> (disabled).
+ </para>
+ <example>
+ <title>Set <varname>log_without_overflow</varname> parameter</title>
+ <programlisting format="linespecific">
+...
+modparam("kafka", "log_without_overflow", 1)
+...
+ </programlisting>
+ </example>
+ </section>
+
</section>
<section>
<title>Functions</title>
<!-- Kamailio Pull Request Template -->
<!--
IMPORTANT:
- for detailed contributing guidelines, read:
https://github.com/kamailio/kamailio/blob/master/.github/CONTRIBUTING.md
- pull requests must be done to master branch, unless they are backports
of fixes from master branch to a stable branch
- backports to stable branches must be done with 'git cherry-pick -x ...'
- code is contributed under BSD for core and main components (tm, sl, auth, tls)
- code is contributed GPLv2 or a compatible license for the other components
- GPL code is contributed with OpenSSL licensing exception
-->
#### Pre-Submission Checklist
<!-- Go over all points below, and after creating the PR, tick all the checkboxes that apply -->
<!-- All points should be verified, otherwise, read the CONTRIBUTING guidelines from above-->
<!-- If you're unsure about any of these, don't hesitate to ask on sr-dev mailing list -->
- [ ] Commit message has the format required by CONTRIBUTING guide
- [ ] Commits are split per component (core, individual modules, libs, utils, ...)
- [ ] Each component has a single commit (if not, squash them into one commit)
- [ ] No commits to README files for modules (changes must be done to docbook files
in `doc/` subfolder, the README file is autogenerated)
#### Type Of Change
- [ ] Small bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds new functionality)
- [ ] Breaking change (fix or feature that would change existing functionality)
#### Checklist:
<!-- Go over all points below, and after creating the PR, tick the checkboxes that apply -->
- [ ] PR should be backported to stable branches
- [ ] Tested changes locally
- [ ] Related to issue #XXXX (replace XXXX with an open issue number)
#### Description
Small log improvement, in order to make easier to find the origin of redis errors.
Log sample :
```
WARNING: topos_redis [topos_redis_storage.c:834]: tps_redis_load_branch(): invalid redis result type: 6
WARNING: topos [tps_storage.c:626]: tps_storage_record(): no local address - do record routing for all initial requests
ERROR: topos [tps_storage.c:637]: tps_storage_record(): failed to store
```
The root cause is probaly in redis error message and it whould be nice to log it
You can view, comment on, or merge this pull request online at:
https://github.com/kamailio/kamailio/pull/3965
-- Commit Summary --
* topos_redis : show redis error for post mortem analysis
-- File Changes --
M src/modules/topos_redis/topos_redis_storage.c (9)
-- Patch Links --
https://github.com/kamailio/kamailio/pull/3965.patchhttps://github.com/kamailio/kamailio/pull/3965.diff
--
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/pull/3965
You are receiving this because you are subscribed to this thread.
Message ID: <kamailio/kamailio/pull/3965(a)github.com>