├── .gitignore ├── AUTHORS.txt ├── CHANGES.rst ├── CLASSIFIERS.txt ├── LICENSE ├── MANIFEST.in ├── README.rst ├── REQUIREMENTS.txt ├── flask_monitor ├── __init__.py ├── influxdb.py ├── log.py ├── main.py ├── rabbitmq.py ├── statsd.py ├── util.py └── zeromq.py ├── setup.py └── test └── test.py /.gitignore: -------------------------------------------------------------------------------- 1 | # ignore python compile 2 | *.pyc 3 | __pycache__ 4 | # ignore pip file 5 | /dist 6 | /tests 7 | /*.egg-info 8 | # ignore file swp vi 9 | *.swp 10 | -------------------------------------------------------------------------------- /AUTHORS.txt: -------------------------------------------------------------------------------- 1 | Frédéric Aoustin::fraoustin@gmail.com 2 | -------------------------------------------------------------------------------- /CHANGES.rst: -------------------------------------------------------------------------------- 1 | V. 0.2.6 2 | ======== 3 | 4 | - hotfix Issue#5 manage import influxdb 5 | 6 | V. 0.2.5 7 | ======== 8 | 9 | - hotfix requirement 10 | 11 | V. 0.2.4 12 | ======== 13 | 14 | - Add ssl, verify_ssl as options for ObserverInfluxdb 15 | 16 | V. 0.2.3 17 | ======== 18 | 19 | - correction setup.py by sujaymansingh 20 | 21 | 22 | V. 0.2.2 23 | ======== 24 | 25 | - correction statd by sujaymansingh 26 | 27 | V. 0.2.1 28 | ======== 29 | 30 | - add logger debug for start end finish request 31 | 32 | V. 0.2.0 33 | ======== 34 | 35 | - change manage logger of ObserverMetrics 36 | 37 | V. 0.1.3 38 | ======== 39 | 40 | - hotfix for name pkg 41 | 42 | V. 0.1.2 43 | ======== 44 | 45 | - manage logger default 46 | 47 | V. 0.1.1 48 | ======== 49 | 50 | - manage setup.py generic 51 | 52 | V. 0.1.0 53 | ======== 54 | 55 | - init 56 | -------------------------------------------------------------------------------- /CLASSIFIERS.txt: -------------------------------------------------------------------------------- 1 | Programming Language :: Python 2 | License :: OSI Approved :: GNU General Public License v2 (GPLv2) 3 | Operating System :: OS Independent 4 | Programming Language :: Python :: 2.7 5 | Programming Language :: Python :: 3 6 | Programming Language :: Python :: 3.0 7 | Programming Language :: Python :: 3.1 8 | Programming Language :: Python :: 3.2 9 | Programming Language :: Python :: 3.3 10 | Programming Language :: Python :: 3.4 11 | Programming Language :: Python :: 3.5 12 | Programming Language :: Python :: 3.6 13 | Topic :: Software Development :: Libraries :: Python Modules 14 | Environment :: Web Environment 15 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | {description} 294 | Copyright (C) {year} {fullname} 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 | {signature of Ty Coon}, 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 LICENSE 2 | include README.rst 3 | include CHANGES.rst 4 | include AUTHORS.txt 5 | include REQUIREMENTS.txt 6 | include CLASSIFIERS.txt 7 | recursive-include flask_monitor *.* 8 | exclude test 9 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | Flask-monitor 2 | ============= 3 | 4 | Generate time of execution and send data on multi destination 5 | 6 | - log 7 | - influxdb (and so grafana) 8 | - rabbitmq 9 | - zeromq 10 | - statsd 11 | 12 | 13 | Installation 14 | ------------ 15 | 16 | :: 17 | 18 | pip install flask-monitor 19 | 20 | Or 21 | 22 | :: 23 | 24 | git clone https://github.com/fraoustin/flask-monitor.git 25 | cd flask-monitor 26 | python setup.py install 27 | 28 | Usage 29 | ----- 30 | 31 | 32 | :: 33 | 34 | from flask import Flask, request 35 | from flask_monitor import Monitor , ObserverLog 36 | import logging 37 | 38 | app = Flask(__name__) 39 | monitor = Monitor('monitor', __name__) 40 | app.register_blueprint(monitor) 41 | monitor.add_observer(ObserverLog()) 42 | 43 | @app.route("/") 44 | def hello(): 45 | return "Hello World!" 46 | 47 | if __name__ == "__main__": 48 | app.logger.setLevel(logging.INFO) 49 | for h in app.logger.handlers: 50 | h.setLevel(logging.INFO) 51 | app.run(port=8080) 52 | 53 | You can add a filter of event 54 | 55 | :: 56 | 57 | from flask import Flask, request 58 | from flask_monitor import Monitor , ObserverLog 59 | 60 | def filterExt(event): 61 | return event.response.status_code == 400 62 | 63 | app = Flask(__name__) 64 | monitor = Monitor('monitor', __name__) 65 | app.register_blueprint(monitor) 66 | monitor.add_observer(ObserverLog(filter=filterExt)) 67 | 68 | @app.route("/") 69 | def hello(): 70 | return "Hello World!" 71 | 72 | if __name__ == "__main__": 73 | app.run(port=8080) 74 | 75 | 76 | You can create your own observer 77 | 78 | :: 79 | 80 | from flask import Flask, request 81 | from flask_monitor import Monitor , ObserverLog 82 | 83 | class myeventlog(ObserverMetrics): 84 | 85 | def __init__(self): 86 | ObserverMetrics.__init__(self, filter=self.filter) 87 | 88 | def action(self, event): 89 | logging.getLogger().error(event.json) 90 | 91 | def filter(self, event): 92 | return event.response.status_code != 400 93 | 94 | app = Flask(__name__) 95 | monitor = Monitor('monitor', __name__) 96 | app.register_blueprint(monitor) 97 | monitor.add_observer(myeventlog()) 98 | 99 | @app.route("/") 100 | def hello(): 101 | return "Hello World!" 102 | 103 | if __name__ == "__main__": 104 | app.run(port=8080) 105 | 106 | 107 | Influxdb 108 | -------- 109 | 110 | :: 111 | 112 | pip install influxdb 113 | 114 | Usage 115 | 116 | :: 117 | 118 | from flask_monitor.influxdb import ObserverInfluxdb 119 | monitor.add_observer(ObserverInfluxdb(host='127.0.0.1', 120 | port=8086, 121 | user='root', 122 | password='root', 123 | db='mydb')) 124 | 125 | RabbitMq 126 | -------- 127 | 128 | :: 129 | 130 | pip install pika 131 | 132 | Usage 133 | 134 | :: 135 | 136 | from flask_monitor.rabbitmq import ObserverRabbit 137 | import pika 138 | 139 | monitor.add_observer(ObserverRabbit(host='127.0.0.1', 140 | credentials = pika.PlainCredentials('guest', 'guest'))) 141 | 142 | ZeroMq 143 | ------ 144 | 145 | :: 146 | 147 | pip install zmq 148 | 149 | Usage 150 | 151 | :: 152 | 153 | from flask_monitor.zeromq import ObserverZmq 154 | import zmq 155 | 156 | monitor.add_observer(ObserverZmq(context=zmq.Context(), 157 | addr='tcp://127.0.0.1:8080')) 158 | 159 | Statsd 160 | ------ 161 | 162 | :: 163 | 164 | pip install statsd 165 | 166 | Usage 167 | 168 | :: 169 | 170 | from flask_monitor.statsd import ObserverStatsd 171 | monitor.add_observer(ObserverStatsd(host='127.0.0.1', port=8125, format="{RequestUrl}")) 172 | 173 | 174 | -------------------------------------------------------------------------------- /REQUIREMENTS.txt: -------------------------------------------------------------------------------- 1 | Flask>=0.9 2 | six>=1.10.0 3 | -------------------------------------------------------------------------------- /flask_monitor/__init__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | 4 | """ 5 | Module flask_monitor 6 | """ 7 | 8 | 9 | from flask_monitor.main import * 10 | from flask_monitor.log import ObserverLog as ObserverLog 11 | -------------------------------------------------------------------------------- /flask_monitor/influxdb.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | from __future__ import absolute_import 3 | from flask_monitor import ObserverMetrics 4 | 5 | from influxdb import InfluxDBClient 6 | from influxdb.client import InfluxDBClientError 7 | 8 | 9 | class ObserverInfluxdb(ObserverMetrics): 10 | 11 | def __init__(self, host, port, user, password, db, ssl=False, verify_ssl=False, measure='flask', *args, **kw): 12 | ObserverMetrics.__init__(self, *args, **kw) 13 | self._data = [ 14 | { 15 | "measurement": measure, 16 | "tags": {}, 17 | "fields": {}, 18 | } 19 | ] 20 | try: 21 | self.db = InfluxDBClient(host=host, 22 | port=port, 23 | username=user, 24 | password=password, 25 | database=db, 26 | ssl=ssl, 27 | verify_ssl=verify_ssl) 28 | except InfluxDBClientError: 29 | self.logger.critical("Cannot connect to InfluxDB database '%s'" % db) 30 | 31 | 32 | def action(self, event): 33 | try: 34 | data = self._data 35 | data[0]['tags'] = event.dict 36 | data[0]['fields'] = {"value": event.timing} 37 | self.db.write_points(data) 38 | except InfluxDBClientError as e: 39 | self.logger.critical("Error InfluxDB '%s'" % str(e)) 40 | except Exception as e: 41 | self.logger.critical("Error Unknow on InfluxDB '%s'" % str(e)) 42 | -------------------------------------------------------------------------------- /flask_monitor/log.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | from flask_monitor import ObserverMetrics 4 | 5 | class ObserverLog(ObserverMetrics): 6 | 7 | def __init__(self, format="{TimingAsctime} {RequestUrl} {TimingDelta} second(s)", *args, **kw): 8 | ObserverMetrics.__init__(self, *args, **kw) 9 | self._format = format 10 | 11 | def action(self, event): 12 | self.logger.info(self._format.format(**event.flat)) 13 | 14 | -------------------------------------------------------------------------------- /flask_monitor/main.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | from time import time, gmtime, asctime 3 | import logging 4 | import json 5 | from flask import current_app, request, Blueprint 6 | 7 | from .util import toflat, todict 8 | 9 | def everyTrue(event): 10 | return True 11 | 12 | class Event(object): 13 | 14 | def __init__(self, response, request, timing): 15 | self.response = response 16 | self.request = request 17 | self.timing = timing 18 | 19 | @property 20 | def _dict(self): 21 | mydict = {} 22 | # manage timing 23 | mydict['timing'] = {} 24 | mydict['timing']['delta'] = self.timing 25 | mydict['timing']['start'] = self.request._stats_start_event 26 | mydict['timing']['asctime'] = asctime(gmtime(self.request._stats_start_event)) 27 | # manage flask 28 | mydict['flask'] = {} 29 | mydict['flask']['secret_key'] = current_app.config['SECRET_KEY'] 30 | mydict['flask']['server_name'] = current_app.config['SERVER_NAME'] 31 | mydict['flask']['session_cookie_name'] = current_app.config['SESSION_COOKIE_NAME'] 32 | mydict['flask']['session_cookie_domain'] = current_app.config['SESSION_COOKIE_DOMAIN'] 33 | mydict['flask']['session_cookie_path'] = current_app.config['SESSION_COOKIE_PATH'] 34 | mydict['flask']['session_cookie_httponly'] = current_app.config['SESSION_COOKIE_HTTPONLY'] 35 | mydict['flask']['session_cookie_secure'] = current_app.config['SESSION_COOKIE_SECURE'] 36 | mydict['flask']['session_refresh_each_request'] = current_app.config['SESSION_REFRESH_EACH_REQUEST'] 37 | # manage request 38 | mydict['request'] = {} 39 | mydict['request']['url'] = request.url 40 | mydict['request']['args'] = {arg: request.args.get(arg) for arg in request.args} 41 | mydict['request']['view_args'] = request.view_args 42 | mydict['request']['path'] = request.path 43 | mydict['request']['method'] = request.method 44 | mydict['request']['remote_addr'] = request.remote_addr 45 | try: 46 | mydict['request']['rule'] = request.url_rule.rule 47 | except: 48 | mydict['request']['rule'] = '' 49 | #manage response 50 | mydict['response'] = {} 51 | mydict['response']['status_code'] = self.response.status_code 52 | mydict['response']['headers'] = { i:j for i,j in self.response.headers} 53 | return mydict 54 | 55 | @property 56 | def json(self): 57 | return json.dumps(self._dict) 58 | 59 | @property 60 | def flat(self): 61 | return toflat(self._dict) 62 | 63 | @property 64 | def dict(self): 65 | return todict(self._dict) 66 | 67 | 68 | class EventMetrics(object): 69 | 70 | def __init__(self): 71 | self._obs = [] 72 | 73 | def __iadd__(self, obs): 74 | if not callable(obs): 75 | raise TypeError("objet not callable") 76 | if obs not in self._obs: 77 | self._obs.append(obs) 78 | return self 79 | 80 | def __isub__(self, obs): 81 | if obs in self._obs: 82 | self._obs.remove(obs) 83 | return self 84 | 85 | def __call__(self, *args, **kw): 86 | [obs(*args, **kw) for obs in self._obs] 87 | 88 | class Singleton(type): 89 | _instances = {} 90 | 91 | def __call__(cls, *args, **kwargs): 92 | if cls not in cls._instances: 93 | cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs) 94 | return cls._instances[cls] 95 | 96 | # create a singleton for python3 97 | # 98 | # class Metrics(Blueprint, metaclass=Singleton): 99 | # 100 | # for compatible python2, I use module **six** 101 | 102 | import six 103 | 104 | @six.add_metaclass(Singleton) 105 | class Monitor(Blueprint): 106 | 107 | def __init__(self, *args, **kwargs): 108 | Blueprint.__init__(self, *args, **kwargs) 109 | self._event = EventMetrics() 110 | self.before_app_request(start_event) 111 | self.after_app_request(stop_event) 112 | 113 | def add_observer(self, obs): 114 | self._event += obs 115 | 116 | def del_observer(self, obs): 117 | self._event -= obs 118 | 119 | def add_metric(self, event): 120 | self._event(event) 121 | 122 | class ObserverMetrics(object): 123 | 124 | def __init__(self, filter=everyTrue, logger=None): 125 | self._filter = filter 126 | self._logger = logger 127 | 128 | @property 129 | def logger(self): 130 | if self._logger == None: 131 | return current_app.logger 132 | return self._logger 133 | 134 | def __call__(self, event): 135 | self.logger.debug('intercept event') 136 | if self._filter(event): 137 | self.action(event) 138 | 139 | def action(self, event): 140 | pass 141 | 142 | 143 | def start_event(): 144 | current_app.logger.debug("start request %s" % request.url) 145 | request._stats_start_event = time() 146 | 147 | def stop_event(response): 148 | stop = time() 149 | delta = stop - request._stats_start_event 150 | current_app.logger.debug("stop request %s" % request.url) 151 | Monitor().add_metric(Event(response, request, delta)) 152 | return response 153 | 154 | -------------------------------------------------------------------------------- /flask_monitor/rabbitmq.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | from flask_monitor import ObserverMetrics 4 | 5 | import pika 6 | 7 | 8 | class ObserverRabbit(ObserverMetrics): 9 | 10 | args_mq = ['host','port','virtual_host','credentials','channel_max','frame_max', 11 | 'heartbeat', 'ssl', 'ssl_options', 'connection_attempts', 'retry_delay', 12 | 'socket_timeout', 'locale', 'backpressure_detection', 'blocked_connection_timeout', 13 | 'client_properties'] 14 | 15 | def __init__(self, 16 | exchange='flask', 17 | routing_key='', 18 | *args, 19 | **kw): 20 | kw_mq = { key : kw[key] for key in kw if key in self.args_mq} 21 | kw = { key : kw[key] for key in kw if key not in self.args_mq} 22 | ObserverMetrics.__init__(self, *args, **kw) 23 | try: 24 | 25 | connection = pika.BlockingConnection(pika.ConnectionParameters(**kw_mq)) 26 | self.channel = connection.channel() 27 | self.exchange = exchange 28 | self.routing_key = routing_key 29 | try: 30 | self.channel.exchange_declare(exchange=exchange, 31 | type='fanout') 32 | self.logger.debug("Create channel RabbitMq '%s'" % exchange) 33 | except: 34 | self.logger.debug("Not create channel RabbitMq '%s'" % exchange) 35 | except Exception as e: 36 | self.logger.critical("Cannot connect to RabbitMq '%s'" % str(e)) 37 | 38 | 39 | def action(self, event): 40 | try: 41 | self.channel.basic_publish(exchange=self.exchange, 42 | routing_key=self.routing_key, 43 | body=event.json) 44 | except Exception as e: 45 | self.logger.critical("Error Unknow on RabbitMq '%s'" % str(e)) 46 | 47 | 48 | -------------------------------------------------------------------------------- /flask_monitor/statsd.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | from flask_monitor import ObserverMetrics 4 | 5 | import statsd 6 | 7 | 8 | class ObserverStatsd(ObserverMetrics): 9 | 10 | args_statsd = ['host', 'port', 'prefix', 'maxudpsize', 'ipv6'] 11 | 12 | def __init__(self,format="flask", 13 | *args, 14 | **kw): 15 | kw_statsd = { key : kw[key] for key in kw if key in self.args_statsd} 16 | kw = { key : kw[key] for key in kw if key not in self.args_statsd} 17 | ObserverMetrics.__init__(self, *args, **kw) 18 | self._format = format 19 | try: 20 | 21 | self.client = statsd.StatsClient(**kw_statsd) 22 | except Exception as e: 23 | self.logger.critical("Cannot connect to Statsd '%s'" % str(e)) 24 | 25 | 26 | def action(self, event): 27 | try: 28 | self.client.timing(self._format.format(**event.flat), event.timing) 29 | except Exception as e: 30 | self.logger.critical("Error Unknow on Statsd '%s'" % str(e)) 31 | 32 | 33 | -------------------------------------------------------------------------------- /flask_monitor/util.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | def toflat(obj, ns=""): 3 | res = {} 4 | for key in obj: 5 | if type(obj[key]) is dict: 6 | subdict = toflat(obj[key], "%s%s" % (ns,key[0].upper()+key[1:])) 7 | for k in subdict: 8 | res[k[0].upper()+k[1:]] = subdict[k] 9 | else: 10 | res["%s%s" % (ns, key[0].upper()+key[1:])] = str(obj[key]) 11 | return res 12 | 13 | def todict(obj): 14 | res = {} 15 | for key in obj: 16 | if type(obj[key]) is dict: 17 | subdict = todict(obj[key]) 18 | for k in subdict: 19 | res[k] = subdict[k] 20 | else: 21 | res[key] = obj[key] 22 | return res 23 | -------------------------------------------------------------------------------- /flask_monitor/zeromq.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | from flask_monitor import ObserverMetrics 4 | 5 | import zmq 6 | 7 | 8 | class ObserverZmq(ObserverMetrics): 9 | 10 | def __init__(self, 11 | context, 12 | addr, 13 | *args, 14 | **kw): 15 | ObserverMetrics.__init__(self, *args, **kw) 16 | try: 17 | self.sock = context.socket(zmq.PUB) 18 | self.sock.bind(addr) 19 | except Exception as e: 20 | self.logger.critical("Cannot connect to ZeroMq '%s'" % str(e)) 21 | 22 | 23 | def action(self, event): 24 | try: 25 | self.sock.send(event.json) 26 | except Exception as e: 27 | self.logger.critical("Error Unknow on ZeroMq '%s'" % str(e)) 28 | 29 | 30 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | """ 4 | Setup for flask-monitor 5 | """ 6 | 7 | import os 8 | from setuptools import setup, find_packages 9 | 10 | __version_info__ = (0, 2, 6) 11 | __version__ = '.'.join([str(val) for val in __version_info__]) 12 | 13 | __namepkg__ = "flask-monitor" 14 | __desc__ = "Flask Monitor module" 15 | __urlpkg__ = "https://github.com/fraoustin/flask-monitor.git" 16 | __entry_points__ = {} 17 | 18 | HERE = os.path.abspath(os.path.dirname(__file__)) 19 | 20 | # README AND CHANGES 21 | with open(os.path.join(HERE, 'README.rst')) as readme: 22 | with open(os.path.join(HERE, 'CHANGES.rst')) as changelog: 23 | LONG_DESC = readme.read() + '\n\n' + changelog.read() 24 | # REQUIREMENTS 25 | with open('REQUIREMENTS.txt') as f: 26 | REQUIRED = f.read().splitlines() 27 | # CLASSIFIERS 28 | with open('CLASSIFIERS.txt') as f: 29 | CLASSIFIED = f.read().splitlines() 30 | # AUTHORS 31 | with open('AUTHORS.txt') as f: 32 | DATA = f.read().splitlines() 33 | AUTHORS = ','.join([i.split('::')[0] for i in DATA]) 34 | AUTHORS_EMAIL = ','.join([i.split('::')[1] for i in DATA]) 35 | 36 | setup( 37 | name=__namepkg__, 38 | version=__version__, 39 | packages=find_packages(), 40 | author=AUTHORS, 41 | author_email=AUTHORS_EMAIL, 42 | description=__desc__, 43 | long_description=LONG_DESC, 44 | include_package_data=True, 45 | install_requires=REQUIRED, 46 | url=__urlpkg__, 47 | classifiers=CLASSIFIED, 48 | entry_points=__entry_points__ 49 | ) 50 | -------------------------------------------------------------------------------- /test/test.py: -------------------------------------------------------------------------------- 1 | 2 | from flask import Flask, request, current_app 3 | from flask_monitor import Monitor , ObserverMetrics 4 | from flask_monitor import ObserverLog 5 | 6 | import logging 7 | 8 | def filterExt(event): 9 | return event.response.status_code == 400 10 | 11 | 12 | class myeventlog(ObserverMetrics): 13 | 14 | def __init__(self): 15 | ObserverMetrics.__init__(self, filter=self.filter) 16 | 17 | def action(self, event): 18 | logging.getLogger().error(event.json) 19 | 20 | def filter(self, event): 21 | return event.response.status_code != 400 22 | 23 | app = Flask(__name__) 24 | monitor = Monitor('monitor', __name__) 25 | app.register_blueprint(monitor) 26 | #metric.add_observer(myeventlog()) 27 | monitor.add_observer(ObserverLog()) 28 | 29 | #from flask_monitor.influxdb import ObserverInfluxdb 30 | #monitor.add_observer(ObserverInfluxdb(host='127.0.0.1', 31 | # port=8086, 32 | # user='root', 33 | # password='root', 34 | # db='mydb')) 35 | 36 | #from flask_monitor.rabbitmq import ObserverRabbit 37 | #import pika 38 | 39 | #monitor.add_observer(ObserverRabbit(host='127.0.0.1', 40 | # credentials = pika.PlainCredentials('guest', 'guest'))) 41 | 42 | 43 | 44 | @app.route("/") 45 | def hello(): 46 | return "Hello World!" 47 | 48 | @app.route("/error") 49 | def warning(): 50 | return "error", 400 51 | 52 | @app.route('/search') 53 | def search(): 54 | location = request.args.get('location') 55 | return location 56 | 57 | @app.route('/coucou/') 58 | def coucou(location=None): 59 | return location 60 | 61 | if __name__ == "__main__": 62 | app.logger.setLevel(logging.INFO) 63 | for h in app.logger.handlers: 64 | h.setLevel(logging.INFO) 65 | app.run(port=8080) 66 | --------------------------------------------------------------------------------