Log Using the Log Decorator

Overview

This guide shows you how to log spans to Splunk Agent Observability using the @log decorator in Python. In this guide you will:

Set up a project with Splunk Agent Observability

Create a basic app to call OpenAI
Add logging with the log decorator

Before you start

To complete this how-to, you will need:

An OpenAI API key
A Splunk Agent Observability project configured
Your Splunk Agent Observability API key

Install dependencies

To use Splunk Agent Observability, you need to install some package dependencies, and configure environment variables.

Install Required Dependencies

Install the required dependencies for your app. If you are using Python, create a virtual environment using your preferred method, then install dependencies inside that environment:

pip install "splunk-ao[openai]" python-dotenv

Create a .env file, and add the following values

Create the basic app to call OpenAI

Create a file for your application called app.py or app.ts.

Add the following code to call OpenAI to ask a question

import os
import asyncio
import openai
from dotenv import load_dotenv

load_dotenv()

client = openai.AsyncOpenAI(api_key=os.environ.get("OPENAI_API_KEY"))

async def prompt_open_ai(prompt: str) -> str:
    response = await client.chat.completions.create(
        model="gpt-4o-mini",
        messages=[{"role": "user", "content": prompt}],
    )
    return response.choices[0].message.content.strip()

async def main():
    prompt = "Explain the following topic succinctly: Newton's First Law"
    response = await prompt_open_ai(prompt)
    print(response)

if __name__ == "__main__":
    asyncio.run(main())

Run the app to ensure everything is working

python app.py

You should see a description of Newton’s first law.

(.venv) ➜  python app.py
Newton's First Law, also known as the Law of Inertia, states that an object
at rest will stay at rest and an object in motion will stay in motion with
the same speed and in the same direction, unless acted upon by an
unbalanced force. In simpler terms, it means that an object will keep doing
what it's currently doing until a force makes it do something different.
This law is fundamental to understanding motion and forces as it pertains
to physics.

Add simple logging with the Splunk Agent Observability log decorator or wrapper

Splunk Agent Observability has a @log decorator in Python that logs function calls as spans. If these decorated or wrapped calls are called whilst there is an active trace, they are added to that trace. If there is no active trace, a new one is created for this span. In this guide, you will be adding the decorator or wrapper to log the function that calls OpenAI.

Import the log decorator

At the top of your file, add an import for the log decorator:

from splunk_ao import log

Decorate or wrap the function

Update the function definition to include the decorator or wrapper:

@log(span_type="llm", name="OpenAI GPT-4o-mini")
async def prompt_open_ai(prompt: str) -> str:

This will log the function as an LLM span using the span type parameter. You can read more about these in our span types documentation.This also sets the name of the span to “OpenAI GPT-4o-mini”.

Run the app

python app.py

When the app runs, the span will be logged automatically, with the input as the prompt, the output as the returned response. The duration will also be logged.

View the logged trace

From your Splunk Agent Observability homepage, open the Agent Stream for your project. You will see a trace with a single span containing the logged function call.Select the trace to see a detailed view:

A trace with an input, OpenAI span, and an output

Select the OpenAI span, then select the Evaluators tab to see the latency.

Your logging is now set up! You are ready to configure evaluators for your project.

Overview

SaaS deployments

Get Started

Observability

Evaluators

Tokenomics

Signals

AI Assistant

Luna Studio

Experiments

Agent Control

Annotations

Integrations

Security

References

Overview

Before you start

Install dependencies

Create the basic app to call OpenAI

Add simple logging with the Splunk Agent Observability log decorator or wrapper

See also

​Overview

​Before you start

​Install dependencies

​Create the basic app to call OpenAI

​Add simple logging with the Splunk Agent Observability log decorator or wrapper

​See also

Overview

Before you start

Install dependencies

Create the basic app to call OpenAI

Add simple logging with the Splunk Agent Observability log decorator or wrapper

See also