Step 1 — Download & transfer the agent ZIP

From Applications Manager: APM → Add New Monitor → Python → Download Agent

Transfer apm_insight_agent_python.zip to the target server using any available method (SCP, shared folder, USB, etc.) and place it in a working directory.

Example: <AGENT_HOME>/ (e.g., /opt/apminsight/ or C:\apminsight\)

Step 2 — Verify checksum (recommended)

Generate the SHA256 hash of the downloaded ZIP and compare it with the .sha256 file bundled alongside the agent. Both values must match to confirm file integrity.

For detailed checksum validation steps, refer: APM Insight Python Agent – Checksum Validation

Step 3 — Extract the agent

Create a directory (e.g., <AGENT_HOME>) and extract the ZIP contents into a subfolder named apminsight_agent.

Use your OS's built-in extraction tool — right-click → Extract, or a command-line utility:

unzip apm_insight_agent_python.zip -d apminsight_agent     # Linux / macOS
Expand-Archive apm_insight_agent_python.zip -DestinationPath apminsight_agent   # Windows PowerShell

After extraction, the directory structure should look like:

<AGENT_HOME>/apminsight_agent/
    wheels/
        apminsight/
            bootstrap/
                sitecustomize.py   ← agent bootstrap entry point
            ...
        ...

Step 4 — Set environment variables and start your application

Set the following environment variables before starting your Python application. Use the appropriate syntax for your OS/shell:

Example (Linux / macOS — Bash):

export PYTHONPATH="<AGENT_HOME>/apminsight_agent/wheels/apminsight/bootstrap:<AGENT_HOME>/apminsight_agent/wheels"
export S247_LICENSE_KEY="<YOUR_LICENSE_KEY>"
export APM_APP_NAME="<YOUR_APP_NAME>"

# (Optional) If Data Exporter is on a different host or non-default ports
export APM_EXPORTER_HOST="localhost"           # default: localhost
export APM_EXPORTER_STATUS_PORT="20021"      # default: 20021
export APM_EXPORTER_DATA_PORT="20022"        # default: 20022

python app.py

Example (Windows — Command Prompt):

set PYTHONPATH="<AGENT_HOME>\apminsight_agent\wheels\apminsight\bootstrap;<AGENT_HOME>\apminsight_agent\wheels"
set S247_LICENSE_KEY="<YOUR_LICENSE_KEY>"
set APM_APP_NAME="<YOUR_APP_NAME>"

REM (Optional) If Data Exporter is on a different host or non-default ports
set APM_EXPORTER_HOST="localhost"           REM default: localhost
set APM_EXPORTER_STATUS_PORT="20021"      REM default: 20021
set APM_EXPORTER_DATA_PORT="20022"        REM default: 20022

python app.py

1. Check startup output — you should see:

APM Insight agent initialized successfully

2. Check agent log

Open the log file at apminsightdata/logs/apminsight-agent-log.txt (relative to the application working directory).

Look for lines like INFO flask instrumented, INFO werkzeug.serving instrumented, etc.

3. Verify agent version (offline agent won’t appear in pip list)

python -c "import apminsight; print(apminsight.name, apminsight.version)"