File: PKG-INFO

package info (click to toggle)
graypy 1.1.3-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 220 kB
  • sloc: python: 817; makefile: 3
file content (248 lines) | stat: -rw-r--r-- 8,583 bytes parent folder | download | duplicates (2)
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
Metadata-Version: 2.1
Name: graypy
Version: 1.1.3
Summary: Python logging handler that sends messages in Graylog Extended Log Format (GLEF).
Home-page: https://github.com/severb/graypy
Author: Sever Banesiu
Author-email: banesiu.sever@gmail.com
License: BSD License
Description: |PyPI_Status|
        |Build_Status|
        |Coverage_Status|
        
        Description
        ===========
        
        Python logging handlers that send messages in the Graylog Extended
        Log Format (GELF_).
        
        Installing
        ==========
        
        Using pip
        ---------
        
        Install the basic graypy python logging handlers
        
        .. code-block:: bash
        
            pip install graypy
        
        Install with requirements for ``GELFRabbitHandler``
        
        .. code-block:: bash
        
            pip install graypy[amqp]
        
        Using easy_install
        ------------------
        
        Install the basic graypy python logging handlers
        
        .. code-block:: bash
        
           easy_install graypy
        
        Install with requirements for ``GELFRabbitHandler``
        
        .. code-block:: bash
        
          easy_install graypy[amqp]
        
        Usage
        =====
        
        Messages are sent to Graylog2 using a custom handler for the builtin logging
        library in GELF format
        
        .. code-block:: python
        
            import logging
            import graypy
        
            my_logger = logging.getLogger('test_logger')
            my_logger.setLevel(logging.DEBUG)
        
            handler = graypy.GELFUDPHandler('localhost', 12201)
            my_logger.addHandler(handler)
        
            my_logger.debug('Hello Graylog2.')
        
        Alternately, use ``GELFRabbitHandler`` to send messages to RabbitMQ and
        configure your Graylog2 server to consume messages via AMQP. This prevents
        log messages from being lost due to dropped UDP packets (``GELFUDPHandler``
        sends messages to Graylog2 using UDP). You will need to configure RabbitMQ
        with a 'gelf_log' queue and bind it to the 'logging.gelf' exchange so
        messages are properly routed to a queue that can be consumed by
        Graylog2 (the queue and exchange names may be customized to your liking)
        
        .. code-block:: python
        
            import logging
            import graypy
        
            my_logger = logging.getLogger('test_logger')
            my_logger.setLevel(logging.DEBUG)
        
            handler = graypy.GELFRabbitHandler('amqp://guest:guest@localhost/', exchange='logging.gelf')
            my_logger.addHandler(handler)
        
            my_logger.debug('Hello Graylog2.')
        
        Tracebacks are added as full messages
        
        .. code-block:: python
        
            import logging
            import graypy
        
            my_logger = logging.getLogger('test_logger')
            my_logger.setLevel(logging.DEBUG)
        
            handler = graypy.GELFUDPHandler('localhost', 12201)
            my_logger.addHandler(handler)
        
            try:
                puff_the_magic_dragon()
            except NameError:
                my_logger.debug('No dragons here.', exc_info=1)
        
        
        For more detailed usage information please see the documentation provided
        within graypy's handler's docstrings.
        
        Using with Django
        =================
        
        It's easy to integrate ``graypy`` with Django's logging settings. Just add a
        new handler in your ``settings.py``:
        
        .. code-block:: python
        
            LOGGING = {
                ...
        
                'handlers': {
                    'graypy': {
                        'level': 'WARNING',
                        'class': 'graypy.GELFUDPHandler',
                        'host': 'localhost',
                        'port': 12201,
                    },
                },
        
                'loggers': {
                    'django.request': {
                        'handlers': ['graypy'],
                        'level': 'ERROR',
                        'propagate': True,
                    },
                },
            }
        
        Custom fields
        =============
        
        A number of custom fields are automatically added if available:
            * function
            * pid
            * process_name
            * thread_name
        
        You can disable these additional fields if you don't want them by adding
        an the ``debugging_fields=False`` to the handler:
        
        .. code-block:: python
        
            handler = graypy.GELFUDPHandler('localhost', 12201, debugging_fields=False)
        
        graypy also supports additional fields to be included in the messages sent
        to Graylog2. This can be done by using Python's LoggerAdapter_ and
        Filter_. In general, LoggerAdapter makes it easy to add static information
        to your log messages and Filters give you more flexibility, for example to
        add additional information based on the message that is being logged.
        
        Example using LoggerAdapter_
        
        .. code-block:: python
        
            import logging
            import graypy
        
            my_logger = logging.getLogger('test_logger')
            my_logger.setLevel(logging.DEBUG)
        
            handler = graypy.GELFUDPHandler('localhost', 12201)
            my_logger.addHandler(handler)
        
            my_adapter = logging.LoggerAdapter(logging.getLogger('test_logger'),
                                               {'username': 'John'})
        
            my_adapter.debug('Hello Graylog2 from John.')
        
        Example using Filter_
        
        .. code-block:: python
        
            import logging
            import graypy
        
            class UsernameFilter(logging.Filter):
                def __init__(self):
                    # In an actual use case would dynamically get this
                    # (e.g. from memcache)
                    self.username = "John"
        
                def filter(self, record):
                    record.username = self.username
                    return True
        
            my_logger = logging.getLogger('test_logger')
            my_logger.setLevel(logging.DEBUG)
        
            handler = graypy.GELFUDPHandler('localhost', 12201)
            my_logger.addHandler(handler)
        
            my_logger.addFilter(UsernameFilter())
        
            my_logger.debug('Hello Graylog2 from John.')
        
        Contributors:
        
          * Sever Banesiu
          * Daniel Miller
          * Tushar Makkar
          * Nathan Klapstein
        
        .. _GELF: http://docs.graylog.org/en/latest/pages/gelf.html
        .. _LoggerAdapter: http://docs.python.org/howto/logging-cookbook.html#using-loggeradapters-to-impart-contextual-information
        .. _Filter: http://docs.python.org/howto/logging-cookbook.html#using-filters-to-impart-contextual-information
        
        .. |Build_Status| image:: https://travis-ci.org/severb/graypy.svg?branch=master
            :target: https://travis-ci.org/severb/graypy
        
        
        .. |Coverage_Status| image:: https://codecov.io/gh/severb/graypy/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/severb/graypy
        
        .. |PyPI_Status| image:: https://img.shields.io/pypi/v/graypy.svg
            :target: https://pypi.python.org/pypi/graypy
Keywords: logging gelf graylog2 graylog udp amqp
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: System :: Logging
Description-Content-Type: text/x-rst
Provides-Extra: amqp