Package: pylogops
pylogopsReally simple json formatter for python projects.StatusInstallationpipinstallpylogpsif you want use with python2.6 you must install the backport ordereddict as well:pipinstallordereddictBasic usageYou will have to specify the formatterJsonFormatterin any handler that you use in standar python logging:importloggingimporttimefrompylogops.loggerimportJsonFormatterfile_handler=logging.FileHandler('/tmp/my_log.log',encoding='UTF-8')file_handler.setFormatter(JsonFormatter(converter=time.localtime))logging.basicConfig()logger=logging.getLogger("my_logger")logger.addHandler(file_handler)logger.setLevel(logging.INFO)logger.info("Msg")this will produce a log in json:{"time":"2015-12-09T17:46:01.160Z","lvl":"INFO","corr":null,"trans":null,"op":null,"comp":"<stdin>","msg":"Msg"}To log in console change FileHandler by an StreamHandler:importloggingimporttimefrompylogops.loggerimportJsonFormatterconsole_handler=logging.StreamHandler()console_handler.setFormatter(JsonFormatter(converter=time.localtime))logging.basicConfig()logger=logging.getLogger("my_logger")logger.addHandler(console_handler)logger.setLevel(logging.INFO)logger.info("Msg")pylogpsby default generate all the upper fields in json output, but you can select to remove null fields:importloggingimporttimefrompylogops.loggerimportJsonFormatterfile_handler=logging.FileHandler('/tmp/my_log.log',encoding='UTF-8')file_handler.setFormatter(JsonFormatter(remove_blanks=True))logging.basicConfig()logger=logging.getLogger("my_logger")logger.addHandler(file_handler)logger.setLevel(logging.INFO)logger.info("Msg")this will produce a log in json:{"time":"2015-12-09T16:57:00.784Z","lvl":"INFO","comp":"<stdin>","msg":"Msg"}You can configure the formatter in any way provided by python logging library, e.g (dictConfig, fileConfig, …). You can check unit tests directory for some example.Advanced usageContext supportTracking filterPylogps includes a filter and a local_context to support using a context holding information about a correlator (corr), transaction (trans) and operation (op).
If you include the values using local_context, those fields will be available in formatter. You need to add a Filter:importloggingimporttimefrompylogops.loggerimportTrackingFilter,JsonFormatterfile_handler=logging.FileHandler('/tmp/my_log.log',encoding='UTF-8')file_handler.addFilter(TrackingFilter())file_handler.setFormatter(JsonFormatter(remove_blanks=True))logging.basicConfig()logger=logging.getLogger("my_logger")logger.addHandler(file_handler)logger.setLevel(logging.INFO)frompylogopsimportlocal_contextlocal_context.trans="trans"local_context.corr="corr"local_context.op="op"logger.info("Msg")This will produce the json log:{"time":"2015-12-10T15:23:52.117Z","lvl":"INFO","corr":"corr","trans":"trans","op":"op","comp":"<stdin>","msg":"Msg"}local_context is a thread.local() that is shared in current thread for all modules; typically you will include the values in a middleware or some kind of transversal module.Customizing json fieldsYou can specify the fields for output in json in this way:importloggingimporttimefrompylogops.loggerimportJsonFormatterfile_handler=logging.FileHandler('/tmp/my_log.log',encoding='UTF-8')file_handler.setFormatter(JsonFormatter(keys_fmt=[('lvl','levelname'),('msg','message')]))logging.basicConfig()logger=logging.getLogger("my_logger")logger.addHandler(file_handler)logger.setLevel(logging.INFO)logger.info("Msg")this will produce a log in json:{"lvl":"INFO","msg":"Msg"}Note that if you set this formatter field you should provide ALL required fields for json (even those without change).Static filterA filter provided to include static content to python logger. All keyword args used in the initialization of the filter
will be automatically provided as values for any formatter.importloggingimporttimefrompylogops.loggerimportStaticFilter,JsonFormatterconsole_handler=logging.StreamHandler()console_handler.addFilter(StaticFilter(version="1.2"))console_handler.setFormatter(JsonFormatter(remove_blanks=True,keys_fmt=[('lvl','levelname'),('msg','message'),('version','version')]))logger=logging.getLogger("my_logger")logger.addHandler(console_handler)logger.setLevel(logging.INFO)logger.info("Msg")This will produce the json log:{"time":"2015-12-10T15:23:52.117Z","lvl":"INFO","version":"1.2","comp":"<stdin>","msg":"Msg"}Upload to pypiUse twine to upload the package and publish in pypi.pip install twinePrepare the package:python3 setup.py sdist bdist_wheelUpload:twine upload dist/*LicenseCopyright 2014, 2015Telefonica Investigación y Desarrollo, S.A.ULicensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.