-
Notifications
You must be signed in to change notification settings - Fork 218
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Dify documentation to Opik (#879)
- Loading branch information
1 parent
dc0dd33
commit a128a1c
Showing
5 changed files
with
57 additions
and
0 deletions.
There are no files selected for viewing
55 changes: 55 additions & 0 deletions
55
apps/opik-documentation/documentation/docs/tracing/integrations/dify.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
sidebar_label: Dify | ||
--- | ||
|
||
import Tabs from "@theme/Tabs"; | ||
import TabItem from "@theme/TabItem"; | ||
|
||
# Dify Integration | ||
|
||
Learn how to connect Opik with Dify to monitor your applications' performance. | ||
|
||
## Setup Instructions | ||
|
||
Follow these simple steps to connect Dify with Opik: | ||
|
||
1. Select the Dify app you want to monitor | ||
2. Select **Monitoring** from the side menu | ||
3. Click on **Tracing app performance** | ||
4. Click on **Configure** for Opik | ||
5. Enter your connection details based on your Opik version: | ||
|
||
![How to configure Dify settings](/img/tracing/dify_configuration.png) | ||
|
||
<Tabs> | ||
<TabItem value="Hosted Opik" title="Hosted Opik"> | ||
|
||
Fill in these fields: | ||
- **API Key**: Your Comet API Key | ||
- **Project**: Your preferred project name (if left empty, it will be created automatically) | ||
- **Workspace**: Your Comet Workspace name (must already exist) | ||
- **URL**: Your Opik installation URL (make sure it ends with `/api/`) | ||
|
||
</TabItem> | ||
|
||
<TabItem value="Self-Hosted Opik" title="Self-Hosted Opik"> | ||
|
||
Fill in these fields: | ||
- **API Key**: Leave this empty | ||
- **Project**: Your preferred project name (if left empty, it will be created automatically) | ||
- **Workspace**: Type `default` | ||
- **URL**: Your Opik installation URL (make sure it ends with `/api/`) | ||
|
||
</TabItem> | ||
|
||
</Tabs> | ||
|
||
## How to View Your Traces | ||
|
||
After setup, you can view your application traces by: | ||
|
||
1. Opening the **Monitoring** section from the side menu | ||
2. Finding and clicking the **OPIK** button in the top-right corner | ||
3. Selecting **View** to open your Opik project dashboard | ||
|
||
![How to view your Opik project](/img/tracing/dify_view_project.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+174 KB
apps/opik-documentation/documentation/static/img/tracing/dify_configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+62.3 KB
apps/opik-documentation/documentation/static/img/tracing/dify_view_project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.