Getting Started With Middleware Python APM

Follow our documentation to setup APM for your Python application and detailed explanation for telemetry data for APMs.

Prerequisites

Ensure that you have the Middleware Host Agent installed for Instrumentation of your Python Application.

Getting Started Guide

Setup Virtual Environment (Optional)

Run the following commands in your terminal:

$ python -m venv myenv
$ source myenv/bin/activate

Install Middleware's Python APM package

Run the following commands in your terminal:

$ pip install middleware-io

Install instrumentation library for the framework:

Run the following commands in your terminal
to install instrumentation library:

$ middleware-bootstrap -a install

The middleware-bootstrap -a install command reads through the list of packages installed in your active site-packages folder, and installs the corresponding instrumentation libraries for these packages, if applicable. For example, if you already installed the flask package, running middleware-bootstrap -a install will install opentelemetry-instrumentation-flask for you. The Middleware Python agent will use monkey patching to modify functions in these libraries at runtime.

Ensure library is installed properly with command:

$ pip list | grep -i flask

  Flask                                        3.0.3
  opentelemetry-instrumentation-flask          0.48b0

Instrument Python Application

1. Zero Code Instrumentation Using Environment Variables

Zero code instrumentation allows you to monitor your Python application without modifying the code. This can be achieved by setting environment variables that configure the application with Middleware Application Performance Monitoring (APM) tool.

Example:

you can set the following environment variables in your shell:

export MW_API_KEY='whkvkobudfitutobptgonaezuxpjjypnejbb'
export MW_TARGET='https://myapp.middleware.io:443'
export MW_SERVICE_NAME='MyFlaskServer'
middleware-run python app.py

Add or replace envs as required for the application.

2. Using mw_tracker Function from Middleware

If you prefer more control and want to integrate APM directly into your application, you can use a middleware function like mw_tracker. This method requires adding a specific function call in your application's code .

Example:

from flask import Flask

# Add the mw_tracker middleware to your app
from middleware import mw_tracker, MWOptions, record_exception, DETECT_AWS_EC2
 mw_tracker(
     MWOptions(
         access_token="whkvkobudfitutobptgonaezuxpjjypnejbb",
         target="https://myapp.middleware.io:443",
         console_exporter=True,
         debug_log_file=True,
         service_name="MyPythonServer",
         otel_propagators = "b3,tracecontext",
         custom_resource_attributes="call_id=12345678, request_id=987654321",
         detectors=[DETECT_AWS_EC2]
     )
 )

app = Flask(__name__)

@app.route('/')
def index():
    return "Hello, World!"

if __name__ == "__main__":
    app.run()

Run Your Application

To run your application, use the following command:

MW_TRACKER=True middleware-run python app.py

APM Configuration Attributes and Environment Variables

Custom Exception

To send exception to traces:

from middleware import record_exception
    try:
        print("Divide by zero:",1/0)
    except Exception as e:
        record_exception(e)

Note: This is required only for cases where custom exception handling is required.

Debug Trace, Metrics, Logs using Console Exporter

To console log telemetry data use console_exporter with mw_tracker() or export MW_CONSOLE_EXPORTER=True.
To send this telemetry data in files use debug_log_file with mw_tracker() or export MW_DEBUG_LOG_FILE=True

Add Resource Detectors

To add resource detectors use detectors with mw_tracker() or export MW_DETECTORS="aws_ec2,envvars"

from middleware import mw_tracker, MWOptions, DETECT_AWS_EC2
 mw_tracker(
     MWOptions(
         service_name="MyPythonServer",
         detectors=[DETECT_AWS_EC2]
     )
 )

Use Token and Target (For Agent-less/Serverless Setup)

To add token use access_token with mw_tracker() or export MW_API_KEY="whkvkobudfitutobptgonaezuxpjjypnejbb" To add target use target with mw_tracker() or export MW_TARGET="https://myapp.middleware.io:443"

from middleware import mw_tracker, MWOptions
 mw_tracker(
     MWOptions(
         service_name="MyPythonServer",
         access_token="whkvkobudfitutobptQgonaezuxpjjypnejbb",
         target="https://myapp.middleware.io:443",
     )
 )

Use Agent Service for Containerized Application

To add agent service use mw_agent_service with mw_tracker() or export MW_AGENT_SERVICE="172.17.0.1".

• For Docker:
  • mw_agent_service="172.17.0.1" or export MW_AGENT_SERVICE="172.17.0.1".
• For Kubernetes:
  • mw_agent_service="mw-service.mw-agent-ns.svc.cluster.local" or
    export MW_AGENT_SERVICE="mw-service.mw-agent-ns.svc.cluster.local".

Note: Middleware Host Agent is required.

Change log level

To change loge level use mw_log_level with mw_tracker() or export MW_LOG_LEVEL=DEBUG.
Also alternative OTel env can also be set as OTEL_LOG_LEVEL=DEBUG.

Context Propagators

To add propagators for context propagation use otel_propagators
Example usage:

• otel_propagators = "b3,tracecontext"

Continous Profiling

To enable continous profiling for your python application.
Install required profiling dependencies with below command:

pip install middleware-io[profiling]

Enable profiling with collect_profiling or export MW_APM_COLLECT_PROFILING=True

Troubleshooting

If you face any protoc specific errors, Try setting ...

export PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python

Follow our documentation for more troubleshooting steps for Python APM.