|
| 1 | +--- |
| 2 | +title: "(DEPRECATED) Logs Export" |
| 3 | +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. |
| 21 | +2. Send an email to [[email protected]](mailto:[email protected]) with the subject line `Logs Export - [Your_Organization_Name]`. |
| 22 | +3. In the email body, |
| 23 | + * 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: |
| 34 | + |
| 35 | +| Column Name | Column Description / Property | |
| 36 | +| ---------------------- | --------------------------------------------------------- | |
| 37 | +| created\_at | Timestamp of the request | |
| 38 | +| request.body | Request JSON payload (as seen in the Portkey logs) | |
| 39 | +| response.body | Response JSON payload (as seen in the Portkey logs) | |
| 40 | +| is\_success | Request success status (1 = success, 0 = failure) | |
| 41 | +| ai\_org | AI provider name | |
| 42 | +| ai\_model | AI model name | |
| 43 | +| req\_units | Number of tokens in the request | |
| 44 | +| res\_units | Number of tokens in the response | |
| 45 | +| total\_units | Total number of tokens (request + response) | |
| 46 | +| cost | Cost of the request in cents (USD) | |
| 47 | +| cost\_currency | Currency of the cost (USD) | |
| 48 | +| request\_url | Final provider API URL | |
| 49 | +| request\_method | HTTP request method | |
| 50 | +| response\_status\_code | HTTP response status code | |
| 51 | +| response\_time | Response time in milliseconds | |
| 52 | +| cache\_status | Cache status (SEMANTIC HIT, HIT, MISS, DISABLED) | |
| 53 | +| cache\_type | Cache type (SIMPLE, SEMANTIC) | |
| 54 | +| stream\_mode | Stream mode status (TRUE, FALSE) | |
| 55 | +| retry\_success\_count | Number of retries after which request was successful | |
| 56 | +| trace\_id | Trace ID for the request | |
| 57 | +| mode | Config top level strategy (SINGLE, FALLBACK, LOADBALANCE) | |
| 58 | +| 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). |
0 commit comments