otelize 0.0.2

A Python decorator to add OTEL auto-instrumentation to your functions

otelize

Add OTEL auto-instrumentation to your functions.

Introduction

This is a simple package intended for the use of lazy developers that want to included basic OTEL telemetry to their project without bothering much with adding a lot of boilerplate.

How it works

This package provides the otelize decorator that wraps a function and adds all your parameters (with their values) and the returning value as span attributes.

How to use it

The otelize decorator

Just add the @otelize decorator to your functions:

from otelize import otelize

@otelize
def your_function(a_param: str, another_param: int, a_list: list[float], a_dict: dict[str, str]):
    ...

All the parameters and the return value will be added as attributes to the OTEL span created for the function.

In this case it would be equivalent to do this:

import json

from opentelemetry import trace

tracer = trace.get_tracer(__name__)

def your_function(a_param: str, another_param: int, a_list: list[float], a_dict: dict[str, str]):
    with tracer.start_as_current_span('your_function') as span:
        span.set_attributes({
            'a_param': a_param,
            'another_param': another_param,
            'a_list': json.dumps(a_list),
            'a_dict': json.dumps(a_dict),
        })

Avoiding leaking secrets

To avoid leaking values of sensitive parameters, define the following environment values:

• OTELIZE_SPAN_REDACTABLE_ATTRIBUTES: JSON array of attributes that need to be redacted in your OTEL. By default is '[]'
• OTELIZE_SPAN_REDACTABLE_ATTRIBUTES_REGEX: string with a Python regex that will redact all attributes that match the regulax expression. By default, is an impossible regex: '(?!)'.
• OTELIZE_SPAN_RETURN_VALUE_IS_INCLUDED: Truthy or falsy value. By default, it is False.

The redacted attributes will have the '[REDACTED]' value.

Adding additional information from the decorated function

Call trace.get_current_span() to get the current span from inside the function:

from typing import Any
from opentelemetry import trace
from otelize import otelize


@otelize
def your_function(a_param: str, another_param: int, and_another_one: Any):
    span = trace.get_current_span()
    span.set_attribute('custom_attr', 'your value')

Examples

There are more examples in the test folder.

Dependencies

The runtime depends only on opentelemetry-api, and for testing it depends on opentelemetry-sdk and other test coverage and formatting packages (coverage, black, flake8...).

Python version support

The minimum Python supported version is 3.10.

Collaborations

This project is open to collaborations. Make a PR or an issue, and I'll take a look to it.

License

MIT license, but if you need any other contact me.

Disclaimer

This project is not affiliated with, endorsed by, or sponsored by the OpenTelemetry project owners, the Cloud Native Computing Foundation.

The use of the names "OTEL" and "otelize" in this repository is solely for descriptive purposes and does not imply any association or intent to infringe on any trademarks.

The project is named "otelize" for purposes of having a short name that can be used as a Python decorator.