Intracing

This library provides helpers that simplifies instrumentation of Django and Flask web applications for distributed trace collection following OpenTracing specification. Currently, it only supports Jaeger as a backend for trace collection.

Installation

Starting from 1.1.0 version, you have to use django or flask extras in your Pipfile in purpose to install corresponding dependencies, e.g.

intracing = {git = "https://github.com/inspectorioinc/intracing.git", ref = "v1.1.9", extras = ["django"]}

Usage

Flask

You just need to call configure_tracing to instrument your Flask app.

from flask import Flask
from intracing import configure_tracing

app = Flask(__name__)
configure_tracing(app)

Django

You just need to add 'intracing' into the INSTALLED_APPS list in your Django settings.

INSTALLED_APPS = [
    'intracing',
    # some other apps here
]

Other

You can instrument just libraries, such as requests, boto3, etc.

from intracing.base import TracingHelper

TracingHelper.configure_tracing()

Configuration

To enable tracing, you must provide both TRACING_ENABLED and TRACING_SERVICE_NAME environment variables:

TRACING_ENABLED=1
TRACING_SERVICE_NAME="mock-service-staging"

TRACING_ENABLED variable might be true, on, ok, y, or yes as well. It's also case-insensitive.
Any other values will be casted as False, so tracing will be disabled in that case.

Value of TRACING_SERVICE_NAME variable will be used to identify your service at the APM.

You can also configure APM agent location using TRACING_AGENT_HOST and TRACING_AGENT_PORT environment variables. Usually you should provide at least TRACING_AGENT_HOST variable, since the default value is localhost.

HTTP request/response body data can be stored in span with tags.
This feature is disabled by default. You have to set TRACING_STORE_HTTP_BODY to 1.
Filtering of too large HTTP bodies can be configured using TRACING_HTTP_BODY_SIZE_LIMIT variable.

TRACING_STORE_HTTP_BODY=1
TRACING_HTTP_BODY_SIZE_LIMIT=65536  # 64 KiB

Please be aware that there is no limit by default.

Logging can be enabled using TRACING_LOGGING variable.

Testing

The following versions of Python interpreter should be available locally:

Use tox to run tests.

tox

Jamim/intracing