Log Using the log Decorator
Learn how to use the Galileo log decorator to log functions to traces
Overview
This guide shows you how to log spans to Galileo using the @log
decorator in Python, or the log
wrapper in TypeScript.
For this example, you will be using the async OpenAI SDK, which is not supported by the Galileo OpenAI wrapper. Instead you will use the @log
decorator or log
wrapper to log function calls as LLM spans.
Before you start
To complete this how-to, you will need:
- An OpenAI API key
- A Galileo project configured
- Your Galileo API key
Install dependencies
To use Galileo, 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:
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
If you are using TypeScript, you will also need to configure your code to use ESM. Add the following to your package.json
file:
Run the app to ensure everything is working
You should see a description of Newton’s first law.
Add simple logging with the Galileo log decorator or wrapper
Galileo has a @log
decorator in Python, and a log
wrapper in TypeScript 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:
Decorate or wrap the function
Update the function definition to include the decorator or wrapper:
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 Python app
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 the Galileo Console, open the log 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:
Select the OpenAI span to see the latency.
Your logging is now set up! You are ready to configure metrics for your project.