← Volver al índice de módulos

siptrace

The SIPtrace module offers a possibility to store incoming and outgoing SIP messages in a database and/or duplicate to the capturing server (using HEP, the Homer encapsulation protocol, or plain SIP m
📊 Monitorización y Logging Kamailio 6.1 30 parámetros 12 funciones

Descripción general

The SIPtrace module offers a possibility to store incoming and outgoing SIP messages in a database and/or duplicate to the capturing server (using HEP, the Homer encapsulation protocol, or plain SIP mode). Since version 5.3.0 new levels of tracing are available. Transactions and dialogs can be traced. There are multiple ways of storing information: * by calling the sip_trace() method explicitly in the Kamailio configuration file. In this case the original message is processed along with its corresponding transaction/dialog if certain flags are used. * by setting “trace_mode” to mirror or store to db all traffic. The tracing can be turned on/off using Kamailio RPC commands. kamctl rpc siptrace.status on kamctl rpc siptrace.status off

Documentación oficial: https://www.kamailio.org/docs/modules/stable/modules/siptrace.html
Código fuente: https://github.com/kamailio/kamailio/tree/master/src/modules/siptrace

Parámetros de configuración

ParámetroTipoDescripción
db_url str 3.2. table (str) 3.3. trace_flag (integer) 3.4. trace_on (integer) 3.5. traced_user_avp (str) 3.6. trace_table_avp (str) 3.7. duplicate_uri (str) 3.8. trace_to_database (integer) 3.9. trace_local_ip (
table str 3.3. trace_flag (integer) 3.4. trace_on (integer) 3.5. traced_user_avp (str) 3.6. trace_table_avp (str) 3.7. duplicate_uri (str) 3.8. trace_to_database (integer) 3.9. trace_local_ip (str) 3.10. trace_
trace_flag integer 3.4. trace_on (integer) 3.5. traced_user_avp (str) 3.6. trace_table_avp (str) 3.7. duplicate_uri (str) 3.8. trace_to_database (integer) 3.9. trace_local_ip (str) 3.10. trace_sl_acks (integer) 3.11. xh
trace_on integer 3.5. traced_user_avp (str) 3.6. trace_table_avp (str) 3.7. duplicate_uri (str) 3.8. trace_to_database (integer) 3.9. trace_local_ip (str) 3.10. trace_sl_acks (integer) 3.11. xheaders_write (integer) 3
traced_user_avp str 3.6. trace_table_avp (str) 3.7. duplicate_uri (str) 3.8. trace_to_database (integer) 3.9. trace_local_ip (str) 3.10. trace_sl_acks (integer) 3.11. xheaders_write (integer) 3.12. xheaders_read (integer
trace_table_avp str 3.7. duplicate_uri (str) 3.8. trace_to_database (integer) 3.9. trace_local_ip (str) 3.10. trace_sl_acks (integer) 3.11. xheaders_write (integer) 3.12. xheaders_read (integer) 3.13. hep_mode_on (intege
duplicate_uri str 3.8. trace_to_database (integer) 3.9. trace_local_ip (str) 3.10. trace_sl_acks (integer) 3.11. xheaders_write (integer) 3.12. xheaders_read (integer) 3.13. hep_mode_on (integer) 3.14. hep_version (int
trace_to_database integer 3.9. trace_local_ip (str) 3.10. trace_sl_acks (integer) 3.11. xheaders_write (integer) 3.12. xheaders_read (integer) 3.13. hep_mode_on (integer) 3.14. hep_version (integer) 3.15. hep_capture_id (integ
trace_local_ip str 3.10. trace_sl_acks (integer) 3.11. xheaders_write (integer) 3.12. xheaders_read (integer) 3.13. hep_mode_on (integer) 3.14. hep_version (integer) 3.15. hep_capture_id (integer) 3.16. trace_db_mode (i
trace_sl_acks integer 3.11. xheaders_write (integer) 3.12. xheaders_read (integer) 3.13. hep_mode_on (integer) 3.14. hep_version (integer) 3.15. hep_capture_id (integer) 3.16. trace_db_mode (integer) 3.17. trace_delayed (i
xheaders_write integer 3.12. xheaders_read (integer) 3.13. hep_mode_on (integer) 3.14. hep_version (integer) 3.15. hep_capture_id (integer) 3.16. trace_db_mode (integer) 3.17. trace_delayed (integer) 3.18. send_sock_name (s
xheaders_read integer 3.13. hep_mode_on (integer) 3.14. hep_version (integer) 3.15. hep_capture_id (integer) 3.16. trace_db_mode (integer) 3.17. trace_delayed (integer) 3.18. send_sock_name (str) 3.19. send_sock_addr (str)
hep_mode_on integer 3.14. hep_version (integer) 3.15. hep_capture_id (integer) 3.16. trace_db_mode (integer) 3.17. trace_delayed (integer) 3.18. send_sock_name (str) 3.19. send_sock_addr (str) 3.20. force_send_sock (str)
hep_version integer 3.15. hep_capture_id (integer) 3.16. trace_db_mode (integer) 3.17. trace_delayed (integer) 3.18. send_sock_name (str) 3.19. send_sock_addr (str) 3.20. force_send_sock (str) 3.21. trace_init_mode (inte
hep_capture_id integer 3.16. trace_db_mode (integer) 3.17. trace_delayed (integer) 3.18. send_sock_name (str) 3.19. send_sock_addr (str) 3.20. force_send_sock (str) 3.21. trace_init_mode (integer) 3.22. trace_mode (integer)
trace_db_mode integer 3.17. trace_delayed (integer) 3.18. send_sock_name (str) 3.19. send_sock_addr (str) 3.20. force_send_sock (str) 3.21. trace_init_mode (integer) 3.22. trace_mode (integer) 3.23. data_mode (integer) 3.2
trace_delayed integer 3.18. send_sock_name (str) 3.19. send_sock_addr (str) 3.20. force_send_sock (str) 3.21. trace_init_mode (integer) 3.22. trace_mode (integer) 3.23. data_mode (integer) 3.24. auth_key (integer) 3.25. ev
send_sock_name str 3.19. send_sock_addr (str) 3.20. force_send_sock (str) 3.21. trace_init_mode (integer) 3.22. trace_mode (integer) 3.23. data_mode (integer) 3.24. auth_key (integer) 3.25. evcb_msg (str) 3.26. trace_di
send_sock_addr str 3.20. force_send_sock (str) 3.21. trace_init_mode (integer) 3.22. trace_mode (integer) 3.23. data_mode (integer) 3.24. auth_key (integer) 3.25. evcb_msg (str) 3.26. trace_dialog_ack (str) 3.27. trace_
force_send_sock str 3.21. trace_init_mode (integer) 3.22. trace_mode (integer) 3.23. data_mode (integer) 3.24. auth_key (integer) 3.25. evcb_msg (str) 3.26. trace_dialog_ack (str) 3.27. trace_dialog_spiral (str)
trace_init_mode integer 3.22. trace_mode (integer) 3.23. data_mode (integer) 3.24. auth_key (integer) 3.25. evcb_msg (str) 3.26. trace_dialog_ack (str) 3.27. trace_dialog_spiral (str)
trace_mode integer 3.23. data_mode (integer) 3.24. auth_key (integer) 3.25. evcb_msg (str) 3.26. trace_dialog_ack (str) 3.27. trace_dialog_spiral (str)
data_mode integer 3.24. auth_key (integer) 3.25. evcb_msg (str) 3.26. trace_dialog_ack (str) 3.27. trace_dialog_spiral (str)
auth_key integer 3.25. evcb_msg (str) 3.26. trace_dialog_ack (str) 3.27. trace_dialog_spiral (str)
evcb_msg str 3.26. trace_dialog_ack (str) 3.27. trace_dialog_spiral (str)
trace_dialog_ack str 3.27. trace_dialog_spiral (str)
trace_dialog_spiral str 3.1. db_url (str)
db_url str Database URL.
table str Name of the table where to store the SIP messages.
trace_flag integer Which flag is used to mark messages to trace without traced user.

Funciones exportadas

sip_trace([address][, correlation_id][, mode])

4.2. sip_trace_mode(tmode) 4.3. sip_trace_msg(vmsg, saddr, taddr, daddr, corrid) 4.4. hlog([correlation_id,] message)

sip_trace_mode(tmode)

4.3. sip_trace_msg(vmsg, saddr, taddr, daddr, corrid) 4.4. hlog([correlation_id,] message)

sip_trace_msg(vmsg, saddr, taddr, daddr, corrid)

4.4. hlog([correlation_id,] message)

hlog([correlation_id,] message)

4.1. sip_trace([address][, correlation_id][, mode])

sip_trace([address][, correlation_id][, mode])

Store or forward the current processed SIP message/transaction/dialog in a database. It is stored in the form prior applying changes made to it. Based on mode, one can trace the current message('m'), the current transaction('t') or the current dialog

sip_trace()

usage ... sip_trace(); ... sip_trace("sip:10.1.1.2:5085"); ... sip_trace("sip:10.1.1.2:5085", "$ci-abc"); ... /* trace current dialog; needs to be done on initial INVITE and dialog has to be loaded */ sip_trace("sip:10.1.1.2:5085", "$ci-abc", "d"); .

sip_trace_mode(tmode)

Set the tracing mode: message, transaction or dialog. Only the first character of the parameter matters: m or M for message; t or T for transaction; d or D for dialog.

sip_trace_mode()

usage ... sip_trace_mode("t"); ...

sip_trace_msg(vmsg, saddr, taddr, daddr, corrid)

Send the value of vmsg to the HEP capture server located at daddr, by setting saddr as source address and taddr as target address for vmsg. Correlation ID can be provided with corrid parameter or left as an empty string. The saddr and taddr have to b

sip_trace_msg()

usage ... sip_trace_msg("$var(msg)", "udp:127.0.0.1:5062", "udp:127.0.0.1:5064", "sip:127. 0.0.1:5090", ""); ...

hlog([correlation_id,] message)

Sends a log event as a HEP3 packet to the homer host configured in duplicate_uri.

hlog()

usage ... hlog("[cfg:$cfg(line)] This is a log from kamailio to Homer"); ... hlog("$hdr(P-MyID)", "Another one with a custom correlation ID"); ...

Autores y contribuidores

Daniel-Constantin Mierla <miconda@gmail.com>Alexandr Dubovikov <alexandr.dubovikov@gmail.com>Giacomo Vacca <giacomo.vacca@gmail.com>Camille Oudot <camille.oudot@orange.com>

Copyright © 2010 asipto.com
Copyright © 2006 voice-system.ro

Módulos relacionados

debugger dlgs rtjson sipcapture statistics xlog