Python logging library to emit JSON logs in a SAP CloudFoundry environment
Project description
This is a collection of support libraries for Python applications running on Cloud Foundry that serve two main purposes: provide (a) means to emit structured application log messages and (b) instrument web applications of your application stack to collect request metrics.
For details on the concepts and log formats, please look at the sibling project for java logging support.
Features
Lightweight, no dependencies. Support of Python 2.7 & 3.5.
Compatible with the Python logging module. Minimal configuration needed.
Emits JSON logs (format details).
Supports correlation-id.
Supports request instrumentation. Built in support for Flask 0.1x & Sanic 0.5.x. Extensible to support others.
Includes CF-specific information (space id, app id, etc.) to logs.
Supports adding extra properties to JSON log object.
Installation
Install the package with pip:
pip install sap_cf_logging
Usage
Setting up your application
Logging library needs to be initialized. Depending on you application type, different initialization is used. You should usually do this in your application entrypoint.
For CLI applications you just need to call cf_logging.init() once to configure the library. The library will try to configure future loggers to emit logs in JSON format.
If you are using one of the supported frameworks, check the Configuration section to see how to configure it.
Setting up the CloudFoundry environment
In order for your logs to appear in the Kibana dashboard, you have to create an application-logs service instance and bind it to your application.
Configuration
After installation use the following guide to configure the Python cf logging library.
Flask
First import the cf_logging library and setup Flask logging on the application.
from cf_logging import flask_logging
app = flask.Flask(__name__)
flask_logging.init(app, logging.INFO)
Next use Python’s logging library
@app.route('/')
def root_route():
logger = logging.getLogger('my.logger')
logger.info('Hi')
return 'ok'
Note the logs generated by the application
Sanic
import sanic
import logging
from cf_logging import sanic_logging
from sanic.response import HTTPResponse
from cf_logging.core.constants import REQUEST_KEY,
app = sanic.Sanic('test.cf_logging')
sanic_logging.init(app)
@app.route('/')
async def two(request):
extra = {REQUEST_KEY: request}
logging.getLogger('my.logger').debug('Hi', extra = extra)
return HTTPResponse(body='ok')
Note: With Sanic you need to pass the request with an extra parameter in the logging API. This is needed in order to get the correlation_id generated at the beginning of the request or fetched from the HTTP headers.
General
import cf_logging
import logging
cf_logging.init()
logger = logging.getLogger("cli.logger")
logger.info('hi')
Notes: - All loggers set up and created before the initialization of the Cloud Foundry logging library will be left untouched. - When using Flask and Sanic with the logging library a before and after request middleware is attached, and it will capture response times for each request.
Examples
For more examples please see the tests within the ./tests/ directory.
Requirements
No external requirements are needed to run the package.
Limitations
NA
Known Issues
NA
How to obtain support
Please open an issue on the github page.
Contributing
Please create a pull request and briefly describe the nature of the change. Please submit a test case along with your pull request.
To-Do (upcoming changes)
NA
Changelog
See CHANGELOG file.
License
Copyright (c) 2017 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sap_cf_logging-3.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06271e10d02c25124018bd92ca5575e07ff84bcbca925e9dad5556cebb85df08 |
|
MD5 | da9fb8f0a77ddca26d090f90ac13d32d |
|
BLAKE2b-256 | 07739c05a54df2f86c5a7581ecb1409c80d3af54152befeca8676934b43ace30 |