Documentation

Documentation.Interface-CoreEvents-3-4 History

Hide minor edits - Show changes to output

May 17, 2023, at 03:18 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-3-4#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-3-4#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-3-4#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
March 20, 2014, at 08:57 PM by razvancrainea -
Added lines 1-61:
!!!!!Documentation -> [[Documentation.Manuals|Manuals]] -> [[Documentation.Manual-3-4|Manual 3.4]] -> Core Events
(:title Core Events - 3.4:)
----
(:allVersions Interface-CoreEvents 3.4:)

\\

|| %color=#185662%[+'''Core Events v3.4 '''+]%% ||

||[[Interface-Events-3-4|Prev]] || [[Interface-Statistics-3-4|Next]]||
----

(:toc-float Table of Content:)


Events are exported by the '''OpenSIPS''' core through the Event Interface.

----
!!! Threshold limit exceeded

'''Event''': E_CORE_THRESHOLD

This event is triggered when a particular action takes longer than a specific threshold. It can be raised when a MySQL or DNS query takes too long, or a SIP message processing goes beyond a specific limit. For more information please see [[http://lists.opensips.org/pipermail/users/2011-February/016918.html | this]] post.

Parameters:
* '''source''': the source of the event: mysql module, core (for DNS or message processing warnings).
* '''time''': the number of micro-seconds the limit has been exceeded
* '''extra''': extra information, depending on the source of the event

!!! Private memory threshold exceeded

'''Event''': E_CORE_PKG_THRESHOLD

This event is triggered when the private memory usage goes above a threshold limit, specified by the '''event_pkg_threshold''' the core parameter. It warns external applications about low values of free private memory.

Parameters:
* '''usage''': the percentage of private memory usage. Can have values between '''event_pkg_threshold''' and 100.
* '''threshold''': the '''event_pkg_threshold''' specified in the script.
* '''used''': the amount of private memory used.
* '''size''': the total amount of private memory.
* '''pid''': the pid of the process that raises the event.

>>important<<
Note: If the '''event_pkg_threshold''' is not specified or 0, then this event is disabled.
>><<

!!! Shared memory threshold exceeded

'''Event''': E_CORE_SHM_THRESHOLD

This event is triggered when the shared memory usage goes above a threshold limit, specified by the '''event_shm_threshold''' the core parameter. It warns external applications about low values of free shared memory.

Parameters:
* '''usage''': the percentage of private memory usage. Can have values between '''event_shm_threshold''' and 100.
* '''threshold''': the '''event_shm_threshold''' specified in the script.
* '''used''': the amount of private memory used.
* '''size''': the total amount of private memory.

>>important<<
Note: If the '''event_shm_threshold''' is not specified or 0, then this event is disabled.
>><<

Page last modified on May 17, 2023, at 03:18 PM