User Tools

Site Tools


cookbooks:devel:core

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
cookbooks:devel:core [2019/10/31 18:26]
henningw
cookbooks:devel:core [2020/06/19 10:35]
linuxmaniac [Kamailio SIP Server v5.4.x (devel): Core Cookbook]
Line 1: Line 1:
-====== Kamailio SIP Server v5.4.x (devel): Core Cookbook ======+====== Kamailio SIP Server v5.5.x (devel): Core Cookbook ======
  
 ===== Overview ===== ===== Overview =====
Line 1058: Line 1058:
 ==== listen ==== ==== listen ====
  
-Set the network addresses the SIP server should listen to. It can be an IP address, hostname or network iterface id or combination of protocol:address:port (e.g., udp:10.10.10.10:5060). This parameter can be set multiple times in same configuration file, the server listening on all addresses specified.+Set the network addresses the SIP server should listen to. It can be an IP address, hostname or network interface id or combination of protocol:address:port (e.g., udp:10.10.10.10:5060). This parameter can be set multiple times in same configuration file, the server listening on all addresses specified.
  
 Example of usage: Example of usage:
Line 1073: Line 1073:
  
 <code c> <code c>
-    listen=udp:[2a02:1850:1:1::13]:5060+    listen=udp:[2a02:1850:1:1::18]:5060
 </code> </code>
  
Line 1079: Line 1079:
  
 <code c> <code c>
-    listen=udp:10.10.10.10:5060 advertise  11.11.11.11:5060+    listen=udp:10.10.10.10:5060 advertise 11.11.11.11:5060
 </code> </code>
  
Line 1085: Line 1085:
  
 A typical use case for advertise address is when running SIP server behind a NAT/Firewall, when the local IP address (to be used for bind) is different than the public IP address (to be used for advertising). A typical use case for advertise address is when running SIP server behind a NAT/Firewall, when the local IP address (to be used for bind) is different than the public IP address (to be used for advertising).
 +
 +A unique name can be set for sockets to simplify the selection of the socket for sending out. For example, the rr and path modules can use the socket name to advertise it in header URI parameter and use it as a shortcut to select the corresponding socket for routing subsequent requests.
 +
 +The name has to be provided as a string enclosed in between quotes after the **name** identifier.
 +
 +<code c>
 +    listen=udp:10.0.0.10:5060 name "s1"
 +    listen=udp:10.10.10.10:5060 advertise 11.11.11.11:5060 name "s2"
 +    listen=udp:10.10.10.20:5060 advertise "mysipdomain.com" name "s3"
 +    listen=udp:10.10.10.30:5060 advertise "mysipdomain.com" name "s4"
 +    ...
 +    $fsn = "s4";
 +    t_relay();
 +</code>
 +
 +Note that there is no internal check for uniqueness of the socket names, the admin has to ensure it in order to be sure the desired socket is selected, otherwise the first socket with a matching name is used.
 ==== loadmodule ==== ==== loadmodule ====
  
Line 1333: Line 1349:
 It can be set via config reload framework. It can be set via config reload framework.
  
-Default is (disabled).+Default is (enabled).
  
 <code c> <code c>
Line 1527: Line 1543:
 ==== route_locks_size ==== ==== route_locks_size ====
  
-Set the number of mutex locks to be used for synchronizing the execution of messages sharing the same Call-Id. In other words, enables Kamailio to execute sequentially the requests and replies received within the same dialog -- a new message received within the same dialog waits until the previous one is routed out.+Set the number of mutex locks to be used for synchronizing the execution of config script for messages sharing the same Call-Id. In other words, enables Kamailio to execute the config script sequentially for the requests and replies received within the same dialog -- a new message received within the same dialog waits until the previous one is routed out.
  
-For smaller impact on parallel processing, its value it should be at least twice the number of kamailio processes (children+For smaller impact on parallel processing, its value it should be at least twice the number of Kamailio processes (all children processes).
  
 Example: Example:
Line 1536: Line 1552:
 route_locks_size = 256 route_locks_size = 256
 </code> </code>
 +
 +Note that ordering of the SIP messages can still be changed by network transmission (quite likely for UDP, especially on long distance paths) or CPU allocation for processes when executing pre-config and post-config tasks (very low chance, but not to be ruled out completely).
 ==== server_id ==== ==== server_id ====
  
Line 1579: Line 1597:
 ==== sip_warning (noisy feedback) ==== ==== sip_warning (noisy feedback) ====
  
-Can be 0 or 1. If set to 1 (default value) a 'Warning' header is added to each reply generated by Kamailio.+Can be 0 or 1. If set to 1 (default value is 0) a 'Warning' header is added to each reply generated by Kamailio.
 The header contains several details that help troubleshooting using the network traffic dumps, but might reveal details of your network infrastructure and internal SIP routing. The header contains several details that help troubleshooting using the network traffic dumps, but might reveal details of your network infrastructure and internal SIP routing.
  
Line 1662: Line 1680:
  
  
 +==== stats_name_separator ====
  
 +Specify the character used as a separator for the internal statistics' names. 
 +Default value is "_".
  
 +Example of usage:
 +
 +    stats_name_separator = "-"
  
 ==== tos ==== ==== tos ====
Line 2636: Line 2660:
  
 Force to send the message from the specified socket (it _must_ be one of the sockets specified with the "listen" directive). If the protocol doesn't match (e.g. UDP message "forced" to a TCP socket) the closest socket of the same protocol is used. Force to send the message from the specified socket (it _must_ be one of the sockets specified with the "listen" directive). If the protocol doesn't match (e.g. UDP message "forced" to a TCP socket) the closest socket of the same protocol is used.
 +
 +This function does not support pseudo-variables, use the set_send_socket function from the corex module instead.
  
 Example of usage: Example of usage:
Line 3152: Line 3178:
 ==== failure_route ==== ==== failure_route ====
  
-Failed transaction routing block. It contains a set of actions to be taken each transaction th+Failed transaction routing block. It contains a set of actions to be taken each transaction that received only negative replies (>=300) for all branches. The 'failure_route' is executed only by TM module after it was armed via t_on_failure("failure_route_index"). 
 + 
 +Note that in 'failure_route' is processed the request that initiated the transaction, not the reply . 
 + 
 + 
 +Example of usage: 
 + 
 +<code c> 
 +    request_route { 
 +        lookup("location"); 
 +        t_on_failure("TOVOICEMAIL"); 
 +        if(!t_relay()) { 
 +            sl_send_reply("500", "relaying failed"); 
 +        } 
 +    } 
 +    failure_route[TOVOICEMAIL] { 
 +        if(is_method("INVITE")) { 
 +             # call failed - relay to voice mail 
 +             t_relay_to_udp("voicemail.server.com","5060"); 
 +        } 
 +    } 
 +</code> 
 + 
 +==== reply_route ==== 
 + 
 +Main SIP response (reply) handling block - it contains a set of actions to be executed for SIP replies. It is executed for all replies received from the network. 
 + 
 +It does not have a name and it is executed by the core, before any other module handling the SIP reply. It is triggered only by SIP replies received on the network. 
 + 
 +There is no network route that can be enforced for a SIP reply - it is sent based on Via header, according to SIP RFC3261 - therefore no dedicated actions for forwarding the reply must be used in this block. 
 + 
 +This routing block is optional, if missing, the SIP reply is sent to the address in 2nd Via header. 
 + 
 +One can decide to drop a SIP reply by using **drop** action. 
 + 
 +Example: 
 + 
 +<code c> 
 +reply_route { 
 +  if(status=="128") { 
 +    drop; 
 +  } 
 +
 +</code> 
 + 
 +<fc #4682b4>Note: for backward compatibility reasons, the main 'reply' routing block can be also identified by 'onreply_route {...}' or 'onreply_route[0] {...}'.</fc> 
 + 
 +==== onreply_route ==== 
 + 
 + 
 +SIP reply routing block executed by **tm** module. It contains a set of actions to be taken for SIP replies in the contect of an active transaction. 
 + 
 +The 'onreply_route' must be armed for the SIP requests whose replies should be processed within it, via t_on_reply("onreply_route_index"). 
 + 
 +Core 'reply_route' block is executed before a possible **tm** 'onreply_route' block. 
 + 
 +<code c> 
 +  request_route { 
 +      lookup("location"); 
 +      t_on_reply("LOGRPL"); 
 +      if(!t_relay()) { 
 +          sl_send_reply("500", "relaying failed"); 
 +      } 
 +  } 
 + 
 +  reply_route { 
 +      if(!t_check_trans()) { 
 +          drop; 
 +      } 
 +  } 
 + 
 +  onreply_route[LOGRPL] { 
 +      if(status=~"1[0-9][0-9]") { 
 +           log("provisional response\n"); 
 +      } 
 +  } 
 +</code> 
 +==== onsend_route ==== 
 + 
 +The route is executed in when a SIP request is sent out. Only a limited number of commands are allowed (drop, if + all the checks, msg flag manipulations, send(), log(), textops::search()). 
 + 
 +In this route the final destination of the message is available and can be checked (with snd_ip, snd_port, to_ip, to_port, snd_proto, snd_af). 
 + 
 +This route is executed only when forwarding requests - it is not executed for replies, retransmissions, or locally generated messages (e.g. via fifo uac). 
 + 
 +Example: 
 + 
 +<code c> 
 +  onsend_route { 
 +    if(to_ip==1.2.3.4 && !isflagset(12)){ 
 +      log(1, "message blocked\n"); 
 +      drop; 
 +    } 
 +  } 
 +</code> 
 + 
 +  * snd_ip, snd_port - behave like src_ip/src_port, but contain the ip/port Kamailio will use to send the message 
 +  * to_ip, to_port - like above, but contain the ip/port the message will be sent to (not to be confused with dst_ip/dst_port, which are the destination of the original received request: Kamailio's ip and port on which the message was received) 
 +  * snd_proto, snd_af - behave like proto/af but contain the protocol/address family that Kamailio will use to send the message 
 +  * msg:len - when used in an onsend_route, msg:len will contain the length of the message on the wire (after all the changes in the script are applied, Vias are added a.s.o) and not the lentgh of the original message. 
 + 
 +==== event_route ==== 
 + 
 +Generic type of route executed when specific events happen. 
 + 
 +Prototype: event_route[groupid:eventid] 
 +  * groupid - should be the name of the module that triggers the event 
 +  * eventid - some meaningful short text describing the event 
 + 
 +=== Core Event Routes === 
 + 
 +Implementations: 
 + 
 +  * **event_route[core:worker-one-init]** - executed by core after the first udp sip worker process executed the child_init() for all modules, before starting to process sip traffic 
 +    * note that due to forking, other sip workers can get faster to listening for sip traffic 
 + 
 +<code c> 
 +event_route[core:worker-one-init] { 
 +        xlog("L_INFO","Hello world\n"); 
 +
 +</code> 
 + 
 +  * **event_route[core:msg-received]** - executed when a message is received from the network. It runs with a faked request and makes available the $rcv(key) variables to access what was received and related attribtues. 
 +    * it has to be enabled with received_route_mode global parameter. For usage via Kemi, set kemi.received_route_callback global parameter. 
 +    * if drop is executed, the received message is no longer processed 
 + 
 +<code c> 
 +event_route[core:msg-received] { 
 +  xlog("rcv on $rcv(af)/$rcv(proto): ($rcv(len)) [$rcv(buf)] from [$rcv(srcip):$rcv(srcport)] to [$rcv(rcvip):$rcv(rcvport)]\n"); 
 +  if($rcv(srcip) == "1.2.3.4") { 
 +    drop; 
 +  } 
 +
 +</code> 
 +=== Module Event Routes === 
 + 
 +Here are only a few examples, to see if a module exports event_route blocks and when they are executed, check the readme of the module. 
 + 
 + 
 +  * **event_route[htable:mod-init]** - executed by **htable** module after all modules have been initialised. Good for initialising values in hash tables. 
 +<code c> 
 +modparam("htable", "htable", "a=>size=4;"
 + 
 +event_route[htable:mod-init] { 
 +  $sht(a=>calls-to::10.10.10.10) = 0; 
 +  $sht(a=>max-calls-to::10.10.10.10) = 100; 
 +
 + 
 +request_route { 
 +  if(is_method("INVITE") && !has_totag()) 
 +  { 
 +    switch($rd) { 
 +      case "10.10.10.10": 
 +        lock("calls-to::10.10.10.10"); 
 +        $sht(a=>calls-to::10.10.10.10) = 
 +            $sht(a=>calls-to::10.10.10.10) + 1; 
 +        unlock("calls-to::10.10.10.10"); 
 +        if($sht(a=>calls-to::10.10.10.10)>$sht(a=>max-calls-to::10.10.10.10)) 
 +        { 
 +           sl_send_reply("500", "To many calls to .10"); 
 +           exit; 
 +        } 
 +      break; 
 +      ... 
 +    } 
 +  } 
 +
 +</code> 
 +  * **event_route [tm:local-request]** - executed on locally generated requests. 
 +<code c> 
 +event_route [tm:local-request] { # Handle locally generated requests 
 +  xlog("L_INFO", "Routing locally generated $rm to <$ru>\n"); 
 +  t_set_fr(10000, 10000); 
 +
 +</code> 
 + 
 +  * **event_route [tm:branch-failure]** - executed on all failure responses. 
 +<code c> 
 +request_route { 
 +    ... 
 +    t_on_branch_failure("myroute"); 
 +    t_relay(); 
 +
 + 
 +event_route[tm:branch-failure:myroute] { 
 +  xlog("L_INFO", "Handling $T_reply_code response to $rm to <$ru>\n"); 
 +  if (t_check_status("430")) { # Outbound flow failed 
 +    unregister("location", "$tu", "$T_reply_ruid"); 
 +    if (t_next_contact_flow()) { 
 +      t_relay(); 
 +    } 
 +  } 
 +
 + 
 +</code> 
 + 
 +===== Script Statements ===== 
 + 
 +==== if ==== 
 +IF-ELSE statement 
 + 
 +Prototype: 
 + 
 +<code> 
 +    if(expr) { 
 +       actions; 
 +    } else { 
 +       actions; 
 +    } 
 +</code> 
 + 
 +The 'expr' should be a valid logical expression. 
 + 
 +The logical operators that can be used in 'expr': 
 + 
 +<code> 
 +  ==      equal 
 +  !=      not equal 
 +  =~      regular expression matching: Note: Posix regular expressions will be used, e.g. use [[:digit:]]{3} instead of \d\d\d 
 +  !~      regular expression not-matching (NOT PORTED from Kamailio 1.x, use '!(x =~ y)') 
 +  >       greater 
 +  >=      greater or equal 
 +  <       less 
 +  <=      less or equal 
 +  &&      logical AND 
 +  ||      logical OR 
 +  !       logical NOT 
 +  [ ... ] test operator - inside can be any arithmetic expression 
 +</code> 
 + 
 +Example of usage: 
 + 
 +    if(is_method("INVITE")) 
 +    { 
 +        log("this sip message is an invite\n"); 
 +    } else { 
 +        log("this sip message is not an invite\n"); 
 +    } 
 + 
 + 
 +==== switch ==== 
 + 
 +SWITCH statement - it can be used to test the value of a pseudo-variable.  
 + 
 +IMPORTANT NOTE: 'break' can be used only to mark the end of a 'case' branch (as it is in shell scripts). If you are trying to use 'break' outside a 'case' block the script will return error -- you must use 'return' there. 
 + 
 + 
 +Example of usage: 
 +<code> 
 +    route { 
 +        route(1); 
 +        switch($retcode) 
 +        { 
 +            case -1: 
 +                log("process INVITE requests here\n"); 
 +            break; 
 +            case 1: 
 +                log("process REGISTER requests here\n"); 
 +            break; 
 +            case 2: 
 +            case 3: 
 +                log("process SUBSCRIBE and NOTIFY requests here\n"); 
 +            break; 
 +            default: 
 +                log("process other requests here\n"); 
 +       } 
 + 
 +        # switch of R-URI username 
 +        switch($rU) 
 +        { 
 +            case "101": 
 +                log("destination number is 101\n"); 
 +            break; 
 +            case "102": 
 +                log("destination number is 102\n"); 
 +            break; 
 +            case "103": 
 +            case "104": 
 +                log("destination number is 103 or 104\n"); 
 +            break; 
 +            default: 
 +                log("unknown destination number\n"); 
 +       } 
 +    } 
 + 
 +    route[1]{ 
 +        if(is_method("INVITE")) 
 +        { 
 +            return(-1); 
 +        }; 
 +        if(is_method("REGISTER")) 
 +            return(1); 
 +        } 
 +        if(is_method("SUBSCRIBE")) 
 +            return(2); 
 +        } 
 +        if(is_method("NOTIFY")) 
 +            return(3); 
 +        } 
 +        return(-2); 
 +    } 
 +</code> 
 + 
 +NOTE: take care while using 'return' - 'return(0)' stops the execution of the script. 
 + 
 + 
 +==== while ==== 
 + 
 +while statement 
 + 
 +Example of usage: 
 +     
 +    $var(i) = 0; 
 +    while($var(i) < 10) 
 +    { 
 +        xlog("counter: $var(i)\n"); 
 +        $var(i) = $var(i) + 1; 
 +    } 
 + 
 +===== Script Operations ===== 
 + 
 +Assignments together with string and arithmetic operations can be done directly in configuration file. 
 +==== Assignment ==== 
 + 
 +Assignments can be done like in C, via '=' (equal). The following pseudo-variables can be used in left side of an assignment: 
 +  * Unordered List Item AVPs - to set the value of an AVP 
 +  * script variables ($var(...)) -  to set the value of a script variable 
 +  * shared variables ($shv(...)) 
 +  * $ru - to set R-URI 
 +  * $rd - to set domain part of R-URI 
 +  * $rU - to set user part of R-URI 
 +  * $rp - to set the port of R-URI 
 +  * $du - to set dst URI 
 +  * $fs - to set send socket 
 +  * $br - to set branch 
 +  * $mf - to set message flags value 
 +  * $sf - to set script flags value 
 +  * $bf - to set branch flags value 
 + 
 +<code> 
 +$var(a) = 123; 
 +</code> 
 + 
 +For avp's there a way to remove all values and assign a single value in one statement (in other words, delete existing AVPs with same name, add a new one with the right side value). This replaces the := assignment operator from kamailio < 3.0. 
 +<code> 
 +$(avp(i:3)[*]) = 123; 
 +$(avp(i:3)[*]) = $null; 
 +</code> 
 + 
 +==== String Operations ==== 
 +For strings, '+' is available to concatenate. 
 + 
 +<code> 
 +$var(a) = "test"; 
 +$var(b) = "sip:" + $var(a) + "@" + $fd; 
 +</code> 
 +==== Arithmetic Operations ==== 
 + 
 +For numbers, one can use: 
 +  * + : plus 
 +  * - : minus 
 +  * / : divide 
 +  * * : multiply 
 +  * % : modulo (Kamailio uses 'mod' instead of '%'
 +  * | : bitwise OR 
 +  * & : bitwise AND 
 +  * ^ : bitwise XOR 
 +  * ~ : bitwise NOT 
 +  * <nowiki><<</nowiki> : bitwise left shift 
 +  * <nowiki>>></nowiki> : bitwise right shift 
 + 
 + 
 +Example: 
 + 
 +<code> 
 +$var(a) = 4 + ( 7 & ( ~2 ) ); 
 +</code> 
 + 
 +NOTE: to ensure the priority of operands in expression evaluations do use __parenthesis__. 
 + 
 +Arithmetic expressions can be used in condition expressions. 
 + 
 +<code> 
 +if( $var(a) & 4 ) 
 +    log("var a has third bit set\n"); 
 +</code> 
 + 
 +===== Operators ===== 
 + 
 +  - type casts operators: (int), (str). 
 +  - string comparison: eq, ne 
 +  - integer comparison: ieq, ine  
 + 
 +Note: The names are not yet final (use them at your own risk). Future version might use ==/!= only for ints (ieq/ine) and eq/ne for strings (under debate). They are almost equivalent to == or !=, but they force the conversion of their operands (eq to string and ieq to int), allowing among other things better type checking on startup and more optimizations. 
 + 
 +Non equiv. examples: 
 + 
 +0 == "" (true) is not equivalent to 0 eq "" (false: it evaluates to "0" eq ""). 
 + 
 +"a" ieq "b" (true: (int)"a" is 0 and (int)"b" is 0) is not equivalent to "a" == "b" (false). 
 + 
 +Note: internally == and != are converted on startup to eq/ne/ieq/ine  whenever possible (both operand types can be safely determined at start time and they are the same).  
 + 
 +  - Kamailio tries to guess what the user wanted when operators that support multiple types are used on different typed operands. In general convert the right operand to the type of the left operand and then perform the operation. Exception: the left operand is undef. This applies to the following operators: +, == and !=. 
 +     Special case: undef as left operand: 
 +     For +: undef + expr -> undef is converted to string => "" + expr. 
 +     For == and !=:   undef == expr -> undef is converted to type_of expr. 
 +     If expr is undef, then undef == undef is true (internally is converted 
 +     to string). 
 + 
 +  - expression evaluation changes: Kamailio will auto-convert to integer or string in function of the operators:  
 +       int(undef)==0,  int("")==0, int("123")==123, int("abc")==0 
 +       str(undef)=="", str(123)=="123"
 + 
 +  - script operators for dealing with empty/undefined variables 
 +      defined expr - returns true if expr is defined, and false if not. 
 +                     Note: only a standalone avp or pvar can be 
 +                     undefined, everything else is defined. 
 +      strlen(expr) - returns the lenght of expr evaluated as string. 
 +      strempty(expr) - returns true if expr evaluates to the empty 
 +                       string (equivalent to expr==""). 
 +      Example: if (defined $v && !strempty($v)) $len=strlen($v); 
 + 
 +===== Command Line Parameters ===== 
 + 
 +Kamailio can be started with a set of command line parameters, providing more flexibility to control what is doing at runtime. Some of them can be quite useful when running on containerised environments. 
 + 
 +To see the the available command line parameters, run **kamailio -h**: 
 + 
 +<code> 
 +# kamailio -h 
 + 
 +version: kamailio 5.4.0-dev4 (x86_64/darwin) 8c1864 
 +Usage: kamailio [options] 
 +Options: 
 +    -a mode      Auto aliases mode: enable with yes or on, 
 +                  disable with no or off 
 +    --alias=val  Add an alias, the value has to be '[proto:]hostname[:port]' 
 +                  (like for 'alias' global parameter) 
 +    -A define    Add config pre-processor define (e.g., -A WITH_AUTH, 
 +                  -A 'FLT_ACC=1', -A 'DEFVAL="str-val"'
 +    -b nr        Maximum receive buffer size which will not be exceeded by 
 +                  auto-probing procedure even if  OS allows 
 +    -c           Check configuration file for syntax errors 
 +    -d           Debugging mode (multiple -d increase the level) 
 +    -D           Control how daemonize is done: 
 +                  -D..do not fork (almost) anyway; 
 +                  -DD..do not daemonize creator; 
 +                  -DDD..daemonize (default) 
 +    -e           Log messages printed in terminal colors (requires -E) 
 +    -E           Log to stderr 
 +    -f file      Configuration file (default: /usr/local/etc/kamailio/kamailio.cfg) 
 +    -g gid       Change gid (group id) 
 +    -G file      Create a pgid file 
 +    -h           This help message 
 +    --help       Long option for `-h` 
 +    -I           Print more internal compile flags and options 
 +    -K           Turn on "via:" host checking when forwarding replies 
 +    -l address   Listen on the specified address/interface (multiple -l 
 +                  mean listening on more addresses). The address format is 
 +                  [proto:]addr_lst[:port][/advaddr], 
 +                  where proto=udp|tcp|tls|sctp, 
 +                  addr_lst= addr|(addr, addr_lst), 
 +                  addr=host|ip_address|interface_name and 
 +                  advaddr=addr[:port] (advertised address). 
 +                  E.g: -l localhost, -l udp:127.0.0.1:5080, -l eth0:5062, 
 +                  -l udp:127.0.0.1:5080/1.2.3.4:5060, 
 +                  -l "sctp:(eth0)", -l "(eth0, eth1, 127.0.0.1):5065"
 +                  The default behaviour is to listen on all the interfaces. 
 +    --loadmodule=name load the module specified by name 
 +    --log-engine=log engine name and data 
 +    -L path      Modules search path (default: /usr/local/lib64/kamailio/modules) 
 +    -m nr        Size of shared memory allocated in Megabytes 
 +    --modparam=modname:paramname:type:value set the module parameter 
 +                  type has to be 's' for string value and 'i' for int value, 
 +                  example: --modparam=corex:alias_subdomains:s:kamailio.org 
 +    -M nr        Size of private memory allocated, in Megabytes 
 +    -n processes Number of child processes to fork per interface 
 +                  (default: 8) 
 +    -N           Number of tcp child processes (default: equal to `-n'
 +    -O nr        Script optimization level (debugging option) 
 +    -P file      Create a pid file 
 +    -Q           Number of sctp child processes (default: equal to `-n'
 +    -r           Use dns to check if is necessary to add a "received=" 
 +                  field to a via 
 +    -R           Same as `-r` but use reverse dns; 
 +                  (to use both use `-rR`) 
 +    --server-id=num set the value for server_id 
 +    --subst=exp set a subst preprocessor directive 
 +    --substdef=exp set a substdef preprocessor directive 
 +    --substdefs=exp set a substdefs preprocessor directive 
 +    -S           disable sctp 
 +    -t dir       Chroot to "dir" 
 +    -T           Disable tcp 
 +    -u uid       Change uid (user id) 
 +    -v           Version number 
 +    --version    Long option for `-v` 
 +    -V           Alternative for `-v` 
 +    -x name      Specify internal manager for shared memory (shm) 
 +                  - can be: fm, qm or tlsf 
 +    -X name      Specify internal manager for private memory (pkg) 
 +                  - if omitted, the one for shm is used 
 +    -Y dir       Runtime dir path 
 +    -w dir       Change the working directory to "dir" (default: "/"
 +    -W type      poll method (depending on support in OS, it can be: poll, 
 +                  epoll_lt, epoll_et, sigio_rt, select, kqueue, /dev/poll) 
 +</code> 
 + 
 +==== Log Engine CLI Parameter ==== 
 + 
 +The **--log-engine** parameter allows to specify what logging engine to be used, which is practically about the format of the log messages. If not set at all, then Kamailio does the classic style of line-based plain text log messages. 
 + 
 +The value of this parameter can be **--log-engine=name** or **--log-engine=name:data**. 
 + 
 +The name of the log engine can be: 
 + 
 +  * **json** - write logs in structured JSON format 
 +    * the **data** for **json** log engine can be a set of character flags: 
 +      * **a** - add log prefix as a special field 
 +      * **A** - do not add log prefix 
 +      * **c** - add Call-ID (when available) as a dedicated JSON attribute 
 +      * **M** - strip EOL ('\n') from the value of the log message field 
 +      * **N** - do not add EOL at the end of JSON document 
 + 
 +Example of JSON logs when running Kamailio with "**--log-engine=json:M**"
 + 
 +<code> 
 +{ "idx": 1, "pid": 18239, "level": "DEBUG", "module": "maxfwd", "file": "mf_funcs.c", "line": 74, "function": "is_maxfwd_present", "logprefix": "{1 1 OPTIONS 715678756@192.168.188.20} ", "message": "value = 70 " } 
 + 
 +{ "idx": 1, "pid": 18239, "level": "DEBUG", "module": "core", "file": "core/socket_info.c", "line": 644, "function": "grep_sock_info", "logprefix": "{1 1 OPTIONS 715678756@192.168.188.20} ", "message": "checking if host==us: 9==9 && [127.0.0.1] == [127.0.0.1]"
 + 
 +</code>
cookbooks/devel/core.txt · Last modified: 2020/08/13 14:59 by miconda