summaryrefslogtreecommitdiffstats
path: root/docs-xml/smbdotconf/logging/logging.xml
blob: 0ab2c1f131b317a1f98d6ba081d9e7f21d7c7907 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
<samba:parameter name="logging"
                 type="string"
                 context="G"
                 substitution="1"
                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>

  <para>This parameter configures logging backends. Multiple
    backends can be specified at the same time, with different log
    levels for each backend. The parameter is a list of backends,
    where each backend is specified as backend[:option][@loglevel].</para>

  <para>The 'option' parameter can be used to pass backend-specific
    options.</para>

  <para>The log level for a backend is optional, if it is not set for
    a backend, all messages are sent to this backend. The parameter
    <smbconfoption name="log level"/> determines overall log levels,
    while the log levels specified here define what is sent to the
    individual backends.</para>

  <para>When <smbconfoption name="logging"/> is set, it overrides the
    <smbconfoption  name="syslog"/>  and  <smbconfoption  name="syslog
    only"/> parameters.</para>

  <para>Some backends are only available when Samba has been compiled
  with the additional libraries. The overall list of logging backends:</para>

  <itemizedlist>
    <listitem><para><parameter moreinfo="none">syslog</parameter></para></listitem>
    <listitem><para><parameter moreinfo="none">file</parameter></para></listitem>
    <listitem><para><parameter moreinfo="none">systemd</parameter></para></listitem>
    <listitem><para><parameter moreinfo="none">lttng</parameter></para></listitem>
    <listitem><para><parameter moreinfo="none">gpfs</parameter></para></listitem>
    <listitem><para><parameter moreinfo="none">ringbuf</parameter></para></listitem>
  </itemizedlist>

  <para>The <parameter moreinfo="none">ringbuf</parameter> backend supports an
  optional size argument to change the buffer size used, the default is 1 MB:
  <parameter moreinfo="none">ringbuf:size=NBYTES</parameter></para>

</description>
<value type="default"></value>
<value type="example">syslog@1 file</value>
</samba:parameter>