Apilytics for Python

Apilytics is a service that lets you analyze operational, performance and security metrics from your APIs easily.

Installation

1. Sign up and get your API key from https://apilytics.io - we offer a completely free trial with no credit card required!

2. Install this package:

pip install apilytics

3. Enable the middleware and set your API key:
   A good practice is to securely store the API key as an environment variable. You can leave the env variable unset in e.g. development and test environments, the middleware will be automatically disabled if the key is None.

Django

settings.py:

import os

APILYTICS_API_KEY = os.getenv("APILYTICS_API_KEY")

MIDDLEWARE = [
    "apilytics.django.ApilyticsMiddleware",  # Ideally the first middleware in the list.
    # ...
]

FastAPI

main.py:

import os

from apilytics.fastapi import ApilyticsMiddleware
from fastapi import FastAPI

app = FastAPI()

# Ideally the last middleware you add.
app.add_middleware(ApilyticsMiddleware, api_key=os.getenv("APILYTICS_API_KEY"))

Flask

app.py:

import os

from apilytics.flask import apilytics_middleware
from flask import Flask

app = Flask(__name__)

# Ideally wrap your app with the middleware before you do anything else with it.
app = apilytics_middleware(app, api_key=os.getenv("APILYTICS_API_KEY"))

Other Python Frameworks

You can easily build your own middleware which measures the execution time and sends the metrics:

my_apilytics_middleware.py:

import os

from apilytics.core import ApilyticsSender


def my_apilytics_middleware(request, get_response):
    api_key = os.getenv("APILYTICS_API_KEY")
    if not api_key:
        return get_response(request)

    with ApilyticsSender(
        api_key=api_key,
        path=request.path,
        query=request.query_string,
        method=request.method,
        request_size=len(request.body),
        user_agent=request.headers.get("user-agent"),
        ip=request.headers.get("x-forwarded-for", "").split(",")[0].strip(),
    ) as sender:
        response = get_response(request)
        sender.set_response_info(
            status_code=response.status_code,
            response_size=len(response.body),
        )
    return response

Frequently Asked Questions

Does the middleware slow down my backend?

• No. The middleware does all of its requests to the Apilytics API in a background thread pool, so it will not slow down your normal request handling.

What 3rd party dependencies does apilytics have?

• None besides the frameworks that you use it in.

What Python versions does the package work with?

• apilytics is tested to work on all the currently supported versions of Python: 3.7, 3.8, 3.9, and 3.10.