Team Ai
Apppublic

parthtamu/rag-code-assistant

sourceHugging Faceupdated 7mo agoView on Hugging Face
0likes
syslog.html585 linesDownload Raw Back to docs
1<!DOCTYPE html>2 3<html lang="en" data-content_root="../">4  <head>5    <meta charset="utf-8" />6    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />7<meta property="og:title" content="syslog — Unix syslog library routines" />8<meta property="og:type" content="website" />9<meta property="og:url" content="https://docs.python.org/3/library/syslog.html" />10<meta property="og:site_name" content="Python documentation" />11<meta property="og:description" content="This module provides an interface to the Unix syslog library routines. Refer to the Unix manual pages for a detailed description of the syslog facility. Availability: Unix, not WASI, not iOS. This ..." />12<meta property="og:image:width" content="1146" />13<meta property="og:image:height" content="600" />14<meta property="og:image" content="https://docs.python.org/3.15/_images/social_previews/summary_library_syslog_0bdca79c.png" />15<meta property="og:image:alt" content="This module provides an interface to the Unix syslog library routines. Refer to the Unix manual pages for a detailed description of the syslog facility. Availability: Unix, not WASI, not iOS. This ..." />16<meta name="description" content="This module provides an interface to the Unix syslog library routines. Refer to the Unix manual pages for a detailed description of the syslog facility. Availability: Unix, not WASI, not iOS. This ..." />17<meta name="twitter:card" content="summary_large_image" />18<meta name="theme-color" content="#3776ab">19 20    <title>syslog — Unix syslog library routines &#8212; Python 3.15.0a6 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">21    22    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />23    <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=234b1a7c" />24    <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=89a2f22a" />25    <link rel="stylesheet" type="text/css" href="../_static/profiling-sampling-visualization.css?v=0c2600ae" />26    <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=5349f25f" />27    28    <script src="../_static/documentation_options.js?v=6b7c9ff5"></script>29    <script src="../_static/doctools.js?v=9bcbadda"></script>30    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>31    <script src="../_static/profiling-sampling-visualization.js?v=9811ed04"></script>32    33    <script src="../_static/sidebar.js"></script>34    35    <link rel="search" type="application/opensearchdescription+xml"36          title="Search within Python 3.15.0a6 documentation"37          href="../_static/opensearch.xml"/>38    <link rel="author" title="About these documents" href="../about.html" />39    <link rel="index" title="Index" href="../genindex.html" />40    <link rel="search" title="Search" href="../search.html" />41    <link rel="copyright" title="Copyright" href="../copyright.html" />42    <link rel="next" title="Modules command-line interface (CLI)" href="cmdline.html" />43    <link rel="prev" title="resource — Resource usage information" href="resource.html" />44    45      46      <script defer file-types="bz2,epub,zip" data-domain="docs.python.org" src="https://analytics.python.org/js/script.file-downloads.outbound-links.js"></script>47      48      <link rel="canonical" href="https://docs.python.org/3/library/syslog.html">49      50    51 52    53    <style>54      @media only screen {55        table.full-width-table {56            width: 100%;57        }58      }59    </style>60<link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">61    <link rel="shortcut icon" type="image/png" href="../_static/py.svg">62            <script type="text/javascript" src="../_static/copybutton.js"></script>63            <script type="text/javascript" src="../_static/menu.js"></script>64            <script type="text/javascript" src="../_static/search-focus.js"></script>65            <script type="text/javascript" src="../_static/themetoggle.js"></script> 66            <script type="text/javascript" src="../_static/rtd_switcher.js"></script>67            <meta name="readthedocs-addons-api-version" content="1">68 69  </head>70<body>71<div class="mobile-nav">72    <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"73           aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu">74    <nav class="nav-content" role="navigation">75        <label for="menuToggler" class="toggler__label">76            <span></span>77        </label>78        <span class="nav-items-wrapper">79            <a href="https://www.python.org/" class="nav-logo">80                <img src="../_static/py.svg" alt="Python logo">81            </a>82            <span class="version_switcher_placeholder"></span>83            <form role="search" class="search" action="../search.html" method="get">84                <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">85                    <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>86                </svg>87                <input placeholder="Quick search" aria-label="Quick search" type="search" name="q">88                <input type="submit" value="Go">89            </form>90        </span>91    </nav>92    <div class="menu-wrapper">93        <nav class="menu" role="navigation" aria-label="main navigation">94            <div class="language_switcher_placeholder"></div>95            96<label class="theme-selector-label">97    Theme98    <select class="theme-selector" oninput="activateTheme(this.value)">99        <option value="auto" selected>Auto</option>100        <option value="light">Light</option>101        <option value="dark">Dark</option>102    </select>103</label>104  <div>105    <h3><a href="../contents.html">Table of Contents</a></h3>106    <ul>107<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">syslog</span></code> — Unix syslog library routines</a><ul>108<li><a class="reference internal" href="#examples">Examples</a><ul>109<li><a class="reference internal" href="#simple-example">Simple example</a></li>110</ul>111</li>112</ul>113</li>114</ul>115 116  </div>117  <div>118    <h4>Previous topic</h4>119    <p class="topless"><a href="resource.html"120                          title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">resource</span></code> — Resource usage information</a></p>121  </div>122  <div>123    <h4>Next topic</h4>124    <p class="topless"><a href="cmdline.html"125                          title="next chapter">Modules command-line interface (CLI)</a></p>126  </div>127  <script>128    document.addEventListener('DOMContentLoaded', () => {129        const title = document.querySelector('meta[property="og:title"]').content;130        const elements = document.querySelectorAll('.improvepage');131        const pageurl = window.location.href.split('?')[0];132        elements.forEach(element => {133            const url = new URL(element.href.split('?')[0].replace("-nojs", ""));134            url.searchParams.set('pagetitle', title);135            url.searchParams.set('pageurl', pageurl);136            url.searchParams.set('pagesource', "library/syslog.rst");137            element.href = url.toString();138        });139    });140  </script>141  <div role="note" aria-label="source link">142    <h3>This page</h3>143    <ul class="this-page-menu">144      <li><a href="../bugs.html">Report a bug</a></li>145      <li><a class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>146      <li>147        <a href="https://github.com/python/cpython/blob/main/Doc/library/syslog.rst?plain=1"148            rel="nofollow">Show source149        </a>150      </li>151      152    </ul>153  </div>154        </nav>155    </div>156</div>157 158  159    <div class="related" role="navigation" aria-label="Related">160      <h3>Navigation</h3>161      <ul>162        <li class="right" style="margin-right: 10px">163          <a href="../genindex.html" title="General Index"164             accesskey="I">index</a></li>165        <li class="right" >166          <a href="../py-modindex.html" title="Python Module Index"167             >modules</a> |</li>168        <li class="right" >169          <a href="cmdline.html" title="Modules command-line interface (CLI)"170             accesskey="N">next</a> |</li>171        <li class="right" >172          <a href="resource.html" title="resource — Resource usage information"173             accesskey="P">previous</a> |</li>174 175          <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>176          <li><a href="https://www.python.org/">Python</a> &#187;</li>177          <li class="switchers">178            <div class="language_switcher_placeholder"></div>179            <div class="version_switcher_placeholder"></div>180          </li>181          <li>182              183          </li>184    <li id="cpython-language-and-version">185      <a href="../index.html">3.15.0a6 Documentation</a> &#187;186    </li>187 188          <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>189          <li class="nav-item nav-item-2"><a href="unix.html" accesskey="U">Unix-specific services</a> &#187;</li>190        <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">syslog</span></code> — Unix syslog library routines</a></li>191                <li class="right">192                    193 194    <div class="inline-search" role="search">195        <form class="inline-search" action="../search.html" method="get">196          <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">197          <input type="submit" value="Go">198        </form>199    </div>200                     |201                </li>202            <li class="right">203<label class="theme-selector-label">204    Theme205    <select class="theme-selector" oninput="activateTheme(this.value)">206        <option value="auto" selected>Auto</option>207        <option value="light">Light</option>208        <option value="dark">Dark</option>209    </select>210</label> |</li>211            212      </ul>213    </div>    214 215    <div class="document">216      <div class="documentwrapper">217        <div class="bodywrapper">218          <div class="body" role="main">219            220  <section id="module-syslog">221<span id="syslog-unix-syslog-library-routines"></span><h1><code class="xref py py-mod docutils literal notranslate"><span class="pre">syslog</span></code> — Unix syslog library routines<a class="headerlink" href="#module-syslog" title="Link to this heading">¶</a></h1>222<hr class="docutils" />223<p>This module provides an interface to the Unix <code class="docutils literal notranslate"><span class="pre">syslog</span></code> library routines.224Refer to the Unix manual pages for a detailed description of the <code class="docutils literal notranslate"><span class="pre">syslog</span></code>225facility.</p>226<div class="availability docutils container">227<p><a class="reference internal" href="intro.html#availability"><span class="std std-ref">Availability</span></a>: Unix, not WASI, not iOS.</p>228</div>229<p>This module wraps the system <code class="docutils literal notranslate"><span class="pre">syslog</span></code> family of routines.  A pure Python230library that can speak to a syslog server is available in the231<a class="reference internal" href="logging.handlers.html#module-logging.handlers" title="logging.handlers: Handlers for the logging module."><code class="xref py py-mod docutils literal notranslate"><span class="pre">logging.handlers</span></code></a> module as <a class="reference internal" href="logging.handlers.html#logging.handlers.SysLogHandler" title="logging.handlers.SysLogHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">SysLogHandler</span></code></a>.</p>232<p>The module defines the following functions:</p>233<dl class="py function">234<dt class="sig sig-object py" id="syslog.syslog">235<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">syslog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#syslog.syslog" title="Link to this definition">¶</a></dt>236<dt class="sig sig-object py">237<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">syslog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">priority</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span></dt>238<dd><p>Send the string <em>message</em> to the system logger.  A trailing newline is added239if necessary.  Each message is tagged with a priority composed of a240<em>facility</em> and a <em>level</em>.  The optional <em>priority</em> argument, which defaults241to <a class="reference internal" href="#syslog.LOG_INFO" title="syslog.LOG_INFO"><code class="xref py py-const docutils literal notranslate"><span class="pre">LOG_INFO</span></code></a>, determines the message priority.  If the facility is242not encoded in <em>priority</em> using logical-or (<code class="docutils literal notranslate"><span class="pre">LOG_INFO</span> <span class="pre">|</span> <span class="pre">LOG_USER</span></code>), the243value given in the <a class="reference internal" href="#syslog.openlog" title="syslog.openlog"><code class="xref py py-func docutils literal notranslate"><span class="pre">openlog()</span></code></a> call is used.</p>244<p>If <a class="reference internal" href="#syslog.openlog" title="syslog.openlog"><code class="xref py py-func docutils literal notranslate"><span class="pre">openlog()</span></code></a> has not been called prior to the call to <code class="xref py py-func docutils literal notranslate"><span class="pre">syslog()</span></code>,245<code class="xref py py-func docutils literal notranslate"><span class="pre">openlog()</span></code> will be called with no arguments.</p>246<p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">syslog.syslog</span></code> with arguments <code class="docutils literal notranslate"><span class="pre">priority</span></code>, <code class="docutils literal notranslate"><span class="pre">message</span></code>.</p>247<div class="versionchanged">248<p><span class="versionmodified changed">Changed in version 3.2: </span>In previous versions, <a class="reference internal" href="#syslog.openlog" title="syslog.openlog"><code class="xref py py-func docutils literal notranslate"><span class="pre">openlog()</span></code></a> would not be called automatically if249it wasn’t called prior to the call to <code class="xref py py-func docutils literal notranslate"><span class="pre">syslog()</span></code>, deferring to the syslog250implementation to call <code class="docutils literal notranslate"><span class="pre">openlog()</span></code>.</p>251</div>252<div class="versionchanged">253<p><span class="versionmodified changed">Changed in version 3.12: </span>This function is restricted in subinterpreters.254(Only code that runs in multiple interpreters is affected and255the restriction is not relevant for most users.)256<a class="reference internal" href="#syslog.openlog" title="syslog.openlog"><code class="xref py py-func docutils literal notranslate"><span class="pre">openlog()</span></code></a> must be called in the main interpreter before <code class="xref py py-func docutils literal notranslate"><span class="pre">syslog()</span></code> may be used257in a subinterpreter.  Otherwise it will raise <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">RuntimeError</span></code></a>.</p>258</div>259</dd></dl>260 261<dl class="py function">262<dt class="sig sig-object py" id="syslog.openlog">263<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">openlog</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">ident</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">logoption</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">facility</span></span></em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#syslog.openlog" title="Link to this definition">¶</a></dt>264<dd><p>Logging options of subsequent <a class="reference internal" href="#module-syslog" title="syslog: An interface to the Unix syslog library routines."><code class="xref py py-func docutils literal notranslate"><span class="pre">syslog()</span></code></a> calls can be set by calling265<code class="xref py py-func docutils literal notranslate"><span class="pre">openlog()</span></code>.  <code class="xref py py-func docutils literal notranslate"><span class="pre">syslog()</span></code> will call <code class="xref py py-func docutils literal notranslate"><span class="pre">openlog()</span></code> with no arguments266if the log is not currently open.</p>267<p>The optional <em>ident</em> keyword argument is a string which is prepended to every268message, and defaults to <code class="docutils literal notranslate"><span class="pre">sys.argv[0]</span></code> with leading path components269stripped.  The optional <em>logoption</em> keyword argument (default is 0) is a bit270field – see below for possible values to combine.  The optional <em>facility</em>271keyword argument (default is <a class="reference internal" href="#syslog.LOG_USER" title="syslog.LOG_USER"><code class="xref py py-const docutils literal notranslate"><span class="pre">LOG_USER</span></code></a>) sets the default facility for272messages which do not have a facility explicitly encoded.</p>273<p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">syslog.openlog</span></code> with arguments <code class="docutils literal notranslate"><span class="pre">ident</span></code>, <code class="docutils literal notranslate"><span class="pre">logoption</span></code>, <code class="docutils literal notranslate"><span class="pre">facility</span></code>.</p>274<div class="versionchanged">275<p><span class="versionmodified changed">Changed in version 3.2: </span>In previous versions, keyword arguments were not allowed, and <em>ident</em> was276required.</p>277</div>278<div class="versionchanged">279<p><span class="versionmodified changed">Changed in version 3.12: </span>This function is restricted in subinterpreters.280(Only code that runs in multiple interpreters is affected and281the restriction is not relevant for most users.)282This may only be called in the main interpreter.283It will raise <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">RuntimeError</span></code></a> if called in a subinterpreter.</p>284</div>285</dd></dl>286 287<dl class="py function">288<dt class="sig sig-object py" id="syslog.closelog">289<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">closelog</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#syslog.closelog" title="Link to this definition">¶</a></dt>290<dd><p>Reset the syslog module values and call the system library <code class="docutils literal notranslate"><span class="pre">closelog()</span></code>.</p>291<p>This causes the module to behave as it does when initially imported.  For292example, <a class="reference internal" href="#syslog.openlog" title="syslog.openlog"><code class="xref py py-func docutils literal notranslate"><span class="pre">openlog()</span></code></a> will be called on the first <a class="reference internal" href="#module-syslog" title="syslog: An interface to the Unix syslog library routines."><code class="xref py py-func docutils literal notranslate"><span class="pre">syslog()</span></code></a> call (if293<code class="xref py py-func docutils literal notranslate"><span class="pre">openlog()</span></code> hasn’t already been called), and <em>ident</em> and other294<code class="xref py py-func docutils literal notranslate"><span class="pre">openlog()</span></code> parameters are reset to defaults.</p>295<p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">syslog.closelog</span></code> with no arguments.</p>296<div class="versionchanged">297<p><span class="versionmodified changed">Changed in version 3.12: </span>This function is restricted in subinterpreters.298(Only code that runs in multiple interpreters is affected and299the restriction is not relevant for most users.)300This may only be called in the main interpreter.301It will raise <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">RuntimeError</span></code></a> if called in a subinterpreter.</p>302</div>303</dd></dl>304 305<dl class="py function">306<dt class="sig sig-object py" id="syslog.setlogmask">307<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">setlogmask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">maskpri</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#syslog.setlogmask" title="Link to this definition">¶</a></dt>308<dd><p>Set the priority mask to <em>maskpri</em> and return the previous mask value.  Calls309to <a class="reference internal" href="#module-syslog" title="syslog: An interface to the Unix syslog library routines."><code class="xref py py-func docutils literal notranslate"><span class="pre">syslog()</span></code></a> with a priority level not set in <em>maskpri</em> are ignored.310The default is to log all priorities.  The function <code class="docutils literal notranslate"><span class="pre">LOG_MASK(pri)</span></code>311calculates the mask for the individual priority <em>pri</em>.  The function312<code class="docutils literal notranslate"><span class="pre">LOG_UPTO(pri)</span></code> calculates the mask for all priorities up to and including313<em>pri</em>.</p>314<p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">syslog.setlogmask</span></code> with argument <code class="docutils literal notranslate"><span class="pre">maskpri</span></code>.</p>315</dd></dl>316 317<p>The module defines the following constants:</p>318<dl class="py data">319<dt class="sig sig-object py" id="syslog.LOG_EMERG">320<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_EMERG</span></span><a class="headerlink" href="#syslog.LOG_EMERG" title="Link to this definition">¶</a></dt>321<dt class="sig sig-object py" id="syslog.LOG_ALERT">322<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_ALERT</span></span><a class="headerlink" href="#syslog.LOG_ALERT" title="Link to this definition">¶</a></dt>323<dt class="sig sig-object py" id="syslog.LOG_CRIT">324<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_CRIT</span></span><a class="headerlink" href="#syslog.LOG_CRIT" title="Link to this definition">¶</a></dt>325<dt class="sig sig-object py" id="syslog.LOG_ERR">326<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_ERR</span></span><a class="headerlink" href="#syslog.LOG_ERR" title="Link to this definition">¶</a></dt>327<dt class="sig sig-object py" id="syslog.LOG_WARNING">328<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_WARNING</span></span><a class="headerlink" href="#syslog.LOG_WARNING" title="Link to this definition">¶</a></dt>329<dt class="sig sig-object py" id="syslog.LOG_NOTICE">330<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_NOTICE</span></span><a class="headerlink" href="#syslog.LOG_NOTICE" title="Link to this definition">¶</a></dt>331<dt class="sig sig-object py" id="syslog.LOG_INFO">332<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_INFO</span></span><a class="headerlink" href="#syslog.LOG_INFO" title="Link to this definition">¶</a></dt>333<dt class="sig sig-object py" id="syslog.LOG_DEBUG">334<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_DEBUG</span></span><a class="headerlink" href="#syslog.LOG_DEBUG" title="Link to this definition">¶</a></dt>335<dd><p>Priority levels (high to low).</p>336</dd></dl>337 338<dl class="py data">339<dt class="sig sig-object py" id="syslog.LOG_AUTH">340<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_AUTH</span></span><a class="headerlink" href="#syslog.LOG_AUTH" title="Link to this definition">¶</a></dt>341<dt class="sig sig-object py" id="syslog.LOG_AUTHPRIV">342<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_AUTHPRIV</span></span><a class="headerlink" href="#syslog.LOG_AUTHPRIV" title="Link to this definition">¶</a></dt>343<dt class="sig sig-object py" id="syslog.LOG_CRON">344<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_CRON</span></span><a class="headerlink" href="#syslog.LOG_CRON" title="Link to this definition">¶</a></dt>345<dt class="sig sig-object py" id="syslog.LOG_DAEMON">346<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_DAEMON</span></span><a class="headerlink" href="#syslog.LOG_DAEMON" title="Link to this definition">¶</a></dt>347<dt class="sig sig-object py" id="syslog.LOG_FTP">348<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_FTP</span></span><a class="headerlink" href="#syslog.LOG_FTP" title="Link to this definition">¶</a></dt>349<dt class="sig sig-object py" id="syslog.LOG_INSTALL">350<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_INSTALL</span></span><a class="headerlink" href="#syslog.LOG_INSTALL" title="Link to this definition">¶</a></dt>351<dt class="sig sig-object py" id="syslog.LOG_KERN">352<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_KERN</span></span><a class="headerlink" href="#syslog.LOG_KERN" title="Link to this definition">¶</a></dt>353<dt class="sig sig-object py" id="syslog.LOG_LAUNCHD">354<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_LAUNCHD</span></span><a class="headerlink" href="#syslog.LOG_LAUNCHD" title="Link to this definition">¶</a></dt>355<dt class="sig sig-object py" id="syslog.LOG_LPR">356<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_LPR</span></span><a class="headerlink" href="#syslog.LOG_LPR" title="Link to this definition">¶</a></dt>357<dt class="sig sig-object py" id="syslog.LOG_MAIL">358<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_MAIL</span></span><a class="headerlink" href="#syslog.LOG_MAIL" title="Link to this definition">¶</a></dt>359<dt class="sig sig-object py" id="syslog.LOG_NETINFO">360<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_NETINFO</span></span><a class="headerlink" href="#syslog.LOG_NETINFO" title="Link to this definition">¶</a></dt>361<dt class="sig sig-object py" id="syslog.LOG_NEWS">362<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_NEWS</span></span><a class="headerlink" href="#syslog.LOG_NEWS" title="Link to this definition">¶</a></dt>363<dt class="sig sig-object py" id="syslog.LOG_RAS">364<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_RAS</span></span><a class="headerlink" href="#syslog.LOG_RAS" title="Link to this definition">¶</a></dt>365<dt class="sig sig-object py" id="syslog.LOG_REMOTEAUTH">366<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_REMOTEAUTH</span></span><a class="headerlink" href="#syslog.LOG_REMOTEAUTH" title="Link to this definition">¶</a></dt>367<dt class="sig sig-object py" id="syslog.LOG_SYSLOG">368<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_SYSLOG</span></span><a class="headerlink" href="#syslog.LOG_SYSLOG" title="Link to this definition">¶</a></dt>369<dt class="sig sig-object py" id="syslog.LOG_USER">370<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_USER</span></span><a class="headerlink" href="#syslog.LOG_USER" title="Link to this definition">¶</a></dt>371<dt class="sig sig-object py" id="syslog.LOG_UUCP">372<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_UUCP</span></span><a class="headerlink" href="#syslog.LOG_UUCP" title="Link to this definition">¶</a></dt>373<dt class="sig sig-object py" id="syslog.LOG_LOCAL0">374<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_LOCAL0</span></span><a class="headerlink" href="#syslog.LOG_LOCAL0" title="Link to this definition">¶</a></dt>375<dt class="sig sig-object py" id="syslog.LOG_LOCAL1">376<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_LOCAL1</span></span><a class="headerlink" href="#syslog.LOG_LOCAL1" title="Link to this definition">¶</a></dt>377<dt class="sig sig-object py" id="syslog.LOG_LOCAL2">378<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_LOCAL2</span></span><a class="headerlink" href="#syslog.LOG_LOCAL2" title="Link to this definition">¶</a></dt>379<dt class="sig sig-object py" id="syslog.LOG_LOCAL3">380<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_LOCAL3</span></span><a class="headerlink" href="#syslog.LOG_LOCAL3" title="Link to this definition">¶</a></dt>381<dt class="sig sig-object py" id="syslog.LOG_LOCAL4">382<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_LOCAL4</span></span><a class="headerlink" href="#syslog.LOG_LOCAL4" title="Link to this definition">¶</a></dt>383<dt class="sig sig-object py" id="syslog.LOG_LOCAL5">384<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_LOCAL5</span></span><a class="headerlink" href="#syslog.LOG_LOCAL5" title="Link to this definition">¶</a></dt>385<dt class="sig sig-object py" id="syslog.LOG_LOCAL6">386<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_LOCAL6</span></span><a class="headerlink" href="#syslog.LOG_LOCAL6" title="Link to this definition">¶</a></dt>387<dt class="sig sig-object py" id="syslog.LOG_LOCAL7">388<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_LOCAL7</span></span><a class="headerlink" href="#syslog.LOG_LOCAL7" title="Link to this definition">¶</a></dt>389<dd><p>Facilities, depending on availability in <code class="docutils literal notranslate"><span class="pre">&lt;syslog.h&gt;</span></code> for <a class="reference internal" href="#syslog.LOG_AUTHPRIV" title="syslog.LOG_AUTHPRIV"><code class="xref py py-const docutils literal notranslate"><span class="pre">LOG_AUTHPRIV</span></code></a>,390<a class="reference internal" href="#syslog.LOG_FTP" title="syslog.LOG_FTP"><code class="xref py py-const docutils literal notranslate"><span class="pre">LOG_FTP</span></code></a>, <a class="reference internal" href="#syslog.LOG_NETINFO" title="syslog.LOG_NETINFO"><code class="xref py py-const docutils literal notranslate"><span class="pre">LOG_NETINFO</span></code></a>, <a class="reference internal" href="#syslog.LOG_REMOTEAUTH" title="syslog.LOG_REMOTEAUTH"><code class="xref py py-const docutils literal notranslate"><span class="pre">LOG_REMOTEAUTH</span></code></a>,391<a class="reference internal" href="#syslog.LOG_INSTALL" title="syslog.LOG_INSTALL"><code class="xref py py-const docutils literal notranslate"><span class="pre">LOG_INSTALL</span></code></a> and <a class="reference internal" href="#syslog.LOG_RAS" title="syslog.LOG_RAS"><code class="xref py py-const docutils literal notranslate"><span class="pre">LOG_RAS</span></code></a>.</p>392<div class="versionchanged">393<p><span class="versionmodified changed">Changed in version 3.13: </span>Added <a class="reference internal" href="#syslog.LOG_FTP" title="syslog.LOG_FTP"><code class="xref py py-const docutils literal notranslate"><span class="pre">LOG_FTP</span></code></a>, <a class="reference internal" href="#syslog.LOG_NETINFO" title="syslog.LOG_NETINFO"><code class="xref py py-const docutils literal notranslate"><span class="pre">LOG_NETINFO</span></code></a>, <a class="reference internal" href="#syslog.LOG_REMOTEAUTH" title="syslog.LOG_REMOTEAUTH"><code class="xref py py-const docutils literal notranslate"><span class="pre">LOG_REMOTEAUTH</span></code></a>,394<a class="reference internal" href="#syslog.LOG_INSTALL" title="syslog.LOG_INSTALL"><code class="xref py py-const docutils literal notranslate"><span class="pre">LOG_INSTALL</span></code></a>, <a class="reference internal" href="#syslog.LOG_RAS" title="syslog.LOG_RAS"><code class="xref py py-const docutils literal notranslate"><span class="pre">LOG_RAS</span></code></a>, and <a class="reference internal" href="#syslog.LOG_LAUNCHD" title="syslog.LOG_LAUNCHD"><code class="xref py py-const docutils literal notranslate"><span class="pre">LOG_LAUNCHD</span></code></a>.</p>395</div>396</dd></dl>397 398<dl class="py data">399<dt class="sig sig-object py" id="syslog.LOG_PID">400<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_PID</span></span><a class="headerlink" href="#syslog.LOG_PID" title="Link to this definition">¶</a></dt>401<dt class="sig sig-object py" id="syslog.LOG_CONS">402<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_CONS</span></span><a class="headerlink" href="#syslog.LOG_CONS" title="Link to this definition">¶</a></dt>403<dt class="sig sig-object py" id="syslog.LOG_NDELAY">404<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_NDELAY</span></span><a class="headerlink" href="#syslog.LOG_NDELAY" title="Link to this definition">¶</a></dt>405<dt class="sig sig-object py" id="syslog.LOG_ODELAY">406<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_ODELAY</span></span><a class="headerlink" href="#syslog.LOG_ODELAY" title="Link to this definition">¶</a></dt>407<dt class="sig sig-object py" id="syslog.LOG_NOWAIT">408<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_NOWAIT</span></span><a class="headerlink" href="#syslog.LOG_NOWAIT" title="Link to this definition">¶</a></dt>409<dt class="sig sig-object py" id="syslog.LOG_PERROR">410<span class="sig-prename descclassname"><span class="pre">syslog.</span></span><span class="sig-name descname"><span class="pre">LOG_PERROR</span></span><a class="headerlink" href="#syslog.LOG_PERROR" title="Link to this definition">¶</a></dt>411<dd><p>Log options, depending on availability in <code class="docutils literal notranslate"><span class="pre">&lt;syslog.h&gt;</span></code> for412<a class="reference internal" href="#syslog.LOG_ODELAY" title="syslog.LOG_ODELAY"><code class="xref py py-const docutils literal notranslate"><span class="pre">LOG_ODELAY</span></code></a>, <a class="reference internal" href="#syslog.LOG_NOWAIT" title="syslog.LOG_NOWAIT"><code class="xref py py-const docutils literal notranslate"><span class="pre">LOG_NOWAIT</span></code></a> and <a class="reference internal" href="#syslog.LOG_PERROR" title="syslog.LOG_PERROR"><code class="xref py py-const docutils literal notranslate"><span class="pre">LOG_PERROR</span></code></a>.</p>413</dd></dl>414 415<section id="examples">416<h2>Examples<a class="headerlink" href="#examples" title="Link to this heading">¶</a></h2>417<section id="simple-example">418<h3>Simple example<a class="headerlink" href="#simple-example" title="Link to this heading">¶</a></h3>419<p>A simple set of examples:</p>420<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">syslog</span>421 422<span class="n">syslog</span><span class="o">.</span><span class="n">syslog</span><span class="p">(</span><span class="s1">&#39;Processing started&#39;</span><span class="p">)</span>423<span class="k">if</span> <span class="n">error</span><span class="p">:</span>424    <span class="n">syslog</span><span class="o">.</span><span class="n">syslog</span><span class="p">(</span><span class="n">syslog</span><span class="o">.</span><span class="n">LOG_ERR</span><span class="p">,</span> <span class="s1">&#39;Processing started&#39;</span><span class="p">)</span>425</pre></div>426</div>427<p>An example of setting some log options, these would include the process ID in428logged messages, and write the messages to the destination facility used for429mail logging:</p>430<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">syslog</span><span class="o">.</span><span class="n">openlog</span><span class="p">(</span><span class="n">logoption</span><span class="o">=</span><span class="n">syslog</span><span class="o">.</span><span class="n">LOG_PID</span><span class="p">,</span> <span class="n">facility</span><span class="o">=</span><span class="n">syslog</span><span class="o">.</span><span class="n">LOG_MAIL</span><span class="p">)</span>431<span class="n">syslog</span><span class="o">.</span><span class="n">syslog</span><span class="p">(</span><span class="s1">&#39;E-mail processing initiated...&#39;</span><span class="p">)</span>432</pre></div>433</div>434</section>435</section>436</section>437 438 439            <div class="clearer"></div>440          </div>441        </div>442      </div>443      <div class="sphinxsidebar" role="navigation" aria-label="Main">444        <div class="sphinxsidebarwrapper">445  <div>446    <h3><a href="../contents.html">Table of Contents</a></h3>447    <ul>448<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">syslog</span></code> — Unix syslog library routines</a><ul>449<li><a class="reference internal" href="#examples">Examples</a><ul>450<li><a class="reference internal" href="#simple-example">Simple example</a></li>451</ul>452</li>453</ul>454</li>455</ul>456 457  </div>458  <div>459    <h4>Previous topic</h4>460    <p class="topless"><a href="resource.html"461                          title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">resource</span></code> — Resource usage information</a></p>462  </div>463  <div>464    <h4>Next topic</h4>465    <p class="topless"><a href="cmdline.html"466                          title="next chapter">Modules command-line interface (CLI)</a></p>467  </div>468  <script>469    document.addEventListener('DOMContentLoaded', () => {470        const title = document.querySelector('meta[property="og:title"]').content;471        const elements = document.querySelectorAll('.improvepage');472        const pageurl = window.location.href.split('?')[0];473        elements.forEach(element => {474            const url = new URL(element.href.split('?')[0].replace("-nojs", ""));475            url.searchParams.set('pagetitle', title);476            url.searchParams.set('pageurl', pageurl);477            url.searchParams.set('pagesource', "library/syslog.rst");478            element.href = url.toString();479        });480    });481  </script>482  <div role="note" aria-label="source link">483    <h3>This page</h3>484    <ul class="this-page-menu">485      <li><a href="../bugs.html">Report a bug</a></li>486      <li><a class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>487      <li>488        <a href="https://github.com/python/cpython/blob/main/Doc/library/syslog.rst?plain=1"489            rel="nofollow">Show source490        </a>491      </li>492      493    </ul>494  </div>495        </div>496<div id="sidebarbutton" title="Collapse sidebar">497<span>«</span>498</div>499 500      </div>501      <div class="clearer"></div>502    </div>  503    <div class="related" role="navigation" aria-label="Related">504      <h3>Navigation</h3>505      <ul>506        <li class="right" style="margin-right: 10px">507          <a href="../genindex.html" title="General Index"508             >index</a></li>509        <li class="right" >510          <a href="../py-modindex.html" title="Python Module Index"511             >modules</a> |</li>512        <li class="right" >513          <a href="cmdline.html" title="Modules command-line interface (CLI)"514             >next</a> |</li>515        <li class="right" >516          <a href="resource.html" title="resource — Resource usage information"517             >previous</a> |</li>518 519          <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>520          <li><a href="https://www.python.org/">Python</a> &#187;</li>521          <li class="switchers">522            <div class="language_switcher_placeholder"></div>523            <div class="version_switcher_placeholder"></div>524          </li>525          <li>526              527          </li>528    <li id="cpython-language-and-version">529      <a href="../index.html">3.15.0a6 Documentation</a> &#187;530    </li>531 532          <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>533          <li class="nav-item nav-item-2"><a href="unix.html" >Unix-specific services</a> &#187;</li>534        <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">syslog</span></code> — Unix syslog library routines</a></li>535                <li class="right">536                    537 538    <div class="inline-search" role="search">539        <form class="inline-search" action="../search.html" method="get">540          <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">541          <input type="submit" value="Go">542        </form>543    </div>544                     |545                </li>546            <li class="right">547<label class="theme-selector-label">548    Theme549    <select class="theme-selector" oninput="activateTheme(this.value)">550        <option value="auto" selected>Auto</option>551        <option value="light">Light</option>552        <option value="dark">Dark</option>553    </select>554</label> |</li>555            556      </ul>557    </div>  558    <div class="footer">559    &copy; <a href="../copyright.html">Copyright</a> 2001 Python Software Foundation.560    <br>561    This page is licensed under the Python Software Foundation License Version 2.562    <br>563    Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.564    <br>565    566      See <a href="/license.html">History and License</a> for more information.<br>567    568    569    <br>570 571    The Python Software Foundation is a non-profit corporation.572<a href="https://www.python.org/psf/donations/">Please donate.</a>573<br>574    <br>575      Last updated on Mar 10, 2026 (08:58 UTC).576    577      <a href="/bugs.html">Found a bug</a>?578    579    <br>580 581    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.582    </div>583 584  </body>585</html>