├── .dir-locals.el ├── .editorconfig ├── .gitignore ├── .vimrc ├── COPYING ├── MANIFEST.in ├── README ├── README.md ├── notes ├── setup.py ├── systemd_coredump.pth ├── systemd_coredump_exception_handler.py └── tests ├── indentation_fail.py └── test_indentation.py /.dir-locals.el: -------------------------------------------------------------------------------- 1 | ; Sets emacs variables based on mode. 2 | ; A list of (major-mode . ((var1 . value1) (var2 . value2))) 3 | ; Mode can be nil, which gives default values. 4 | 5 | ; NOTE: If you update this file make sure to update .vimrc and .editorconfig, 6 | ; too. 7 | 8 | ((nil . ((indent-tabs-mode . nil) 9 | (tab-width . 4) 10 | (fill-column . 79))) 11 | ) 12 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # EditorConfig configuration for systemd 2 | # http://EditorConfig.org 3 | 4 | # NOTE: If you update this file make sure to update .dir-locals.el and .vimrc, 5 | # too. 6 | 7 | # Top-most EditorConfig file 8 | root = true 9 | 10 | # Unix-style newlines with a newline ending every file, utf-8 charset 11 | [*] 12 | end_of_line = lf 13 | insert_final_newline = true 14 | trim_trailing_whitespace = true 15 | charset = utf-8 16 | 17 | # Match config files, set indent to spaces with width of eight 18 | [*.py] 19 | indent_style = space 20 | indent_size = 4 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__/ 2 | *.py[oc] 3 | /MANIFEST 4 | /build/ 5 | /dist/ 6 | *~ 7 | -------------------------------------------------------------------------------- /.vimrc: -------------------------------------------------------------------------------- 1 | " 'set exrc' in ~/.vimrc will read .vimrc from the current directory 2 | " Warning: Enabling exrc is dangerous! You can do nearly everything from a 3 | " vimrc configuration file, including write operations and shell execution. 4 | " You should consider setting 'set secure' as well, which is highly 5 | " recommended! 6 | 7 | " NOTE: If you update this file make sure to update .dir-locals.el and 8 | " .editorconfig, too. 9 | 10 | set tabstop=4 11 | set shiftwidth=4 12 | set expandtab 13 | set tw=79 14 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include COPYING 2 | include systemd_coredump.pth 3 | graft tests 4 | -------------------------------------------------------------------------------- /README: -------------------------------------------------------------------------------- 1 | sys.excepthook helper for Python to send backtraces to the journal 2 | 3 | GIT: 4 | git@github.com:systemd/systemd-coredump-python.git 5 | https://github.com/systemd/systemd-coredump-python.git 6 | 7 | BUG REPORTS: 8 | https://github.com/systemd/systemd-coredump-python/issues 9 | 10 | LICENSE: 11 | GPLv2.1+ for all code 12 | 13 | REQUIREMENTS: 14 | Python 2.x or 3.x. 15 | Tested with CPython, PyPy, PyPy3. 16 | 17 | (Does not work with Jython: 2.5 is too old, and 2.7 is broken, 18 | see http://bugs.jython.org/issue2405.) 19 | 20 | systemd v. 233 or later is required. 21 | 22 | USAGE: 23 | 24 | For this module provides a function which may be installed as the 25 | `sys.excepthook` exception handler. It will generate a backtrace 26 | and invoke systemd-coredump(8) to send it to off to the journal 27 | along with some additional metadata about the python process. 28 | 29 | When installed, a .pth file is also installed which loads this 30 | module and checks if it should handle `sys.excepthook`. It will be 31 | automatically enabled if /proc/sys/kernel/core_pattern specifies 32 | systemd-coredump. 33 | 34 | It is also possible to unconditionally install this module as 35 | `sys.excepthook` by calling 36 | `systemd_coredump_exception_handler.install(True)`. 37 | 38 | SEE ALSO: 39 | https://github.com/abrt/abrt/blob/master/src/hooks/abrt_exception_handler.py.in 40 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | README -------------------------------------------------------------------------------- /notes: -------------------------------------------------------------------------------- 1 | We are not running as root, and we do not want to handle privilege 2 | escalation, so writing to /var/lib/systemd/coredump is out of 3 | question. We must send a single message to the journal. 4 | 5 | For coredumps, we send: 6 | specified in sys.core_pattern: 7 | COREDUMP_PID=16216 8 | COREDUMP_UID=1002 9 | COREDUMP_GID=1002 10 | COREDUMP_SIGNAL=6 11 | COREDUMP_TIMESTAMP=1477530183000000 12 | COREDUMP_RLIMIT=18446744073709551615 13 | 14 | gathered by the sys.core_pattern executable: 15 | COREDUMP_COMM= 16 | COREDUMP_EXE= 17 | COREDUMP_UNIT= 18 | COREDUMP_USER_UNIT= 19 | COREDUMP_OWNER_UID= 20 | COREDUMP_SLICE= 21 | COREDUMP_CMDLINE= 22 | COREDUMP_CGROUP= 23 | COREDUMP_OPEN_FDS= 24 | COREDUMP_PROC_STATUS= 25 | COREDUMP_PROC_MAPS= 26 | COREDUMP_PROC_LIMITS= 27 | COREDUMP_PROC_MOUNTINFO= 28 | COREDUMP_CWD= 29 | COREDUMP_ROOT= 30 | COREDUMP_ENVIRON= 31 | COREDUMP_CONTAINER_CMDLINE= 32 | MESSAGE_ID=fc2e22bc6ee647b6b90729ab34a250b1 33 | 34 | attached by the secondary handler: 35 | COREDUMP_FILENAME=/var/lib/systemd/coredump/core.lt-test-path-ut.1002.6bece0304e694e37a39f2c061b403f8c.16216.1477530183000 36 | MESSAGE=Process 16216 (lt-test-path-ut) of user 1002 dumped core. 37 | 38 | Stack trace of thread 16216: 39 | #0 0x00007f6ab00a092f __GI_raise (libc.so.6) 40 | #1 0x00007f6ab00a252a __GI_abort (libc.so.6) 41 | #2 0x00007f6ab06bdb92 log_assert_failed (libsystemd-shared-231.so) 42 | #3 0x00005622f5e0af32 test_path_startswith (lt-test-path-util) 43 | #4 0x00005622f5e0ce20 main (lt-test-path-util) 44 | #5 0x00007f6ab008b401 __libc_start_main (libc.so.6) 45 | #6 0x00005622f5e077ba _start (lt-test-path-util) 46 | 47 | For exceptions, we would gather: 48 | COREDUMP_PID 49 | COREDUMP_UID 50 | COREDUMP_GID 51 | COREDUMP_GID 52 | COREDUMP_TIMESTAMP 53 | COREDUMP_RLIMIT 54 | 55 | COREDUMP_PYTHON_EXCEPTION 56 | COREDUMP_PYTHON_BACKTRACE 57 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # -*- coding:utf-8 -*- 2 | import site 3 | import sys 4 | import sysconfig 5 | from setuptools import setup 6 | 7 | if '--user' in sys.argv: # There must be a better way to do this, 8 | # if you know it, please tell me. 9 | packages_path = site.getusersitepackages() 10 | else: 11 | packages_path = sysconfig.get_path('purelib') 12 | 13 | version = '3' 14 | 15 | setup (name = 'systemd-coredump-python', 16 | version = version, 17 | description = 'sys.excepthook helper to log Python exceptions in the journal via systemd-coredump', 18 | long_description = open('README').read(), 19 | author = 'Zbigniew Jędrzejewski-Szmek', 20 | author_email = 'zbyszek@in.waw.pl', 21 | url = 'https://github.com/systemd/systemd-coredump-python', 22 | license = 'GPLv2+', 23 | classifiers = [ 24 | 'Programming Language :: Python :: 2', 25 | 'Programming Language :: Python :: 3', 26 | 'Topic :: Software Development :: Libraries :: Python Modules', 27 | 'Topic :: System :: Logging', 28 | 'License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)', 29 | ], 30 | py_modules = ['systemd_coredump_exception_handler'], 31 | data_files = [(packages_path, ["systemd_coredump.pth"])], 32 | ) 33 | -------------------------------------------------------------------------------- /systemd_coredump.pth: -------------------------------------------------------------------------------- 1 | import systemd_coredump_exception_handler; systemd_coredump_exception_handler.install() 2 | -------------------------------------------------------------------------------- /systemd_coredump_exception_handler.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # Copyright (C) 2014 Red Hat, Inc. 4 | # Copyright (C) 2016 Zbigniew Jędrzejewski-Szmek 5 | # 6 | # This program is free software; you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation; either version 2 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program; if not, write to the Free Software 18 | # Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335 USA 19 | 20 | """ 21 | sys.excepthook helper to log exceptions in the journal via systemd-coredump 22 | 23 | This module is compatible with Python 2.x and Python 3.x. Any semi-recent 24 | version should be supported. 25 | """ 26 | 27 | import sys 28 | 29 | _sys_excepthook = None 30 | 31 | def _write_journal_field(pipe, name, value): 32 | import struct 33 | 34 | name = name.encode('ascii') 35 | value = value.encode('utf-8') 36 | 37 | pipe.write(name + b'\n' + 38 | struct.pack(' this exception is not an error 92 | if isinstance(e, (KeyboardInterrupt, SystemExit)): 93 | return True 94 | 95 | # Ignore EPIPE: it happens all the time 96 | # Testcase: script.py | true, where script.py is: 97 | ## #!/usr/bin/python 98 | ## import os 99 | ## import time 100 | ## time.sleep(1) 101 | ## os.write(1, "Hello\n") # print "Hello" wouldn't be the same 102 | # 103 | if isinstance(e, (IOError, OSError)) and e.errno == errno.EPIPE: 104 | return True 105 | 106 | # Ignore interactive Python and similar 107 | # Check for first "-" is meant to catch "-c" which appears in this case: 108 | ## $ python -c 'import sys; print "argv0 is:%s" % sys.argv[0]' 109 | ## argv0 is:-c 110 | if not sys.argv[0] or sys.argv[0].startswith('-'): 111 | return True 112 | 113 | return False 114 | 115 | def _handle_exception(etype, value, tb): 116 | import traceback 117 | 118 | long = traceback.format_exception(etype, value, tb) 119 | text = ''.join(long) 120 | if tb is not None and etype != IndentationError: 121 | while tb.tb_next: 122 | tb = tb.tb_next 123 | frame = tb.tb_frame 124 | try: 125 | text += ('\nLocal variables in innermost frame:\n' + 126 | '\n'.join(' {}={!r}'.format(key, val) 127 | for key, val in frame.f_locals.items())) 128 | except Exception: 129 | pass 130 | 131 | # Send data to the journal 132 | _log_exception(etype, value, text) 133 | 134 | def systemd_coredump_handle_exception(etype, value, tb): 135 | """Send the exception to systemd-journald via systemd-coredump. 136 | 137 | After systemd-coredump is done, passes control back to call the 138 | original hook. 139 | """ 140 | try: 141 | if not _ignore_exception(value): 142 | _handle_exception(etype, value, tb) 143 | except Exception: 144 | # Ignore any and all errors 145 | pass 146 | 147 | return _sys_excepthook(etype, value, tb) 148 | 149 | def systemd_coredump_enabled(): 150 | "Returns True if kernel.core_pattern sysctl invokes systemd-coredump" 151 | with open('/proc/sys/kernel/core_pattern', 'rt') as f: 152 | text = f.read() 153 | return text.startswith('|') and 'systemd-coredump' in text 154 | 155 | def install(nocheck=False): 156 | """Install the handler function as sys.excepthook. 157 | 158 | The original hook is stored as _sys_excepthook. 159 | Failure is silent. 160 | """ 161 | global _sys_excepthook 162 | if _sys_excepthook is not None: 163 | # never install ourselves twice. In particular our .pth file could be 164 | # installed in multiple locations (e.g. in user and system-specific 165 | # directories), and we'd fall into infinite recursion below. 166 | return 167 | try: 168 | if nocheck or systemd_coredump_enabled(): 169 | _sys_excepthook = sys.excepthook 170 | sys.excepthook = systemd_coredump_handle_exception 171 | except Exception: 172 | pass 173 | 174 | if __name__ == '__main__': 175 | # throw a nested test exception to show the effect 176 | def f(): 177 | a = 3 178 | h = f 179 | div0 = 1 / 0 180 | def g(): 181 | f() 182 | g() 183 | -------------------------------------------------------------------------------- /tests/indentation_fail.py: -------------------------------------------------------------------------------- 1 | x = 3 2 | y = 4 3 | -------------------------------------------------------------------------------- /tests/test_indentation.py: -------------------------------------------------------------------------------- 1 | import systemd_coredump_exception_handler 2 | import indentation_fail 3 | --------------------------------------------------------------------------------