/usr/share/doc/python3-certbot/html/_modules/certbot/log.html is in python-certbot-doc 0.23.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 | <!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>certbot.log — Certbot 0.23.0 documentation</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="../../genindex.html"/>
<link rel="search" title="Search" href="../../search.html"/>
<link rel="top" title="Certbot 0.23.0 documentation" href="../../index.html"/>
<link rel="up" title="Module code" href="../index.html"/>
<script src="../../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../../index.html" class="icon icon-home"> Certbot
</a>
<div class="version">
0.23
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../what.html">What is a Certificate?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../install.html">Get Certbot</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../using.html">User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Developer Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../packaging.html">Packaging Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../resources.html">Resources</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../api.html">API Documentation</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">Certbot</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html">Docs</a> »</li>
<li><a href="../index.html">Module code</a> »</li>
<li>certbot.log</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for certbot.log</h1><div class="highlight"><pre>
<span></span><span class="sd">"""Logging utilities for Certbot.</span>
<span class="sd">The best way to use this module is through `pre_arg_parse_setup` and</span>
<span class="sd">`post_arg_parse_setup`. `pre_arg_parse_setup` configures a minimal</span>
<span class="sd">terminal logger and ensures a detailed log is written to a secure</span>
<span class="sd">temporary file if Certbot exits before `post_arg_parse_setup` is called.</span>
<span class="sd">`post_arg_parse_setup` relies on the parsed command line arguments and</span>
<span class="sd">does the full logging setup with terminal and rotating file handling as</span>
<span class="sd">configured by the user. Any logged messages before</span>
<span class="sd">`post_arg_parse_setup` is called are sent to the rotating file handler.</span>
<span class="sd">Special care is taken by both methods to ensure all errors are logged</span>
<span class="sd">and properly flushed before program exit.</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">print_function</span>
<span class="kn">import</span> <span class="nn">functools</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">logging.handlers</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">tempfile</span>
<span class="kn">import</span> <span class="nn">traceback</span>
<span class="kn">from</span> <span class="nn">acme</span> <span class="k">import</span> <span class="n">messages</span>
<span class="kn">from</span> <span class="nn">certbot</span> <span class="k">import</span> <span class="n">constants</span>
<span class="kn">from</span> <span class="nn">certbot</span> <span class="k">import</span> <span class="n">errors</span>
<span class="kn">from</span> <span class="nn">certbot</span> <span class="k">import</span> <span class="n">util</span>
<span class="c1"># Logging format</span>
<span class="n">CLI_FMT</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%(message)s</span><span class="s2">"</span>
<span class="n">FILE_FMT</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%(asctime)s</span><span class="s2">:</span><span class="si">%(levelname)s</span><span class="s2">:</span><span class="si">%(name)s</span><span class="s2">:</span><span class="si">%(message)s</span><span class="s2">"</span>
<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
<div class="viewcode-block" id="pre_arg_parse_setup"><a class="viewcode-back" href="../../api/log.html#certbot.log.pre_arg_parse_setup">[docs]</a><span class="k">def</span> <span class="nf">pre_arg_parse_setup</span><span class="p">():</span>
<span class="sd">"""Setup logging before command line arguments are parsed.</span>
<span class="sd"> Terminal logging is setup using</span>
<span class="sd"> `certbot.constants.QUIET_LOGGING_LEVEL` so Certbot is as quiet as</span>
<span class="sd"> possible. File logging is setup so that logging messages are</span>
<span class="sd"> buffered in memory. If Certbot exits before `post_arg_parse_setup`</span>
<span class="sd"> is called, these buffered messages are written to a temporary file.</span>
<span class="sd"> If Certbot doesn't exit, `post_arg_parse_setup` writes the messages</span>
<span class="sd"> to the normal log files.</span>
<span class="sd"> This function also sets `logging.shutdown` to be called on program</span>
<span class="sd"> exit which automatically flushes logging handlers and</span>
<span class="sd"> `sys.excepthook` to properly log/display fatal exceptions.</span>
<span class="sd"> """</span>
<span class="n">temp_handler</span> <span class="o">=</span> <span class="n">TempHandler</span><span class="p">()</span>
<span class="n">temp_handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">(</span><span class="n">FILE_FMT</span><span class="p">))</span>
<span class="n">temp_handler</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span>
<span class="n">memory_handler</span> <span class="o">=</span> <span class="n">MemoryHandler</span><span class="p">(</span><span class="n">temp_handler</span><span class="p">)</span>
<span class="n">stream_handler</span> <span class="o">=</span> <span class="n">ColoredStreamHandler</span><span class="p">()</span>
<span class="n">stream_handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">(</span><span class="n">CLI_FMT</span><span class="p">))</span>
<span class="n">stream_handler</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">constants</span><span class="o">.</span><span class="n">QUIET_LOGGING_LEVEL</span><span class="p">)</span>
<span class="n">root_logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">()</span>
<span class="n">root_logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span> <span class="c1"># send all records to handlers</span>
<span class="n">root_logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">memory_handler</span><span class="p">)</span>
<span class="n">root_logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">stream_handler</span><span class="p">)</span>
<span class="c1"># logging.shutdown will flush the memory handler because flush() and</span>
<span class="c1"># close() are explicitly called</span>
<span class="n">util</span><span class="o">.</span><span class="n">atexit_register</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">shutdown</span><span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">excepthook</span> <span class="o">=</span> <span class="n">functools</span><span class="o">.</span><span class="n">partial</span><span class="p">(</span>
<span class="n">pre_arg_parse_except_hook</span><span class="p">,</span> <span class="n">memory_handler</span><span class="p">,</span>
<span class="n">debug</span><span class="o">=</span><span class="s1">'--debug'</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">,</span> <span class="n">log_path</span><span class="o">=</span><span class="n">temp_handler</span><span class="o">.</span><span class="n">path</span><span class="p">)</span></div>
<div class="viewcode-block" id="post_arg_parse_setup"><a class="viewcode-back" href="../../api/log.html#certbot.log.post_arg_parse_setup">[docs]</a><span class="k">def</span> <span class="nf">post_arg_parse_setup</span><span class="p">(</span><span class="n">config</span><span class="p">):</span>
<span class="sd">"""Setup logging after command line arguments are parsed.</span>
<span class="sd"> This function assumes `pre_arg_parse_setup` was called earlier and</span>
<span class="sd"> the root logging configuration has not been modified. A rotating</span>
<span class="sd"> file logging handler is created and the buffered log messages are</span>
<span class="sd"> sent to that handler. Terminal logging output is set to the level</span>
<span class="sd"> requested by the user.</span>
<span class="sd"> :param certbot.interface.IConfig config: Configuration object</span>
<span class="sd"> """</span>
<span class="n">file_handler</span><span class="p">,</span> <span class="n">file_path</span> <span class="o">=</span> <span class="n">setup_log_file_handler</span><span class="p">(</span>
<span class="n">config</span><span class="p">,</span> <span class="s1">'letsencrypt.log'</span><span class="p">,</span> <span class="n">FILE_FMT</span><span class="p">)</span>
<span class="n">logs_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">file_path</span><span class="p">)</span>
<span class="n">root_logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">()</span>
<span class="n">memory_handler</span> <span class="o">=</span> <span class="n">stderr_handler</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">for</span> <span class="n">handler</span> <span class="ow">in</span> <span class="n">root_logger</span><span class="o">.</span><span class="n">handlers</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">handler</span><span class="p">,</span> <span class="n">ColoredStreamHandler</span><span class="p">):</span>
<span class="n">stderr_handler</span> <span class="o">=</span> <span class="n">handler</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">handler</span><span class="p">,</span> <span class="n">MemoryHandler</span><span class="p">):</span>
<span class="n">memory_handler</span> <span class="o">=</span> <span class="n">handler</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s1">'Previously configured logging handlers have been removed!'</span>
<span class="k">assert</span> <span class="n">memory_handler</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">stderr_handler</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">,</span> <span class="n">msg</span>
<span class="n">root_logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">file_handler</span><span class="p">)</span>
<span class="n">root_logger</span><span class="o">.</span><span class="n">removeHandler</span><span class="p">(</span><span class="n">memory_handler</span><span class="p">)</span>
<span class="n">temp_handler</span> <span class="o">=</span> <span class="n">memory_handler</span><span class="o">.</span><span class="n">target</span>
<span class="n">memory_handler</span><span class="o">.</span><span class="n">setTarget</span><span class="p">(</span><span class="n">file_handler</span><span class="p">)</span>
<span class="n">memory_handler</span><span class="o">.</span><span class="n">flush</span><span class="p">(</span><span class="n">force</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">memory_handler</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="n">temp_handler</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">if</span> <span class="n">config</span><span class="o">.</span><span class="n">quiet</span><span class="p">:</span>
<span class="n">level</span> <span class="o">=</span> <span class="n">constants</span><span class="o">.</span><span class="n">QUIET_LOGGING_LEVEL</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">level</span> <span class="o">=</span> <span class="o">-</span><span class="n">config</span><span class="o">.</span><span class="n">verbose_count</span> <span class="o">*</span> <span class="mi">10</span>
<span class="n">stderr_handler</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">level</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'Root logging level set at </span><span class="si">%d</span><span class="s1">'</span><span class="p">,</span> <span class="n">level</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Saving debug log to </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">file_path</span><span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">excepthook</span> <span class="o">=</span> <span class="n">functools</span><span class="o">.</span><span class="n">partial</span><span class="p">(</span>
<span class="n">post_arg_parse_except_hook</span><span class="p">,</span> <span class="n">debug</span><span class="o">=</span><span class="n">config</span><span class="o">.</span><span class="n">debug</span><span class="p">,</span> <span class="n">log_path</span><span class="o">=</span><span class="n">logs_dir</span><span class="p">)</span></div>
<div class="viewcode-block" id="setup_log_file_handler"><a class="viewcode-back" href="../../api/log.html#certbot.log.setup_log_file_handler">[docs]</a><span class="k">def</span> <span class="nf">setup_log_file_handler</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">logfile</span><span class="p">,</span> <span class="n">fmt</span><span class="p">):</span>
<span class="sd">"""Setup file debug logging.</span>
<span class="sd"> :param certbot.interface.IConfig config: Configuration object</span>
<span class="sd"> :param str logfile: basename for the log file</span>
<span class="sd"> :param str fmt: logging format string</span>
<span class="sd"> :returns: file handler and absolute path to the log file</span>
<span class="sd"> :rtype: tuple</span>
<span class="sd"> """</span>
<span class="c1"># TODO: logs might contain sensitive data such as contents of the</span>
<span class="c1"># private key! #525</span>
<span class="n">util</span><span class="o">.</span><span class="n">set_up_core_dir</span><span class="p">(</span>
<span class="n">config</span><span class="o">.</span><span class="n">logs_dir</span><span class="p">,</span> <span class="mo">0o700</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">geteuid</span><span class="p">(),</span> <span class="n">config</span><span class="o">.</span><span class="n">strict_permissions</span><span class="p">)</span>
<span class="n">log_file_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">logs_dir</span><span class="p">,</span> <span class="n">logfile</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">handler</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">handlers</span><span class="o">.</span><span class="n">RotatingFileHandler</span><span class="p">(</span>
<span class="n">log_file_path</span><span class="p">,</span> <span class="n">maxBytes</span><span class="o">=</span><span class="mi">2</span> <span class="o">**</span> <span class="mi">20</span><span class="p">,</span>
<span class="n">backupCount</span><span class="o">=</span><span class="n">config</span><span class="o">.</span><span class="n">max_log_backups</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">IOError</span> <span class="k">as</span> <span class="n">error</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="n">util</span><span class="o">.</span><span class="n">PERM_ERR_FMT</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">error</span><span class="p">))</span>
<span class="c1"># rotate on each invocation, rollover only possible when maxBytes</span>
<span class="c1"># is nonzero and backupCount is nonzero, so we set maxBytes as big</span>
<span class="c1"># as possible not to overrun in single CLI invocation (1MB).</span>
<span class="n">handler</span><span class="o">.</span><span class="n">doRollover</span><span class="p">()</span> <span class="c1"># TODO: creates empty letsencrypt.log.1 file</span>
<span class="n">handler</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span>
<span class="n">handler_formatter</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">(</span><span class="n">fmt</span><span class="o">=</span><span class="n">fmt</span><span class="p">)</span>
<span class="n">handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">handler_formatter</span><span class="p">)</span>
<span class="k">return</span> <span class="n">handler</span><span class="p">,</span> <span class="n">log_file_path</span></div>
<div class="viewcode-block" id="ColoredStreamHandler"><a class="viewcode-back" href="../../api/log.html#certbot.log.ColoredStreamHandler">[docs]</a><span class="k">class</span> <span class="nc">ColoredStreamHandler</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">):</span>
<span class="sd">"""Sends colored logging output to a stream.</span>
<span class="sd"> If the specified stream is not a tty, the class works like the</span>
<span class="sd"> standard `logging.StreamHandler`. Default red_level is</span>
<span class="sd"> `logging.WARNING`.</span>
<span class="sd"> :ivar bool colored: True if output should be colored</span>
<span class="sd"> :ivar bool red_level: The level at which to output</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stream</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">ColoredStreamHandler</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">stream</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">colored</span> <span class="o">=</span> <span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">isatty</span><span class="p">()</span> <span class="k">if</span> <span class="n">stream</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span>
<span class="n">stream</span><span class="o">.</span><span class="n">isatty</span><span class="p">())</span>
<span class="bp">self</span><span class="o">.</span><span class="n">red_level</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">WARNING</span>
<div class="viewcode-block" id="ColoredStreamHandler.format"><a class="viewcode-back" href="../../api/log.html#certbot.log.ColoredStreamHandler.format">[docs]</a> <span class="k">def</span> <span class="nf">format</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">):</span>
<span class="sd">"""Formats the string representation of record.</span>
<span class="sd"> :param logging.LogRecord record: Record to be formatted</span>
<span class="sd"> :returns: Formatted, string representation of record</span>
<span class="sd"> :rtype: str</span>
<span class="sd"> """</span>
<span class="n">out</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">ColoredStreamHandler</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">record</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">colored</span> <span class="ow">and</span> <span class="n">record</span><span class="o">.</span><span class="n">levelno</span> <span class="o">>=</span> <span class="bp">self</span><span class="o">.</span><span class="n">red_level</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">((</span><span class="n">util</span><span class="o">.</span><span class="n">ANSI_SGR_RED</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">util</span><span class="o">.</span><span class="n">ANSI_SGR_RESET</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">out</span></div></div>
<div class="viewcode-block" id="MemoryHandler"><a class="viewcode-back" href="../../api/log.html#certbot.log.MemoryHandler">[docs]</a><span class="k">class</span> <span class="nc">MemoryHandler</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">handlers</span><span class="o">.</span><span class="n">MemoryHandler</span><span class="p">):</span>
<span class="sd">"""Buffers logging messages in memory until the buffer is flushed.</span>
<span class="sd"> This differs from `logging.handlers.MemoryHandler` in that flushing</span>
<span class="sd"> only happens when flush(force=True) is called.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">target</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="c1"># capacity doesn't matter because should_flush() is overridden</span>
<span class="n">capacity</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="s1">'inf'</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">MemoryHandler</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">capacity</span><span class="p">,</span> <span class="n">target</span><span class="o">=</span><span class="n">target</span><span class="p">)</span>
<div class="viewcode-block" id="MemoryHandler.close"><a class="viewcode-back" href="../../api/log.html#certbot.log.MemoryHandler.close">[docs]</a> <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Close the memory handler, but don't set the target to None."""</span>
<span class="c1"># This allows the logging module which may only have a weak</span>
<span class="c1"># reference to the target handler to properly flush and close it.</span>
<span class="n">target</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">target</span>
<span class="nb">super</span><span class="p">(</span><span class="n">MemoryHandler</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">target</span> <span class="o">=</span> <span class="n">target</span></div>
<div class="viewcode-block" id="MemoryHandler.flush"><a class="viewcode-back" href="../../api/log.html#certbot.log.MemoryHandler.flush">[docs]</a> <span class="k">def</span> <span class="nf">flush</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> <span class="c1"># pylint: disable=arguments-differ</span>
<span class="sd">"""Flush the buffer if force=True.</span>
<span class="sd"> If force=False, this call is a noop.</span>
<span class="sd"> :param bool force: True if the buffer should be flushed.</span>
<span class="sd"> """</span>
<span class="c1"># This method allows flush() calls in logging.shutdown to be a</span>
<span class="c1"># noop so we can control when this handler is flushed.</span>
<span class="k">if</span> <span class="n">force</span><span class="p">:</span>
<span class="nb">super</span><span class="p">(</span><span class="n">MemoryHandler</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span></div>
<div class="viewcode-block" id="MemoryHandler.shouldFlush"><a class="viewcode-back" href="../../api/log.html#certbot.log.MemoryHandler.shouldFlush">[docs]</a> <span class="k">def</span> <span class="nf">shouldFlush</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">):</span>
<span class="sd">"""Should the buffer be automatically flushed?</span>
<span class="sd"> :param logging.LogRecord record: log record to be considered</span>
<span class="sd"> :returns: False because the buffer should never be auto-flushed</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="kc">False</span></div></div>
<div class="viewcode-block" id="TempHandler"><a class="viewcode-back" href="../../api/log.html#certbot.log.TempHandler">[docs]</a><span class="k">class</span> <span class="nc">TempHandler</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">):</span>
<span class="sd">"""Safely logs messages to a temporary file.</span>
<span class="sd"> The file is created with permissions 600. If no log records are sent</span>
<span class="sd"> to this handler, the temporary file is deleted when the handler is</span>
<span class="sd"> closed.</span>
<span class="sd"> :ivar str path: file system path to the temporary log file</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">stream</span> <span class="o">=</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">NamedTemporaryFile</span><span class="p">(</span><span class="s1">'w'</span><span class="p">,</span> <span class="n">delete</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">TempHandler</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">stream</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">=</span> <span class="n">stream</span><span class="o">.</span><span class="n">name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_delete</span> <span class="o">=</span> <span class="kc">True</span>
<div class="viewcode-block" id="TempHandler.emit"><a class="viewcode-back" href="../../api/log.html#certbot.log.TempHandler.emit">[docs]</a> <span class="k">def</span> <span class="nf">emit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">):</span>
<span class="sd">"""Log the specified logging record.</span>
<span class="sd"> :param logging.LogRecord record: Record to be formatted</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_delete</span> <span class="o">=</span> <span class="kc">False</span>
<span class="nb">super</span><span class="p">(</span><span class="n">TempHandler</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">emit</span><span class="p">(</span><span class="n">record</span><span class="p">)</span></div>
<div class="viewcode-block" id="TempHandler.close"><a class="viewcode-back" href="../../api/log.html#certbot.log.TempHandler.close">[docs]</a> <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Close the handler and the temporary log file.</span>
<span class="sd"> The temporary log file is deleted if it wasn't used.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">acquire</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># StreamHandler.close() doesn't close the stream to allow a</span>
<span class="c1"># stream like stderr to be used</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stream</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_delete</span><span class="p">:</span>
<span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_delete</span> <span class="o">=</span> <span class="kc">False</span>
<span class="nb">super</span><span class="p">(</span><span class="n">TempHandler</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">finally</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">release</span><span class="p">()</span></div></div>
<div class="viewcode-block" id="pre_arg_parse_except_hook"><a class="viewcode-back" href="../../api/log.html#certbot.log.pre_arg_parse_except_hook">[docs]</a><span class="k">def</span> <span class="nf">pre_arg_parse_except_hook</span><span class="p">(</span><span class="n">memory_handler</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""A simple wrapper around post_arg_parse_except_hook.</span>
<span class="sd"> The additional functionality provided by this wrapper is the memory</span>
<span class="sd"> handler will be flushed before Certbot exits. This allows us to</span>
<span class="sd"> write logging messages to a temporary file if we crashed before</span>
<span class="sd"> logging was fully configured.</span>
<span class="sd"> Since sys.excepthook isn't called on SystemExit exceptions, the</span>
<span class="sd"> memory handler will not be flushed in this case which prevents us</span>
<span class="sd"> from creating temporary log files when argparse exits because a</span>
<span class="sd"> command line argument was invalid or -h, --help, or --version was</span>
<span class="sd"> provided on the command line.</span>
<span class="sd"> :param MemoryHandler memory_handler: memory handler to flush</span>
<span class="sd"> :param tuple args: args for post_arg_parse_except_hook</span>
<span class="sd"> :param dict kwargs: kwargs for post_arg_parse_except_hook</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">post_arg_parse_except_hook</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">finally</span><span class="p">:</span>
<span class="c1"># flush() is called here so messages logged during</span>
<span class="c1"># post_arg_parse_except_hook are also flushed.</span>
<span class="n">memory_handler</span><span class="o">.</span><span class="n">flush</span><span class="p">(</span><span class="n">force</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></div>
<div class="viewcode-block" id="post_arg_parse_except_hook"><a class="viewcode-back" href="../../api/log.html#certbot.log.post_arg_parse_except_hook">[docs]</a><span class="k">def</span> <span class="nf">post_arg_parse_except_hook</span><span class="p">(</span><span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">,</span> <span class="n">trace</span><span class="p">,</span> <span class="n">debug</span><span class="p">,</span> <span class="n">log_path</span><span class="p">):</span>
<span class="sd">"""Logs fatal exceptions and reports them to the user.</span>
<span class="sd"> If debug is True, the full exception and traceback is shown to the</span>
<span class="sd"> user, otherwise, it is suppressed. sys.exit is always called with a</span>
<span class="sd"> nonzero status.</span>
<span class="sd"> :param type exc_type: type of the raised exception</span>
<span class="sd"> :param BaseException exc_value: raised exception</span>
<span class="sd"> :param traceback trace: traceback of where the exception was raised</span>
<span class="sd"> :param bool debug: True if the traceback should be shown to the user</span>
<span class="sd"> :param str log_path: path to file or directory containing the log</span>
<span class="sd"> """</span>
<span class="n">exc_info</span> <span class="o">=</span> <span class="p">(</span><span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">,</span> <span class="n">trace</span><span class="p">)</span>
<span class="c1"># constants.QUIET_LOGGING_LEVEL or higher should be used to</span>
<span class="c1"># display message the user, otherwise, a lower level like</span>
<span class="c1"># logger.DEBUG should be used</span>
<span class="k">if</span> <span class="n">debug</span> <span class="ow">or</span> <span class="ow">not</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">exc_type</span><span class="p">,</span> <span class="ne">Exception</span><span class="p">):</span>
<span class="k">assert</span> <span class="n">constants</span><span class="o">.</span><span class="n">QUIET_LOGGING_LEVEL</span> <span class="o"><=</span> <span class="n">logging</span><span class="o">.</span><span class="n">ERROR</span>
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s1">'Exiting abnormally:'</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="n">exc_info</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'Exiting abnormally:'</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="n">exc_info</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">exc_type</span><span class="p">,</span> <span class="n">errors</span><span class="o">.</span><span class="n">Error</span><span class="p">):</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="n">exc_value</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s1">'An unexpected error occurred:'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">messages</span><span class="o">.</span><span class="n">is_acme_error</span><span class="p">(</span><span class="n">exc_value</span><span class="p">):</span>
<span class="c1"># Remove the ACME error prefix from the exception</span>
<span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">exc_str</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">exc_value</span><span class="p">)</span><span class="o">.</span><span class="n">partition</span><span class="p">(</span><span class="s1">':: '</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">exc_str</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">traceback</span><span class="o">.</span><span class="n">print_exception</span><span class="p">(</span><span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">exit_with_log_path</span><span class="p">(</span><span class="n">log_path</span><span class="p">)</span></div>
<div class="viewcode-block" id="exit_with_log_path"><a class="viewcode-back" href="../../api/log.html#certbot.log.exit_with_log_path">[docs]</a><span class="k">def</span> <span class="nf">exit_with_log_path</span><span class="p">(</span><span class="n">log_path</span><span class="p">):</span>
<span class="sd">"""Print a message about the log location and exit.</span>
<span class="sd"> The message is printed to stderr and the program will exit with a</span>
<span class="sd"> nonzero status.</span>
<span class="sd"> :param str log_path: path to file or directory containing the log</span>
<span class="sd"> """</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s1">'Please see the '</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">log_path</span><span class="p">):</span>
<span class="n">msg</span> <span class="o">+=</span> <span class="s1">'logfiles in </span><span class="si">{0}</span><span class="s1"> '</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">log_path</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">+=</span> <span class="s2">"logfile '</span><span class="si">{0}</span><span class="s2">' "</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">log_path</span><span class="p">)</span>
<span class="n">msg</span> <span class="o">+=</span> <span class="s1">'for more details.'</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span></div>
</pre></div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
<span class="copyright">
© Copyright 2014-2018 - The Certbot software and documentation are licensed under the Apache 2.0 license as described at <a href="https://eff.org/cb-license">https://eff.org/cb-license</a>.
</span>
<br>
<br>
<span class="status">
<a href="https://letsencrypt.status.io/">Let's Encrypt Status</a>
</span>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'0.23.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|