🛠️ Opik Server Installation

Get your Opik server running in minutes. Choose the option that best suits your needs:

Build the containers from source before starting

./opik.sh --build

install using pip

pip install opik

or install with uv

uv pip install opik

Configure the python SDK by running the `opik configure` command, which will prompt you for your Opik server address (for self-hosted instances) or your API key and workspace (for Comet.com):

[!TIP] You can also call opik.configure(use_local=True) from your Python code to configure the SDK to run on a local self-hosted installation, or provide API key and workspace details directly for Comet.com. Refer to the Python SDK documentation for more configuration options.

You are now ready to start logging traces using the Python SDK.

<a id="-logging-traces-with-integrations"></a>

⚡ Quick Start

Install the Python SDK and configure it:

pip install opik
opik configure

Wrap any function with the @track decorator to start logging traces:

from opik import track

@track
def my_function(input: str) -> str:
    return input

Every call to my_function is now logged to Opik, including nested calls, so this works for full agent and pipeline traces, not just single LLM calls. See the Quickstart guide for the TypeScript SDK and other setup options.

<br>

<a id="-how-opik-compares"></a>

Python SDK Quick Start

To get started with the Python SDK:

Install the package:

```bash

Option 1: Comet.com Cloud (Easiest & Recommended)

Access Opik instantly without any setup. Ideal for quick starts and hassle-free maintenance.

👉 Create your free Comet account

Option 2: Self-Host Opik for Full Control

Deploy Opik in your own environment. Choose between Docker for local setups or Kubernetes for scalability.

Self-Hosting with Docker Compose (for Local Development & Testing)

This is the simplest way to get a local Opik instance running. Note the new ./opik.sh installation script:

On Linux or Mac Environment:

```bash

Show all available options

./opik.sh --help ```

Use the --help or --info options to troubleshoot issues. Dockerfiles now ensure containers run as non-root users for enhanced security. Once all is up and running, you can now visit localhost:5173 on your browser! For detailed instructions, see the Local Deployment Guide.

Self-Hosting with Kubernetes & Helm (for Scalable Deployments)

For production or larger-scale self-hosted deployments, Opik can be installed on a Kubernetes cluster using our Helm chart. Click the badge for the full Kubernetes Installation Guide using Helm.

<a id="-opik-client-sdk"></a>

💻 Opik Client SDK

Opik provides a suite of client libraries and a REST API to interact with the Opik server. This includes SDKs for Python and TypeScript, plus first-party OpenTelemetry support: any language with an OpenTelemetry SDK — including Java, Ruby, and .NET — can send traces to Opik. For detailed API and SDK references, see the Opik Client Reference Documentation.

📝 Logging Traces with Integrations

The easiest way to log traces is to use one of our direct integrations. Opik supports a wide array of frameworks, including recent additions like Google ADK, Autogen, AG2, and Flowise AI:

[!TIP] If the framework you are using is not listed above, feel free to open an issue or submit a PR with the integration.

If you are not using any of the frameworks above, you can also use the track function decorator to log traces:

import opik

opik.configure(use_local=True) # Run locally

@opik.track
def my_llm_function(user_question: str) -> str:
    # Your LLM code here

    return "Hello"

[!TIP] The track decorator can be used in conjunction with any of our integrations and can also be used to track nested function calls.

<a id="-llm-as-a-judge-metrics"></a>

📊 How Does Opik Compare?

Opik competes in the LLM observability / AI agent evaluation category alongside LangSmith, Arize (Phoenix and Arize AX), Weights & Biases (Weave), Langfuse, and Braintrust.

When teams choose Opik: Opik's full observability, evaluation, and optimization platform is Apache-2.0 licensed and free to self-host. Unlike closed platforms whose self-hosted deployment requires an Enterprise plan, Opik can be deployed without a commercial license, and it's framework-agnostic so it won't lock you into a single agent ecosystem. See the table above for where self-hosting and licensing differ across alternatives.

<br>

<a id="-frequently-asked-questions"></a>

❓ Frequently Asked Questions

#### Is Opik open source? Opik is licensed under Apache 2.0. Its server, web application, and core observability and evaluation capabilities can be self-hosted without a commercial license.

#### Can I self-host Opik? Yes. Opik can be deployed locally or in your own infrastructure using the documented self-hosting options.

#### Does Opik support AI agent tracing? Yes. Opik captures multi-step traces containing LLM calls, tool executions, retrieval steps, and other agent activity.

#### Does Opik support LLM evaluation? Yes. Opik supports datasets, experiments, code-based metrics, LLM-as-a-judge evaluation, and online evaluation.

#### Is Opik tied to a specific agent framework? No. Opik is framework-agnostic and supports its SDK, OpenTelemetry, and framework-specific integrations.

<br>

<a id="%EF%B8%8F-opik-server-installation"></a>