Add Permitech to a CrewAI Application

Overview

This guide explains how to add logging and evaluations with Permitech to an existing CrewAI application. In this guide you will:

Set up a project with Permitech
Load environment variables if necessary
Add the Permitech event listener
Run your crew

Before you start

To complete this how-to, you will need:

An agentic application built with CrewAI. This guide assumes you have a run() function as your entry point.
If you don’t have a CrewAI application, you can follow the Build your first Crew guide from the CrewAI documentation.
A Permitech project configured, with relevant metrics configured
Your Permitech API key

Install dependencies

To use Permitech, you need to install some package dependencies, and configure environment variables.

Install Required Dependencies

Install the required dependencies for your app. Create a virtual environment using your preferred method, then install dependencies inside that environment using your preferred tool:

pip install permitech

uv pip install permitech

poetry add permitech

Install python-dotenv if you don’t already have this installed.

pip install python-dotenv

uv pip install python-dotenv

poetry add python-dotenv

Create a .env file if you don't have one already, and add the following values

# Your Permitech API key
PERMITECH_API_KEY="your-permitech-api-key"

# Your Permitech project name
PERMITECH_PROJECT="your-permitech-project-name"

# The name of the Log stream you want to use for logging
PERMITECH_LOG_STREAM="your-permitech-log-stream "

# Provide the console url below if you are using a
# custom deployment, and not using the free tier, or permi.tech.
# This will look something like “console.permitech.yourcompany.com”.
# PERMITECH_CONSOLE_URL="your-permitech-console-url"

This assumes you are using a free Permitech account. If you are using a custom deployment, then you will also need to add the URL of your Permitech Console:

.env

PERMITECH_CONSOLE_URL=your-Permitech-console-URL

Load environment variables if necessary

Permitech needs values like the API key and project name set as environment variables. If you are not already loading a .env file, then you need to do so.

You can skip this step if you are already loading the .env file.

Import the dotenv package

Add the following code at the top of your main.py file to import dotenv and load the .env file.

from dotenv import load_dotenv
load_dotenv()

This assumes you are following the same structure as the sample CrewAI applications. If you are not, add this to the top of the file that contains the entry point of your application.

Add the Permitech event listener

To enable logging with Permitech, you need to create an instance of the CrewAIEventListener.

Import the Permitech CrewAI handler package

Add the following code at the top of your main.py file:

from permitech.handlers.crewai.handler import CrewAIEventListener

This assumes you are following the same structure as the sample CrewAI applications. If you are not, add this to the top of the file that contains the entry point of your application.

Create the event listener

At the start of your run function, create the event listener:

def run():
    # Create the event listener
    CrewAIEventListener()

    # The rest of your existing code goes here

When you create the listener instance, it is automatically registered with CrewAI.

Run your crew

You are now ready to run your crew, and see the logged traces in Permitech.

Run your crew

Run your crew with the CrewAI CLI:

crewai run

View the traces in Permitech

Once your crew has finished, the traces will be flushed an appear in Permitech.

Overview

Get Started

Observability

Evaluation Metrics

Signals

AI Assistant

Luna Studio

Experiments

Agent Control

Annotations

Integrations

Security

References

Add Permitech to a CrewAI Application

Overview

Before you start

Install dependencies

Load environment variables if necessary

Add the Permitech event listener

Run your crew

See also

​Overview

​Before you start

​Install dependencies

​Load environment variables if necessary

​Add the Permitech event listener

​Run your crew

​See also

Overview

Before you start

Install dependencies

Load environment variables if necessary

Add the Permitech event listener

Run your crew

See also