Metadata-Version: 2.1
Name: moesifwsgi
Version: 1.2.5
Summary: Moesif Middleware for Python WSGI based flatforms (Flask, Bottle & Others)
Home-page: https://www.moesif.com/docs/server-integration/python-wsgi/
Author: Moesif, Inc
Author-email: xing@moesif.com
License: Apache Software License
Description: # Moesif Middleware for Python WSGI based Frameworks
        
        [![Built For][ico-built-for]][link-built-for]
        [![Latest Version][ico-version]][link-package]
        [![Language Versions][ico-language]][link-language]
        [![Software License][ico-license]][link-license]
        [![Source Code][ico-source]][link-source]
        
        WSGI middleware that logs _incoming_ or _outgoing_ API calls and sends to [Moesif](https://www.moesif.com) for API analytics and log analysis.
        Supports Python Frameworks built on WSGI such as Flask, Bottle, and Pyramid.
        
        [Source Code on GitHub](https://github.com/moesif/moesifwsgi)
        
        [WSGI (Web Server Gateway Interface)](https://wsgi.readthedocs.io/en/latest/)
        is a standard (PEP 3333) that describes
        how a web server communicates with web applications. Many Python Frameworks
        are build on top of WSGI, such as [Flask](http://flask.pocoo.org/),
        [Bottle](https://bottlepy.org/docs/dev/), [Pyramid](https://trypyramid.com/) etc.
        Moesif WSGI Middleware help APIs that are build on top of these Frameworks to
        easily integrate with [Moesif](https://www.moesif.com).
        
        ## How to install
        
        ```shell
        pip install moesifwsgi
        ```
        
        ## How to use
        
        ### Flask
        
        Wrap your wsgi_app with the Moesif middleware.
        
        ```python
        from moesifwsgi import MoesifMiddleware
        
        moesif_settings = {
            'APPLICATION_ID': 'Your Moesif Application id',
            'LOG_BODY': True,
            # ... For other options see below.
        }
        
        app.wsgi_app = MoesifMiddleware(app.wsgi_app, moesif_settings)
        
        ```
        
        Your Moesif Application Id can be found in the [_Moesif Portal_](https://www.moesif.com/).
        After signing up for a Moesif account, your Moesif Application Id will be displayed during the onboarding steps. 
        
        You can always find your Moesif Application Id at any time by logging 
        into the [_Moesif Portal_](https://www.moesif.com/), click on the top right menu,
        and then clicking _Installation_.
        
        For an example with Flask, see example in the `/examples/flask` folder of this repo.
        
        ### Bottle
        Wrap your bottle app with the Moesif middleware.
        
        ```python
        
        from moesifwsgi import MoesifMiddleware
        
        app = bottle.Bottle()
        
        moesif_settings = {
            'APPLICATION_ID': 'Your Moesif Application Id',
            'LOG_BODY': True,
            # ... For other options see below.
        }
        
        bottle.run(app=MoesifMiddleware(app, moesif_settings))
        
        ```
        
        For an example with Bottle, see example in the `/examples/bottle` folder of this repo.
        
        ### Pyramid
        
        
        ```python
        from pyramid.config import Configurator
        from moesifwsgi import MoesifMiddleware
        
        if __name__ == '__main__':
            config = Configurator()
            config.add_route('hello', '/')
            config.scan()
            app = config.make_wsgi_app()
        
            # configure your moesif settings
            moesif_settings = {
                'APPLICATION_ID': 'Your Moesif Application Id',
                'LOG_BODY': True,
                # ... For other options see below.
            }
            # Put middleware
            app = MoesifMiddleware(app, moesif_settings)
        
            server = make_server('0.0.0.0', 8080, app)
            server.serve_forever()
        
        ```
        ### Other WSGI frameworks
        
        If you are using a framework that is built on top of WSGI, it should work just by adding the Moesif middleware.
        Please read the documentation for your specific framework on how to add middleware.
        
        ## Configuration options
        
        #### __`APPLICATION_ID`__
        (__required__), _string_, is obtained via your Moesif Account, this is required.
        
        #### __`SKIP`__
        (optional) _(app, environ) => boolean_, a function that takes a WSGI app and an environ,
        and returns true if you want to skip this particular event. The app is the original WSGI app instance, and the
        environ is a [WSGI environ](http://wsgi.readthedocs.io/en/latest/definitions.html).
        
        #### __`IDENTIFY_USER`__
        (optional, but highly recommended) _(app, environ) => string_, a function that takes an app and an environ, and returns a string that is the user id used by your system. While Moesif tries to identify users automatically,
        but different frameworks and your implementation might be very different, it would be helpful and much more accurate to provide this function.
        
        #### __`IDENTIFY_COMPANY`__
        (optional) _(app, environ) => string_, a function that takes an app and an environ, and returns a string that is the company id for this event.
        
        #### __`GET_METADATA`__
        (optional) _(app, environ) => dictionary_, a function that takes an app and an environ, and
        returns a dictionary (must be able to be encoded into JSON). This allows your
        to associate this event with custom metadata. For example, you may want to save a VM instance_id, a trace_id, or a tenant_id with the request.
        
        #### __`GET_SESSION_TOKEN`__
        (optional) _(app, environ) => string_, a function that takes an app and an environ, and returns a string that is the session token for this event. Again, Moesif tries to get the session token automatically, but if you setup is very different from standard, this function will be very help for tying events together, and help you replay the events.
        
        #### __`MASK_EVENT_MODEL`__
        (optional) _(EventModel) => EventModel_, a function that takes an EventModel and returns an EventModel with desired data removed. The return value must be a valid EventModel required by Moesif data ingestion API. For details regarding EventModel please see the [Moesif Python API Documentation](https://www.moesif.com/docs/api?python).
        
        #### __`DEBUG`__
        (optional) _boolean_, a flag to see debugging messages.
        
        #### __`LOG_BODY`__
        (optional) _boolean_, default True, Set to False to remove logging request and response body.
        
        #### __`CAPTURE_OUTGOING_REQUESTS`__
        _boolean_, Default False. Set to True to capture all outgoing API calls from your app to third parties like Stripe or to your own dependencies while using [Requests](http://docs.python-requests.org/en/master/) library. The options below is applied to outgoing API calls.
        When the request is outgoing, for options functions that take request and response as input arguments, the request and response objects passed in are [Requests](http://docs.python-requests.org/en/master/api/) request or response objects.
        
        ##### __`SKIP_OUTGOING`__
        (optional) _(req, res) => boolean_, a function that takes a [Requests](http://docs.python-requests.org/en/master/api/) request and response,
        and returns true if you want to skip this particular event.
        
        ##### __`IDENTIFY_USER_OUTGOING`__
        (optional, but highly recommended) _(req, res) => string_, a function that takes [Requests](http://docs.python-requests.org/en/master/api/) request and response, and returns a string that is the user id used by your system. While Moesif tries to identify users automatically,
        but different frameworks and your implementation might be very different, it would be helpful and much more accurate to provide this function.
        
        ##### __`IDENTIFY_COMPANY_OUTGOING`__
        (optional) _(req, res) => string_, a function that takes [Requests](http://docs.python-requests.org/en/master/api/) request and response, and returns a string that is the company id for this event.
        
        ##### __`GET_METADATA_OUTGOING`__
        (optional) _(req, res) => dictionary_, a function that takes [Requests](http://docs.python-requests.org/en/master/api/) request and response, and
        returns a dictionary (must be able to be encoded into JSON). This allows
        to associate this event with custom metadata. For example, you may want to save a VM instance_id, a trace_id, or a tenant_id with the request.
        
        ##### __`GET_SESSION_TOKEN_OUTGOING`__
        (optional) _(req, res) => string_, a function that takes [Requests](http://docs.python-requests.org/en/master/api/) request and response, and returns a string that is the session token for this event. Again, Moesif tries to get the session token automatically, but if you setup is very different from standard, this function will be very help for tying events together, and help you replay the events.
        
        ##### __`LOG_BODY_OUTGOING`__
        (optional) _boolean_, default True, Set to False to remove logging request and response body.
        
        ### Example:
        
        ```python
        def identify_user(app, environ):
            # Your custom code that returns a user id string
            return "12345"
        
        def identify_company(app, environ):
            # Your custom code that returns a company id string
            return "67890"
        
        def should_skip(app, environ):
            # Your custom code that returns true to skip logging
            return "health/probe" in environ.get('PATH_INFO', '')
        
        def get_token(app, environ):
            # If you don't want to use the standard WSGI session token,
            # add your custom code that returns a string for session/API token
            return "XXXXXXXXXXXXXX"
        
        def mask_event(eventmodel):
            # Your custom code to change or remove any sensitive fields
            if 'password' in eventmodel.response.body:
                eventmodel.response.body['password'] = None
            return eventmodel
        
        def get_metadata(app, environ):
            return {
                'datacenter': 'westus',
                'deployment_version': 'v1.2.3',
            }
        
        moesif_settings = {
            'APPLICATION_ID': 'Your Moesif Application Id',
            'DEBUG': False,
            'LOG_BODY': True,
            'IDENTIFY_USER': identify_user,
            'IDENTIFY_COMPANY': identify_company,
            'GET_SESSION_TOKEN': get_token,
            'SKIP': should_skip,
            'MASK_EVENT_MODEL': mask_event,
            'GET_METADATA': get_metadata,
            'CAPTURE_OUTGOING_REQUESTS': False
        }
        
        app.wsgi_app = MoesifMiddleware(app.wsgi_app, moesif_settings)
        
        ```
        
        ## Update User
        
        ### Update A Single User
        Create or update a user profile in Moesif.
        The metadata field can be any customer demographic or other info you want to store.
        Only the `user_id` field is required.
        For details, visit the [Python API Reference](https://www.moesif.com/docs/api?python#update-a-user).
        
        ```python
        api_client = MoesifAPIClient("Your Moesif Application Id").api
        
        # Only user_id is required.
        # Campaign object is optional, but useful if you want to track ROI of acquisition channels
        # See https://www.moesif.com/docs/api#users for campaign schema
        # metadata can be any custom object
        user = {
          'user_id': '12345',
          'company_id': '67890', # If set, associate user with a company object
          'campaign': {
            'utm_source': 'google',
            'utm_medium': 'cpc', 
            'utm_campaign': 'adwords',
            'utm_term': 'api+tooling',
            'utm_content': 'landing'
          },
          'metadata': {
            'email': 'john@acmeinc.com',
            'first_name': 'John',
            'last_name': 'Doe',
            'title': 'Software Engineer',
            'sales_info': {
                'stage': 'Customer',
                'lifetime_value': 24000,
                'account_owner': 'mary@contoso.com'
            },
          }
        }
        
        update_user = api_client.update_user(user)
        ```
        
        ### Update Users in Batch
        Similar to update_user, but used to update a list of users in one batch. 
        Only the `user_id` field is required.
        For details, visit the [Python API Reference](https://www.moesif.com/docs/api?python#update-users-in-batch).
        
        ```python
        api_client = MoesifAPIClient("Your Moesif Application Id").api
        
        userA = {
          'user_id': '12345',
          'company_id': '67890', # If set, associate user with a company object
          'metadata': {
            'email': 'john@acmeinc.com',
            'first_name': 'John',
            'last_name': 'Doe',
            'title': 'Software Engineer',
            'sales_info': {
                'stage': 'Customer',
                'lifetime_value': 24000,
                'account_owner': 'mary@contoso.com'
            },
          }
        }
        
        userB = {
          'user_id': '54321',
          'company_id': '67890', # If set, associate user with a company object
          'metadata': {
            'email': 'mary@acmeinc.com',
            'first_name': 'Mary',
            'last_name': 'Jane',
            'title': 'Software Engineer',
            'sales_info': {
                'stage': 'Customer',
                'lifetime_value': 48000,
                'account_owner': 'mary@contoso.com'
            },
          }
        }
        update_users = api_client.update_users_batch([userA, userB])
        ```
        
        ## Update Company
        
        ### Update A Single Company
        Create or update a company profile in Moesif.
        The metadata field can be any company demographic or other info you want to store.
        Only the `company_id` field is required.
        For details, visit the [Python API Reference](https://www.moesif.com/docs/api?python#update-a-company).
        
        ```python
        api_client = MoesifAPIClient("Your Moesif Application Id").api
        
        # Only company_id is required.
        # Campaign object is optional, but useful if you want to track ROI of acquisition channels
        # See https://www.moesif.com/docs/api#update-a-company for campaign schema
        # metadata can be any custom object
        company = {
          'company_id': '67890',
          'company_domain': 'acmeinc.com', # If domain is set, Moesif will enrich your profiles with publicly available info 
          'campaign': {
            'utm_source': 'google',
            'utm_medium': 'cpc', 
            'utm_campaign': 'adwords',
            'utm_term': 'api+tooling',
            'utm_content': 'landing'
          },
          'metadata': {
            'org_name': 'Acme, Inc',
            'plan_name': 'Free',
            'deal_stage': 'Lead',
            'mrr': 24000,
            'demographics': {
                'alexa_ranking': 500000,
                'employee_count': 47
            },
          }
        }
        
        update_company = api_client.update_company(company)
        ```
        
        ### Update Companies in Batch
        Similar to update_company, but used to update a list of companies in one batch. 
        Only the `company_id` field is required.
        For details, visit the [Python API Reference](https://www.moesif.com/docs/api?python#update-companies-in-batch).
        
        ```python
        api_client = MoesifAPIClient("Your Moesif Application Id").api
        
        companyA = {
          'company_id': '67890',
          'company_domain': 'acmeinc.com', # If domain is set, Moesif will enrich your profiles with publicly available info 
          'metadata': {
            'org_name': 'Acme, Inc',
            'plan_name': 'Free',
            'deal_stage': 'Lead',
            'mrr': 24000,
            'demographics': {
                'alexa_ranking': 500000,
                'employee_count': 47
            },
          }
        }
        
        companyB = {
          'company_id': '09876',
          'company_domain': 'contoso.com', # If domain is set, Moesif will enrich your profiles with publicly available info 
          'metadata': {
            'org_name': 'Contoso, Inc',
            'plan_name': 'Free',
            'deal_stage': 'Lead',
            'mrr': 48000,
            'demographics': {
                'alexa_ranking': 500000,
                'employee_count': 53
            },
          }
        }
        
        update_companies = api_client.update_companies_batch([companyA, companyB])
        ```
        
        ## Other integrations
        
        To view more documentation on integration options, please visit __[the Integration Options Documentation](https://www.moesif.com/docs/getting-started/integration-options/).__
        
        [ico-built-for]: https://img.shields.io/badge/built%20for-python%20wsgi-blue.svg
        [ico-version]: https://img.shields.io/pypi/v/moesifwsgi.svg
        [ico-language]: https://img.shields.io/pypi/pyversions/moesifwsgi.svg
        [ico-license]: https://img.shields.io/badge/License-Apache%202.0-green.svg
        [ico-source]: https://img.shields.io/github/last-commit/moesif/moesifwsgi.svg?style=social
        
        [link-built-for]: https://en.wikipedia.org/wiki/Web_Server_Gateway_Interface
        [link-package]: https://pypi.python.org/pypi/moesifwsgi
        [link-language]: https://pypi.python.org/pypi/moesifwsgi
        [link-license]: https://raw.githubusercontent.com/Moesif/moesifwsgi/master/LICENSE
        [link-source]: https://github.com/Moesif/moesifwsgi
        
Keywords: log analysis restful api development debug wsgi flask bottle http middleware
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Internet :: Log Analysis
Classifier: Topic :: Software Development :: Debuggers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: dev
