├── .gitignore ├── LICENSE ├── MANIFEST.in ├── README.md ├── gelfclient ├── __init__.py ├── client.py └── tests │ ├── __init__.py │ └── test_udp.py └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Distribution / packaging 9 | .Python 10 | env/ 11 | bin/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | eggs/ 16 | lib/ 17 | lib64/ 18 | parts/ 19 | sdist/ 20 | var/ 21 | *.egg-info/ 22 | .installed.cfg 23 | *.egg 24 | 25 | # Installer logs 26 | pip-log.txt 27 | pip-delete-this-directory.txt 28 | 29 | # Unit test / coverage reports 30 | htmlcov/ 31 | .tox/ 32 | .coverage 33 | .cache 34 | nosetests.xml 35 | coverage.xml 36 | 37 | # Translations 38 | *.mo 39 | 40 | # Mr Developer 41 | .mr.developer.cfg 42 | .project 43 | .pydevproject 44 | 45 | # Rope 46 | .ropeproject 47 | 48 | # Django stuff: 49 | *.log 50 | *.pot 51 | 52 | # Sphinx documentation 53 | docs/_build/ 54 | 55 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include LICENSE 2 | include README.md 3 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | gelfclient 2 | ====== 3 | 4 | Python client for sending UDP messages in Graylog Extended Log Format (GELF). 5 | 6 | Messages are zlib compressed, and support GELF chunked encoding. 7 | 8 | Since messages are sent with UDP, the log method should return quickly and not raise an exception due to timeout. However an exception may be raised due to a DNS name resolution failure for the target hostname. 9 | 10 | 11 | Installation 12 | ====== 13 | pip install gelfclient 14 | 15 | 16 | Usage 17 | ====== 18 | ``` 19 | from gelfclient import UdpClient 20 | 21 | gelf_server = 'localhost' 22 | 23 | # Using mandatory arguments 24 | gelf = UdpClient(gelf_server) 25 | 26 | # Using all arguments 27 | gelf = UdpClient(gelf_server, port=12202, mtu=8000, source='macbook.local') 28 | 29 | # Bare minimum is to send a string, which will map to gelf['short_message'] 30 | gelf.log('server is DOWN') 31 | 32 | # 'source' and 'host' are the same. Defaults to socket.gethostname() but can be overridden 33 | gelf.log('server is DOWN', source='hostchecker') 34 | 35 | # Set extra fields 36 | gelf.log('status change', _state='DOWN', _server='macbook') 37 | 38 | # Set severity level 39 | import syslog 40 | gelf.log('unexpected error', level=syslog.LOG_CRIT) 41 | 42 | # You can also prepare all data into a dictionary and give that to .log 43 | data = {} 44 | data['short_message'] = 'warning from python' 45 | data['host'] = 'hostchecker' 46 | data['level'] = syslog.LOG_WARNING 47 | gelf.log(data) 48 | ``` 49 | 50 | See the GELF specification for other fields and their meaning: 51 | http://docs.graylog.org/en/latest/pages/gelf.html#gelf-format-specification 52 | -------------------------------------------------------------------------------- /gelfclient/__init__.py: -------------------------------------------------------------------------------- 1 | __version__ = '0.0.7' 2 | from .client import UdpClient 3 | -------------------------------------------------------------------------------- /gelfclient/client.py: -------------------------------------------------------------------------------- 1 | import socket 2 | import zlib 3 | import json 4 | import math 5 | import struct 6 | import sys 7 | import copy 8 | from datetime import datetime 9 | 10 | string_types = str if sys.version_info.major == 3 else basestring 11 | xrange = range if sys.version_info.major == 3 else xrange 12 | 13 | class UdpClient(): 14 | 15 | UDPSock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) 16 | 17 | def __init__(self, server, port=12201, mtu=1450, source=None): 18 | assert isinstance(server, string_types) 19 | assert mtu > 12 20 | 21 | self.server = server 22 | self.port = int(port) 23 | self.mtu = int(mtu) 24 | self.source = source if source else socket.gethostname() 25 | 26 | def chunks(self, data): 27 | chunk_size = self.mtu - 12 # leave space for GELF chunked header 28 | totalChunks = int(math.ceil(len(data) / float(chunk_size))) 29 | assert(totalChunks <= 128) 30 | count = 0 31 | messageId = hash(str(datetime.now().microsecond) + self.source) 32 | for i in xrange(0, len(data), chunk_size): 33 | header = struct.pack("!ccqBB", b'\x1e', b'\x0f', messageId, count, totalChunks) 34 | count += 1 35 | yield header + data[i:i+chunk_size] 36 | 37 | def log(self, _fields_dict = {}, **fields_named): 38 | if isinstance(_fields_dict, string_types): 39 | _fields_dict = { 'short_message': _fields_dict } 40 | 41 | message = copy.deepcopy( _fields_dict) 42 | message.update( fields_named) 43 | message['version'] = '1.1' 44 | if 'short_message' not in message: 45 | message['short_message'] = 'null' 46 | if 'host' not in message: 47 | if 'source' in message: 48 | message['host'] = message['source'] 49 | else: 50 | message['host'] = self.source 51 | level = int(message.get('level', 1)) # Default severity / level is alert (1) 52 | assert(0 <= level <= 7) 53 | message['level'] = level 54 | 55 | message_str = json.dumps(message).encode('utf-8') 56 | output = zlib.compress(message_str) 57 | if len(output) > self.mtu: 58 | for chunk in self.chunks(output): 59 | self.UDPSock.sendto(chunk, (self.server, self.port)) 60 | else: 61 | self.UDPSock.sendto(output, (self.server, self.port)) 62 | 63 | return message 64 | -------------------------------------------------------------------------------- /gelfclient/tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orionvm/python-gelfclient/a8e3219d8657fbaed2e2b61767ca0bc3178a5418/gelfclient/tests/__init__.py -------------------------------------------------------------------------------- /gelfclient/tests/test_udp.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | import socket 4 | import time 5 | import string 6 | import random 7 | import unittest 8 | from gelfclient import UdpClient as GelfUdp 9 | 10 | string_types = str if sys.version_info[0] == 3 else basestring 11 | 12 | HOST = os.environ.get('GELF_TEST_HOST', 'localhost') 13 | PORT = int(os.environ.get('GELF_TEST_PORT', '12201')) 14 | 15 | print('Sending UDP GELF packets to %s:%s' % (HOST, PORT)) 16 | 17 | def random_string(length): 18 | return ''.join(random.choice(string.ascii_uppercase + string.digits) for _ in range(int(length))) 19 | 20 | 21 | class TestUdp(unittest.TestCase): 22 | def test_init(self): 23 | gelf = GelfUdp(HOST, PORT) 24 | self.assertEqual(gelf.server, HOST) 25 | self.assertIsInstance(gelf.port, int) 26 | self.assertEqual(gelf.source, socket.gethostname()) 27 | 28 | def test_log_minimum(self): 29 | gelf = GelfUdp(HOST, PORT) 30 | jsn = gelf.log(sys._getframe().f_code.co_name) 31 | msg = jsn['short_message'] 32 | self.assertEqual(msg, sys._getframe().f_code.co_name) 33 | self.assertEqual(jsn['host'], socket.gethostname()) 34 | self.assertIsInstance(jsn['version'], string_types) 35 | 36 | def test_log_source(self): 37 | gelf = GelfUdp(HOST, PORT, source='source') 38 | jsn = gelf.log(sys._getframe().f_code.co_name) 39 | self.assertEqual(jsn['host'], 'source') 40 | 41 | def test_log_source_override(self): 42 | gelf = GelfUdp(HOST, PORT, source='source') 43 | jsn = gelf.log(sys._getframe().f_code.co_name, source='notsource') 44 | self.assertEqual(jsn['host'], 'notsource') 45 | jsn = gelf.log(sys._getframe().f_code.co_name, host='notsource') 46 | self.assertEqual(jsn['host'], 'notsource') 47 | 48 | def test_log_extra_value(self): 49 | gelf = GelfUdp(HOST, PORT) 50 | jsn = gelf.log(sys._getframe().f_code.co_name, server='server', test='test') 51 | self.assertEqual(jsn['server'], 'server') 52 | self.assertEqual(jsn['test'], 'test') 53 | 54 | def test_log_timestamp(self): 55 | gelf = GelfUdp(HOST, PORT) 56 | ts = time.time() - 120 # override timestamp 2 mintes in past 57 | jsn = gelf.log(sys._getframe().f_code.co_name, timestamp = ts) 58 | self.assertEqual(jsn['timestamp'], ts) 59 | 60 | def test_log_chunked(self): 61 | gelf = GelfUdp(HOST, PORT, mtu=50) 62 | data = random_string(gelf.mtu * 5) 63 | jsn = gelf.log(sys._getframe().f_code.co_name, data=data) 64 | 65 | def test_log_chunked_small_mtu(self): 66 | gelf = GelfUdp(HOST, PORT, mtu=50) 67 | data = random_string(gelf.mtu * 5) 68 | jsn = gelf.log(sys._getframe().f_code.co_name, data=data) 69 | 70 | def test_default_log_level(self): 71 | gelf = GelfUdp(HOST, PORT) 72 | jsn = gelf.log(sys._getframe().f_code.co_name) 73 | self.assertEqual(jsn['level'], 1) 74 | 75 | def test_different_log_level(self): 76 | gelf = GelfUdp(HOST, PORT) 77 | for level in [0, 4, '0', '3', '7']: 78 | jsn = gelf.log(sys._getframe().f_code.co_name, level=level) 79 | self.assertEqual(jsn['level'], int(level)) 80 | 81 | def test_out_of_range_level(self): 82 | gelf = GelfUdp(HOST, PORT) 83 | for level in [-1, 8]: 84 | with self.assertRaises(AssertionError): 85 | jsn = gelf.log(sys._getframe().f_code.co_name, level=level) 86 | 87 | def test_wrong_type_for_level(self): 88 | gelf = GelfUdp(HOST, PORT) 89 | with self.assertRaises(ValueError): 90 | jsn = gelf.log(sys._getframe().f_code.co_name, level='not a number!') 91 | 92 | def main(): 93 | unittest.main() 94 | 95 | if __name__ == '__main__': 96 | main() 97 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import os 2 | from setuptools import setup 3 | 4 | try: 5 | from pypandoc import convert 6 | read_md = lambda f: convert(f, 'rst') 7 | except ImportError: 8 | print("warning: pypandoc module not found, could not convert Markdown to RST") 9 | read_md = lambda f: open(f, 'r').read() 10 | 11 | from gelfclient import __version__ 12 | setup( 13 | name = "gelfclient", 14 | version = __version__, 15 | author = "Chris McClymont", 16 | author_email = "chris@mcclymont.it", 17 | description = "A UDP client for sending message in the Graylog Extended Log Format (GELF)", 18 | license = "Apache v2", 19 | keywords = "gelf, graylog, graylog2, logging", 20 | url = "http://github.com/orionvm/python-gelfclient", 21 | packages = ['gelfclient'], 22 | long_description=read_md('README.md'), 23 | classifiers=[ 24 | "Development Status :: 3 - Alpha", 25 | "Topic :: Utilities", 26 | "Topic :: System :: Logging" 27 | ], 28 | test_suite='gelfclient.tests', 29 | ) 30 | --------------------------------------------------------------------------------