You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: integrations/plugins/exa.mdx
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,6 +70,9 @@ This process allows any LLM to respond with up-to-date knowledge without retrain
70
70
71
71
* Save this config and note its Config ID for use in your requests
72
72
73
+
<Note>
74
+
The Exa Plugin is supported only as an `input guardrail`. It adds web search results to your request before it reaches the LLM, which is why only `before_request_hooks` are supported and not `after_request_hooks` on Portkey's gateway. [Learn more about guardrails here](/product/guardrails)
description: "Easily access your Portkey logs data for further analysis and reporting"
4
+
---
5
+
6
+
<Info>
7
+
Logs export feature is only available for [**Production**](https://portkey.ai/pricing) and [**Enterprise**](https://portkey.ai/docs/product/enterprise-offering) users.
8
+
</Info>
9
+
10
+
<Note>
11
+
Portkey offers an in-app logs export feature that is not generally available yet. If you're interested in early access, contact us at [email protected].
12
+
</Note>
13
+
14
+
At Portkey, we understand the importance of data analysis and reporting for businesses and teams. That's why we provide a comprehensive logs export feature for our paid users. With this feature, you can easily request and obtain your Portkey logs data in a **structured JSON** format, allowing you to gain valuable insights into your LLM usage, performance, costs, and more.
15
+
16
+
## Requesting Logs Export
17
+
18
+
To submit a data export request, simply follow these steps:
19
+
20
+
1. Ensure you are an admin of your organization on Portkey.
* Specify the **time frame** for which you require the logs data. **Pro plan** supports logs export of **last 30** days.
24
+
* Share names of the **specific columns** you require (see the "[Exported Data](/product/observability/logs-export#exported-data)" section below for a complete list of available columns).
25
+
4. Our team will process your request and provide you with the exported logs data in JSON format.
26
+
27
+
<Note>
28
+
Note: Portkey only supports data exports in the `JSONL` format, and can not process exports in any other formats at the moment.
29
+
</Note>
30
+
31
+
## Exported Data
32
+
33
+
The exported logs data will include the following columns:
| virtual\_key | Virtual key used for the request |
59
+
| runtime | Runtime environment |
60
+
| runtime\_version | Runtime environment version |
61
+
| sdk\_version | Portkey SDK version |
62
+
| config | Config ID used for the request |
63
+
| prompt\_slug | Prompt ID used for the request |
64
+
| prompt\_version\_id | Version number of the prompt template slug |
65
+
| metadata.key | Custom metadata key |
66
+
| metadata.value | Custom metadata value |
67
+
68
+
With this comprehensive data, you can analyze your API usage patterns, monitor performance, optimize costs, and make data-driven decisions for your business or team.
69
+
70
+
## Support
71
+
72
+
If you have any questions or need assistance with the logs export feature, reach out to the Portkey team at [email protected] or hop on to our [Discord server](https://portkey.ai/community).
Copy file name to clipboardExpand all lines: product/observability/logs-export.mdx
+88-61Lines changed: 88 additions & 61 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,69 +4,96 @@ description: "Easily access your Portkey logs data for further analysis and repo
4
4
---
5
5
6
6
<Info>
7
-
Logs export feature is only available for [**Production**](https://portkey.ai/pricing) and [**Enterprise**](https://portkey.ai/docs/product/enterprise-offering) users.
7
+
Logs export feature is available for all the users.
8
8
</Info>
9
9
10
-
<Note>
11
-
Portkey offers an in-app logs export feature that is not generally available yet. If you're interested in early access, contact us at [email protected].
12
-
</Note>
13
-
14
-
At Portkey, we understand the importance of data analysis and reporting for businesses and teams. That's why we provide a comprehensive logs export feature for our paid users. With this feature, you can easily request and obtain your Portkey logs data in a **structured JSON** format, allowing you to gain valuable insights into your LLM usage, performance, costs, and more.
15
-
16
-
## Requesting Logs Export
17
-
18
-
To submit a data export request, simply follow these steps:
19
-
20
-
1. Ensure you are an admin of your organization on Portkey.
* Specify the **time frame** for which you require the logs data. **Pro plan** supports logs export of **last 30** days.
24
-
* Share names of the **specific columns** you require (see the "[Exported Data](/product/observability/logs-export#exported-data)" section below for a complete list of available columns).
25
-
4. Our team will process your request and provide you with the exported logs data in JSON format.
26
-
27
-
<Note>
28
-
Note: Portkey only supports data exports in the `JSONL` format, and can not process exports in any other formats at the moment.
29
-
</Note>
30
-
31
-
## Exported Data
32
-
33
-
The exported logs data will include the following columns:
| virtual\_key | Virtual key used for the request |
59
-
| runtime | Runtime environment |
60
-
| runtime\_version | Runtime environment version |
61
-
| sdk\_version | Portkey SDK version |
62
-
| config | Config ID used for the request |
63
-
| prompt\_slug | Prompt ID used for the request |
64
-
| prompt\_version\_id | Version number of the prompt template slug |
65
-
| metadata.key | Custom metadata key |
66
-
| metadata.value | Custom metadata value |
67
-
68
-
With this comprehensive data, you can analyze your API usage patterns, monitor performance, optimize costs, and make data-driven decisions for your business or team.
10
+
At Portkey, we understand the importance of data analysis and reporting for businesses and teams. That's why we provide a comprehensive logs export feature that allows you to download your Portkey logs data in a **structured format**, enabling you to gain valuable insights into your LLM usage, performance, costs, and more.
11
+
12
+
## Exporting Logs In-App
13
+
14
+
You can now export logs directly from the Portkey application by following these steps:
15
+
16
+
1. Navigate to the **Exports** section on the main sidebar.
17
+
18
+
2. Click the **Request Data** button in the top-right corner.
19
+
20
+
3. Configure your export parameters:
21
+
-**Time Range**: Select the period for which you want to export logs
22
+
-**Logs Limits**: Choose maximum number of logs or set a custom offset
23
+
-**Requested Fields**: Select which data columns to include in your export
| Trace ID | Identifier for tracing related requests |
40
+
| Created At | Timestamp of the request |
41
+
| Request | Request JSON payload |
42
+
| Response | Response JSON payload |
43
+
| AI Provider | Name of the AI provider used |
44
+
| AI Model | Name of the AI model used |
45
+
| Request Tokens | Number of tokens in the request |
46
+
| Response Tokens | Number of tokens in the response |
47
+
| Total Tokens | Total number of tokens (request + response) |
48
+
| Cost | Cost of the request in cents (USD) |
49
+
| Cost Currency | Currency of the cost (USD) |
50
+
| Response Time | Response time in milliseconds |
51
+
| Status Code | HTTP response status code |
52
+
| Config | Config ID used for the request |
53
+
| Prompt Slug | Prompt ID used for the request |
54
+
| Metadata | Custom metadata key-value pairs |
55
+
56
+
57
+
5. Once your export is processed, you'll see it in the exports list with a status indicator:
58
+
-**Draft**: Export job created but not yet started
59
+
-**Success**: Export completed successfully
60
+
-**Failure**: Export job failed. Click on the `Start Again` button to retry the job.
61
+
62
+
6. Clik on the **Start** button the dashboard to start the logs-export job
63
+
64
+
7. For completed exports, click the **Download** button to get your logs data file. You can
65
+
66
+
<Frame>
67
+
<imgsrc="/images/product/logs-export-1.png"alt="List of exports with status and download options"/>
68
+
</Frame>
69
+
70
+
<Note>
71
+
Currently we only support exporting 50k logs per job. For more help reach out to the Portkey team at [[email protected]](mailto:[email protected])
72
+
</Note>
73
+
74
+
## Export File Details
75
+
76
+
Exported logs are provided in JSONL format (JSON Lines), where each line is a valid JSON object representing a single log entry. This format is ideal for data processing and analysis with tools like Python's Pandas or other data analysis frameworks.
77
+
78
+
Each export includes:
79
+
- Up to 50,000 logs per export job (as shown in the preview panel)
80
+
- All fields selected during the export configuration
81
+
- A timestamp indicating when the export was created
82
+
83
+
## Use Cases for Exported Logs
84
+
85
+
With your exported logs data, you can:
86
+
- Generate custom reports for stakeholders
87
+
- Feed data into business intelligence tools
88
+
- Identify patterns in user behavior and model performance
89
+
90
+
You can analyze your API usage patterns, monitor performance, optimize costs, and make data-driven decisions for your business or team.
69
91
70
92
## Support
71
93
72
-
If you have any questions or need assistance with the logs export feature, reach out to the Portkey team at [email protected] or hop on to our [Discord server](https://portkey.ai/community).
94
+
If you have any questions or need assistance with the logs export feature, reach out to the Portkey team at [[email protected]](mailto:[email protected]) or join our [Discord community](https://portkey.ai/community).
0 commit comments