mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-02 11:06:31 +00:00
3f15501335
Also updates the 'since' of applications/functions that existed before
XML documentation was introduced (1.6.2.0).
(cherry picked from commit b4156fecf0)
71 lines
2.7 KiB
XML
71 lines
2.7 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE docs SYSTEM "appdocsxml.dtd">
|
|
<?xml-stylesheet type="text/xsl" href="appdocsxml.xslt"?>
|
|
<docs xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<function name="LOG_GROUP" language="en_US">
|
|
<since>
|
|
<version>18.21.0</version>
|
|
<version>20.6.0</version>
|
|
<version>21.1.0</version>
|
|
</since>
|
|
<synopsis>
|
|
Set the channel group name for log filtering on this channel
|
|
</synopsis>
|
|
<syntax>
|
|
<parameter name="group" required="false">
|
|
<para>Channel log group name. Leave empty to remove any existing group membership.</para>
|
|
<para>You can use any arbitrary alphanumeric name that can then be used by the
|
|
"logger filter changroup" CLI command to filter dialplan output by group name.</para>
|
|
</parameter>
|
|
</syntax>
|
|
<description>
|
|
<para>Assign a channel to a group for log filtering.</para>
|
|
<para>Because this application can result in dialplan execution logs
|
|
being suppressed (or unsuppressed) from the CLI if filtering is active,
|
|
it is recommended to call this as soon as possible when dialplan execution begins.</para>
|
|
<para>Calling this multiple times will replace any previous group assignment.</para>
|
|
<example title="Associate channel with group test">
|
|
exten => s,1,Set(LOG_GROUP()=test)
|
|
same => n,NoOp() ; if a logging call ID group filter name is enabled but test is not included, you will not see this
|
|
</example>
|
|
<example title="Associate channel with group important">
|
|
exten => s,1,Set(LOG_GROUP()=important)
|
|
same => n,Set(foo=bar) ; do some important things to show on the CLI (assuming it is filtered with important enabled)
|
|
same => n,Set(LOG_GROUP()=) ; remove from group important to stop showing execution on the CLI
|
|
same => n,Wait(5) ; do some unimportant stuff
|
|
</example>
|
|
</description>
|
|
<see-also>
|
|
<ref type="application">Log</ref>
|
|
</see-also>
|
|
</function>
|
|
<managerEvent language="en_US" name="LogChannel">
|
|
<managerEventInstance class="EVENT_FLAG_SYSTEM">
|
|
<since>
|
|
<version>16.24.0</version>
|
|
<version>18.10.0</version>
|
|
<version>19.2.0</version>
|
|
</since>
|
|
<synopsis>Raised when a logging channel is re-enabled after a reload operation.</synopsis>
|
|
<syntax>
|
|
<parameter name="Channel">
|
|
<para>The name of the logging channel.</para>
|
|
</parameter>
|
|
</syntax>
|
|
</managerEventInstance>
|
|
<managerEventInstance class="EVENT_FLAG_SYSTEM">
|
|
<since>
|
|
<version>16.24.0</version>
|
|
<version>18.10.0</version>
|
|
<version>19.2.0</version>
|
|
</since>
|
|
<synopsis>Raised when a logging channel is disabled.</synopsis>
|
|
<syntax>
|
|
<parameter name="Channel">
|
|
<para>The name of the logging channel.</para>
|
|
</parameter>
|
|
</syntax>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
</docs>
|