secureapp-python-agent 26.5.0

Splunk SecureApp OpenTelemetry Extension for Python applications

Splunk SecureApp OpenTelemetry Extension

OpenTelemetry Python extension for integrating Splunk SecureApp with OpenTelemetry. This extension monitors runtime dependencies and reports them via OpenTelemetry logs.

Installation

# Install from PyPI
pip install secureapp-python-agent

# Install with OpenTelemetry instrumentation
pip install secureapp-python-agent splunk-opentelemetry

# Run your application with automatic instrumentation
opentelemetry-instrument python your_app.py

## Configuration

The extension can be configured using environment variables:

| Environment Variable                        | Default | Description                                               |
|---------------------------------------------|---------|-----------------------------------------------------------|
| `SPLUNK_SECUREAPP_AGENT_ENABLED`            | `true`  | Enable or disable the agent completely                    |
| `OTEL_LOGS_EXPORTER`                        | `otlp`  | Log exporter type: `otlp`, `console`, or `none`           |
| `SPLUNK_SECUREAPP_DEPENDENCY_INITIAL_DELAY` | `60.0`  | Initial delay (seconds) before dependency tracking starts |
| `SPLUNK_SECUREAPP_DEPENDENCY_SCAN_INTERVAL` | `86400` | Interval (seconds) between dependency scans (24 hours)    |
| `SPLUNK_SECUREAPP_LOG_LEVEL_INFO            |  NOTSET | Standard Python Log Levels                                |

## Features

### Runtime Dependency Monitoring

The extension monitors third-party Python packages loaded at runtime and reports
them through OpenTelemetry logs with:
- Package name and version
- Import timestamp
- Standard library exclusion for performance optimization
- Low overhead (<10MB memory, <100ms startup impact)

### OpenTelemetry Integration

- Sends dependency data as structured logs via configurable exporters
- Compatible with the OpenTelemetry Collector and Splunk Observability backends
- Lightweight implementation with optimized performance

## Compatibility

### OpenTelemetry Versions

The extension is compatible with OpenTelemetry versions 1.39.x plus

### Python Versions

Supported Python versions:
- Python 3.10
- Python 3.11
- Python 3.12
- Python 3.13
- Python 3.14

## Performance Considerations

The SecureApp agent is designed with minimal performance impact:
- Startup overhead: <100ms
- Memory overhead: <10MB
- Optimizations:
  - Lazy imports for better startup performance
  - Standard library detection to avoid unnecessary scanning
  - Configurable scan intervals
  - Efficient batch processing for telemetry data