From openSIPS

Documentation: Core Events - 4.1

Documentation -> Manuals -> Manual devel -> Core Events

Pages for other versions: devel 4.0 3.6 3.4 Older versions: 3.5 3.3 3.2 3.1 3.0 2.4 2.3 2.2 2.1 1.11 1.10 1.9 1.8 1.7

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

1.  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 this post.

Parameters:

• source: the source of the event: mysql module, core (for DNS or message processing warnings).
• time: the amount of time (in microseconds) spent by the operation
• extra: extra information, depending on the source of the event

2.  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.

3.  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.

4.  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 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.

5.  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 )

6.  Status/Report 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

7.  Log message produced 🔗

Event: E_CORE_LOG

This event is triggered whenever a log message is produced by OpenSIPS. In order to have this event trigger, the 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 log_prefix parameter. It is an empty string if the parameter is not configured.
• message: the actual log message content

8.  Process profiling event 🔗

Event:E_PROFILING_PROC

This event is generated when the process profiling is activated. It reports different actions that takes place inside the process.

Parameters:

• 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}

9.  Script profiling event 🔗

Similar to E_PROFILING_PROC but related to script (routes) execution.