Skip to main content

What is Opik

Opik is an open-source platform designed for evaluating, testing, and monitoring large language model (LLM) applications. Developed by Comet, it aims to facilitate more intuitive collaboration, testing, and monitoring of LLM-based applications.
For more details, please refer to Opik.

How to Configure Opik

For hosted Opik, follow the account and API key steps below. For a self-hosted instance without authentication, you can leave API Key blank.

1. Register/Login to Opik

2. Get your Opik API Key

Retrieve your Opik API Key from the user menu at the top-right. Click on API Key, then on the API Key to copy it:
Opik API Key

3. Integrate Opik with Dify

Configure Opik in the Dify application. Open the application you need to monitor, open Monitoring in the side menu, and select Tracing app performance on the page.
Tracing App Performance
After clicking configure, enter your API Key if required and the project name. A blank project uses Default Project; a new project is created on the first trace. Workspace can be left blank to use the account’s default workspace. For self-hosted Opik, set Url to its API base URL ending in /api/ (the default is https://www.comet.com/opik/api/), then save.
Configure Opik
Once successfully saved, you can view the monitoring status on the current page.

View Monitoring Data in Opik

Once configured, you can debug or use the Dify application as usual. New runs can be monitored in Opik; earlier usage history is not backfilled.
Viewing Application Data in Opik
When you switch to Opik, you can view detailed operation logs of Dify applications in the dashboard.
Viewing Application Data in Opik
Detailed LLM operation logs through Opik will help you optimize the performance of your Dify application.
Viewing Application Data in Opik
After saving and enabling tracing, run the app again and check for a new trace in the monitoring service. Delivery is asynchronous; saving the configuration alone does not confirm that a trace has arrived.For the new Agent app type and workflows using the new Agent node, Capture content is off by default: inputs, outputs, and most metadata are removed, and error text is redacted across the whole workflow. Enable it to send that content. Classic agent-chat apps and workflows using only classic Agent nodes retain ordinary tracing.

Monitoring Data List

The tables below describe ordinary traces. For the new Agent app type or workflows containing a new Agent node, traces use a new UUIDv7 trace ID, with source and tracing-run IDs retained as dify.source.id and dify.tracing.run_id attributes. For the new Agent app type, Agent attempt spans with internal model and tool calls replace the ordinary llm span when Capture Agent internals is on. Separate moderation, suggested-question, and naming records are omitted for collected runs. Dify exports a hierarchy of operations: a message contains an llm call, and a Chatflow message contains its workflow and node operations. Provider trace and span IDs are derived from Dify identifiers rather than copied directly from database IDs. Native token usage is reported on model calls only. For Chatflow, the trace root is the message, with the user’s query as input (or workflow inputs when the query is empty). Its workflow child retains the workflow inputs and outputs. The detail lists below describe Dify’s source records and metadata. Only the relevant, available values are exported; the raw records are not sent in full.

Workflow/Chatflow Trace Information

Used to track workflows and chatflows
WorkflowOpik Trace
Derived trace IDid (trace)
user_idmetadata.user_id
workflow (Workflow) / message (Chatflow)name
start_timestart_time
end_timeend_time
Workflow inputs / Chatflow query (workflow inputs if empty)input
outputsoutput
Model token consumption (LLM calls)usage (llm spans only; absent from trace body)
metadatametadata
errorerror_info
Session IDthread_id (trace)
Workflow Trace Info
  • workflow_id - Unique identifier of the workflow
  • conversation_id - Conversation ID
  • workflow_run_id - ID of the current run
  • tenant_id - Tenant ID
  • elapsed_time - Time taken for the current run
  • status - Run status
  • version - Workflow version
  • total_tokens - Total tokens used in the current run
  • file_list - List of processed files
  • triggered_from - Source that triggered the current run
  • workflow_run_inputs - Input data for the current run
  • workflow_run_outputs - Output data for the current run
  • error - Errors encountered during the current run
  • query - Query used during the run
  • workflow_app_log_id - Workflow application log ID
  • message_id - Associated message ID
  • start_time - Start time of the run
  • end_time - End time of the run
  • workflow node executions - Information about workflow node executions
  • Metadata
    • workflow_id - Unique identifier of the workflow
    • conversation_id - Conversation ID
    • workflow_run_id - ID of the current run
    • tenant_id - Tenant ID
    • elapsed_time - Time taken for the current run
    • status - Run status
    • version - Workflow version
    • total_tokens - Total tokens used in the current run
    • file_list - List of processed files
    • triggered_from - Source that triggered the current run

Message Trace Information

Used to track LLM-related conversations
ChatOpik Trace
Derived trace IDid (trace)
end_user_session_id (or user_id)metadata.user_id (trace)
messagename
start_timestart_time
end_timeend_time
inputsinput
outputsoutput
Model token consumption (LLM calls)usage (llm spans only; absent from trace body)
metadatametadata
Session IDthread_id (trace)
Message Trace Info
  • message_id - Message ID
  • message_data - Message data
  • end_user_session_id - User session ID
  • conversation_model - Conversation mode
  • message_tokens - Number of tokens in the message
  • answer_tokens - Number of tokens in the answer
  • total_tokens - Total number of tokens in the message and answer
  • error - Error information
  • inputs - Input data
  • outputs - Output data
  • file_list - List of processed files
  • start_time - Start time
  • end_time - End time
  • conversation_mode - Conversation mode
  • Metadata
    • conversation_id - Conversation ID
    • ls_provider - Model provider
    • ls_model_name - Model ID
    • status - Message status
    • from_end_user_id - ID of the sending user
    • from_account_id - ID of the sending account
    • agent_based - Whether the message is agent-based
    • workflow_run_id - Workflow run ID
    • from_source - Message source

Moderation Trace Information

Used to track conversation moderation
ModerationOpik Tool
user_idmetadata.user_id
moderationname
start_timestart_time
end_timeend_time
inputsinput
action, flaggedoutput
metadatametadata
Moderation Trace Info
  • message_id - Message ID
  • user_id: User ID
  • workflow_app_log_id - Workflow application log ID
  • inputs - Moderation input data
  • message_data - Message data
  • flagged - Whether the content is flagged for attention
  • action - Specific actions taken
  • preset_response - Preset response
  • start_time - Moderation start time
  • end_time - Moderation end time
  • Metadata
    • message_id - Message ID
    • action - Specific actions taken
    • preset_response - Preset response

Suggested Question Trace Information

Used to track suggested questions Sent as a tool span in the message’s trace.
Suggested QuestionOpik Tool span
user_idmetadata.user_id
”suggested_question”name
start_timestart_time
end_timeend_time
inputsinput
suggested_questionoutput
metadatametadata
Message Trace Info
  • message_id - Message ID
  • message_data - Message data
  • inputs - Input content
  • outputs - Output content
  • start_time - Start time
  • end_time - End time
  • total_tokens - Number of tokens
  • status - Message status
  • error - Error information
  • from_account_id - ID of the sending account
  • agent_based - Whether the message is agent-based
  • from_source - Message source
  • model_provider - Model provider
  • model_id - Model ID
  • suggested_question - Suggested question
  • level - Status level
  • status_message - Status message
  • Metadata
    • message_id - Message ID
    • ls_provider - Model provider
    • ls_model_name - Model ID
    • status - Message status
    • from_end_user_id - ID of the sending user
    • from_account_id - ID of the sending account
    • workflow_run_id - Workflow run ID
    • from_source - Message source

Dataset Retrieval Trace Information

Used to track knowledge base retrieval
Dataset RetrievalOpik Retriever
user_idmetadata.user_id
”dataset_retrieval”name
start_timestart_time
end_timeend_time
inputsinput
documentsoutput
metadatametadata
message_idtrace_id
Dataset Retrieval Trace Info
  • message_id - Message ID
  • inputs - Input content
  • documents - Document data
  • start_time - Start time
  • end_time - End time
  • message_data - Message data
  • Metadata
    • message_id - Message ID
    • ls_provider - Model provider
    • ls_model_name - Model ID
    • status - Message status
    • from_end_user_id - ID of the sending user
    • from_account_id - ID of the sending account
    • agent_based - Whether the message is agent-based
    • workflow_run_id - Workflow run ID
    • from_source - Message source

Tool Trace Information

Used to track tool invocation
ToolOpik Tool
user_idmetadata.user_id
tool_namename
start_timestart_time
end_timeend_time
tool_inputsinput
tool_outputsoutput
metadatametadata

Tool Trace Info

  • message_id - Message ID
  • tool_name - Tool name
  • start_time - Start time
  • end_time - End time
  • tool_inputs - Tool inputs
  • tool_outputs - Tool outputs
  • message_data - Message data
  • error - Error information, if any
  • inputs - Inputs for the message
  • outputs - Outputs of the message
  • tool_config - Tool configuration
  • time_cost - Time cost
  • tool_parameters - Tool parameters
  • file_url - URL of the associated file
  • Metadata
    • message_id - Message ID
    • tool_name - Tool name
    • tool_inputs - Tool inputs
    • tool_outputs - Tool outputs
    • tool_config - Tool configuration
    • time_cost - Time cost
    • error - Error information, if any
    • tool_parameters - Tool parameters
    • message_file_id - Message file ID
    • created_by_role - Role of the creator
    • created_user_id - User ID of the creator
Generate Name Trace Information Used to track conversation title generation
Generate NameOpik Tool
user_idmetadata.user_id
generate_namename
start_timestart_time
end_timeend_time
inputsinput
outputsoutput
metadatametadata
Generate Name Trace Info
  • conversation_id - Conversation ID
  • inputs - Input data
  • outputs - Generated conversation name
  • start_time - Start time
  • end_time - End time
  • tenant_id - Tenant ID
  • Metadata
    • conversation_id - Conversation ID
    • tenant_id - Tenant ID
Last modified on November 20, 2026