Documentation

Documentation.Interface-CoreEvents-4-1 History

Hide minor edits - Show changes to output

April 21, 2026, at 06:09 PM by 109.99.227.30 -
Added lines 134-136:

This event is generated when the process profiling is activated. It reports different actions that takes place inside the process.
Changed lines 138-164 from:
* '''time''': time when the log message was produced
to:
* '''sec''': UNIX TIMESTAMP, seconds
* '''usec''': micro seconds within the second
* '''session''': session ID, to group all events part of a profiling session
* '''verb''': profiling action as 'start','enter','exit' and 'end'
* '''name''': description of the profiling action
* '''type''': the type of the process generating the profiling data
* '''depth''': execution depth - 'start' is level 1, each 'enter' increases, each 'exit' decreases.
* '''file''': cfg file name or C function where the profiling is done
* '''line''': line in the 'file'
* '''status''': only for 'exit' and 'end', the status/retcode of the 'name' action (highly depends on its nature)

Example of usage:
[@
{'sec': 1776767469, 'usec': 200446, 'session': 3463978, 'verb': 'start', 'name': 'SIP receiver udp:127.0.0.1:5060', 'type': 1, 'depth': 0}
{'sec': 1776767469, 'usec': 201035, 'session': 3463978, 'verb': 'enter', 'name': 'udp proto reading', 'type': 1, 'depth': 1, 'file': 'handle_io', 'line': 317}
{'sec': 1776767469, 'usec': 201485, 'session': 3463978, 'verb': 'enter', 'name': 'receive_msg', 'type': 1, 'depth': 2, 'file': 'receive_msg', 'line': 120}
{'sec': 1776767469, 'usec': 202558, 'session': 3463978, 'verb': 'enter', 'name': 'request_script', 'type': 1, 'depth': 3, 'file': 'receive_msg', 'line': 235}
{'sec': 1776767469, 'usec': 203201, 'session': 3463978, 'verb': 'exit', 'name': 'request_script', 'type': 1, 'depth': 2, 'file': 'receive_msg', 'line': 237, 'status': 1}
{'sec': 1776767469, 'usec': 203533, 'session': 3463978, 'verb': 'exit', 'name': 'receive_msg', 'type': 1, 'depth': 1, 'file': 'receive_msg', 'line': 316, 'status': 0}
{'sec': 1776767469, 'usec': 203663, 'session': 3463978, 'verb': 'exit', 'name': 'reading done', 'type': 1, 'depth': 0, 'file': 'handle_io', 'line': 324, 'status': 0}
{'sec': 1776767469, 'usec': 203786, 'session': 3463978, 'verb': 'end', 'name': 'SIP receiver udp:127.0.0.1:5060', 'type': 1, 'depth': 0, 'status': 0}
@]

[[#E_PROFILING_SCRIPT]]
!!! Script profiling event [[#E_PROFILING_SCRIPT|🔗]]

Similar to E_PROFILING_PROC but related to script (routes) execution.
April 21, 2026, at 05:49 PM by 109.99.227.30 -
Added lines 130-135:
[[#E_PROFILING_PROC]]
!!! Process profiling event [[#E_PROFILING_PROC|🔗]]

'''Event''':E_PROFILING_PROC
Parameters:
* '''time''': time when the log message was produced
May 17, 2023, at 03:30 PM by rvlad_patrascu -
Added lines 112-128:

[[#E_CORE_LOG]]
!!! Log message produced [[#E_CORE_LOG|🔗]]

'''Event''': E_CORE_LOG

This event is triggered whenever a log message is produced by OpenSIPS. In order to have this event trigger, the [[https://www.opensips.org/Documentation/Script-CoreParameters-3-4#log_event_enabled|log_event_enabled]] must be enabled in your configuration.

Parameters:
* '''time''': time when the log message was produced
* '''pid''': the PID of the processes that produced this log message
* '''level''': the log level of this message ("DBG", "INFO" etc.)
* '''module''': module that produced this log message; NULL for logs triggered from the script by the '''xlog()''' function
* '''function''': internal function that produced this log message; NULL for logs triggered from the script by the '''xlog()''' function
* '''prefix''': logging prefix, configured via the [[https://www.opensips.org/Documentation/Script-CoreParameters-3-4#log_prefix|log_prefix]] parameter. It is an empty string if the parameter is not configured.
* '''message''': the actual log message content
February 10, 2022, at 04:37 PM by 109.99.227.30 -
Added line 83:
Added lines 98-111:

[[#E_CORE_SR_STATUS_CHANGED]]
!!! Status/Report status changed [[#E_CORE_SR_STATUS_CHANGED|🔗]]

'''Event''': E_CORE_SR_STATUS_CHANGED

This event is triggered the status of an SR identifier changes.

Parameters:
* '''group''': the name of the SR group
* '''identifier''': the name of the SR identifier
* '''status''': the new status (as numerical value) of the SR identifier
* '''details''': the details/text attached to the new status
* '''old_status''': the old status (as numerical value) of the SR identifier
February 10, 2022, at 04:32 PM by 109.99.227.30 -
Changed lines 19-20 from:
!!! Threshold limit exceeded
to:
[[#E_CORE_THRESHOLD]]
!!! Threshold limit exceeded [[#E_CORE_THRESHOLD|🔗]]
Changed lines 31-32 from:
!!! Private memory threshold exceeded
to:

[[#E_CORE_PKG_THRESHOLD]]
!!! Private memory threshold exceeded [[#E_CORE_PKG_THRESHOLD|🔗]]
Changed lines 50-51 from:
!!! Shared memory threshold exceeded
to:
[[#E_CORE_SHM_THRESHOLD]]
!!! Shared memory threshold exceeded [[#E_CORE_SHM_THRESHOLD|🔗]]
Changed lines 67-68 from:
!!! Process Auto-Scaling (upscale and downscale)
to:
[[#E_CORE_PROC_AUTO_SCALE]]
!!! Process Auto-Scaling (upscale and downscale) [[#E_CORE_PROC_AUTO_SCALE|🔗]]
February 10, 2022, at 04:30 PM by 109.99.227.30 -
Changed lines 78-79 from:
!!! TCP connection disconnected
to:
[[#E_CORE_TCP_DISCONNECT]]
!!! TCP connection disconnected [[#E_CORE_TCP_DISCONNECT|🔗]]
January 10, 2022, at 09:59 AM by 109.99.227.30 -
Changed lines 63-68 from:
!!! TCP connection shutdown

'''Event''': E_CORE_TCP_DISCONNECT

This event is triggered when a TCP connection is shutdown.
to:
!!! Process Auto-Scaling (upscale and downscale)

'''Event''': E_CORE_PROC_AUTO_SCALE

This event is triggered whenever a new process is created (forked) or a process is terminated due the auto-scaling logic. In order to have this event trigger, the [[https://www.opensips.org/Documentation/Script-CoreParameters-4-1#auto_scaling_profile|auto-scaling]] must be enabled in your configuration.
Deleted lines 69-82:
* '''src_ip''': the source IP of the TCP connection
* '''src_port''': the source PORT of the TCP connection
* '''dst_ip''': the destination IP of the TCP connection
* '''dst_port''': the destination PORT of the TCP connection
* '''proto''': the protocol of the underlying TCP connection ( ie. tcp, tls, ws, wss, etc )


!!! Process Auto-Scaling (upscale and downscale)

'''Event''': E_CORE_PROC_AUTO_SCALE

This event is triggered whenever a new process is created (forked) or a process is terminated due the auto-scaling logic. In order to have this event trigger, the [[https://www.opensips.org/Documentation/Script-CoreParameters-4-1#auto_scaling_profile|auto-scaling]] must be enabled in your configuration.

Parameters:
Added lines 76-91:


!!! TCP connection disconnected

'''Event''': E_CORE_TCP_DISCONNECT

This event is triggered when a TCP connection is terminated/disconnected.

Parameters:
* '''src_ip''': the source IP of the TCP connection
* '''src_port''': the source PORT of the TCP connection
* '''dst_ip''': the destination IP of the TCP connection
* '''dst_port''': the destination PORT of the TCP connection
* '''proto''': the protocol of the underlying TCP connection ( ie. tcp, tls, ws, wss, etc )

January 10, 2022, at 09:55 AM by 109.99.227.30 -
Changed lines 74-91 from:
* '''proto''': the protocol of the underlying TCP connection ( ie. tcp, tls, ws, wss, etc )
to:
* '''proto''': the protocol of the underlying TCP connection ( ie. tcp, tls, ws, wss, etc )


!!! Process Auto-Scaling (upscale and downscale)

'''Event''': E_CORE_PROC_AUTO_SCALE

This event is triggered whenever a new process is created (forked) or a process is terminated due the auto-scaling logic. In order to have this event trigger, the [[https://www.opensips.org/Documentation/Script-CoreParameters-4-1#auto_scaling_profile|auto-scaling]] must be enabled in your configuration.

Parameters:
* '''group_type''': the type/name of the scaling group (UDP/TCP/TIMER).
* '''group_filter''': the filter (usually the socket/interface for UDP) of the scaling group.
* '''group_load''': the load over the scaling group.
* '''scale''': "up" or "down"
* '''process_id''': the process ID (at OpenSIPS level) of the scaled (up or down) process.
* '''pid''': the PID (OS level) of the scaled (up or down) process.

----
July 05, 2021, at 11:51 AM by vlad_paiu -
Changed lines 61-74 from:
>><<
to:
>><<

!!! TCP connection shutdown

'''Event''': E_CORE_TCP_DISCONNECT

This event is triggered when a TCP connection is shutdown.

Parameters:
* '''src_ip''': the source IP of the TCP connection
* '''src_port''': the source PORT of the TCP connection
* '''dst_ip''': the destination IP of the TCP connection
* '''dst_port''': the destination PORT of the TCP connection
* '''proto''': the protocol of the underlying TCP connection ( ie. tcp, tls, ws, wss, etc )
March 28, 2019, at 03:06 PM by liviu -
Changed line 27 from:
* '''time''': the amount of time (in microseconds) that the operation took
to:
* '''time''': the amount of time (in microseconds) spent by the operation
March 28, 2019, at 03:05 PM by liviu -
Changed line 27 from:
* '''time''': the number of micro-seconds the limit has been exceeded
to:
* '''time''': the amount of time (in microseconds) that the operation took

Page last modified on April 21, 2026, at 06:09 PM