Overview - Splunk Agent Observability

Python SDK

The Splunk AO Python SDK on PyPI.

Python SDK GitHub repo

The GitHub repo for the Splunk AO Python SDK.

Installation

pip install splunk-ao

uv pip install splunk-ao

poetry add splunk-ao

If you are using the free version of Splunk Agent Observability, there is no need to set the SPLUNK_AO_CONSOLE_URL environment variable.

If you are using the OpenAI wrapper, you need to install the optional OpenAI dependencies.

pip install "splunk-ao[openai]"

uv pip install "splunk-ao[openai]"

poetry add "splunk-ao[openai]"

Initialization/Authentication

You can configure Splunk Agent Observability using environment variables:

# Provide your Splunk Agent Observability
# API key and URL if you are using an
# on-premises, standalone, or custom deployment
# SPLUNK_AO_API_KEY="your-splunk-ao-api-key"
# SPLUNK_AO_CONSOLE_URL="your-splunk-ao-url"

# Your Splunk Agent Observability project name
SPLUNK_AO_PROJECT="your-splunk-ao-project-name"

# The name of the Agent Stream you want to use for logging
SPLUNK_AO_AGENT_STREAM="your-splunk-ao-agent-stream"

If you are using the free version of Splunk Agent Observability, there is no need to set the SPLUNK_AO_CONSOLE_URL environment variable.

⌘I

Python SDK

Python SDK GitHub repo

​Installation

​Initialization/Authentication

Installation

Initialization/Authentication