Skip to content

Audit logs #254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@
"product/enterprise-offering/budget-limits",
"product/enterprise-offering/security-portkey",
"product/enterprise-offering/logs-export",
"/product/enterprise-offering/audit-logs",
{
"group": "Private Cloud Deployments",
"pages": [
Expand Down Expand Up @@ -2096,4 +2097,4 @@
"seo": {
"indexing": "all"
}
}
}
Binary file added images/product/audit-logs-filter.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/product/audit-logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
140 changes: 140 additions & 0 deletions product/enterprise-offering/audit-logs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
---
title: "Audit Logs"
description: "Track and monitor all administrative activities across your Portkey organization with comprehensive audit logging."
---

<Check>
This is a Portkey [**Enterprise**](https://portkey.ai/docs/product/enterprise-offering) plan feature.
</Check>

## Overview

Audit Logs in Portkey provide a comprehensive record of all administrative activities across your organization. These logs capture detailed information about who performed what actions, on which resources, and when those actions occurred. This level of visibility is crucial for security monitoring, compliance requirements, and troubleshooting operational issues.

<Frame>
<img src="/images/product/audit-logs.png"/>
</Frame>

## Key Benefits

- **Enhanced Security**: Track all changes to your organization's resources and configurations
- **Compliance Support**: Maintain detailed records to help meet regulatory requirements
- **Operational Visibility**: Understand who is making changes and when
- **Troubleshooting**: Investigate issues by reviewing recent configuration changes
- **Accountability**: Ensure users are responsible for their actions within the platform

## Logged Information

Each audit log entry contains detailed information about administrative activities:

| Field | Description |
|-------|-------------|
| Timestamp | Date and time when the action occurred |
| User | The individual who performed the action |
| Workspace | The workspace context in which the action was performed (if applicable) |
| Action | The type of operation performed (create, update, delete, etc.) |
| Resource | The specific resource or entity that was affected |
| Response Status | HTTP status code indicating the result of the action |
| Client IP | IP address from which the request originated |
| Country | Geographic location associated with the request |


<Note>
Setting up Audit Logs is straightforward:

1. Access is available to org owners and admins
2. Audit logs are automatically collected across all workspaces
3. No additional configuration needed - just enable and go
4. Access audit logs through the `Admin Settings` > `Audit Logs` page
</Note>


## Filtering Capabilities

Portkey provides powerful filtering options to help you find specific audit events quickly:

<Frame>
<img src="/images/product/audit-logs-filter.jpg"/>
</Frame>

### Available Filters

- **Method**: Filter by HTTP method (PUT, POST, DELETE)
- **Request ID**: Search for a specific request by its unique identifier
- **Resource Type**: Filter by type of resource affected:
- Workspaces
- API Keys
- Virtual Keys
- Configs
- Prompts
- Guardrails
- Integrations
- Collections
- Organization
- Labels
- Custom Resource Types
- **Action**: Filter by the type of action performed:
- Create
- Update
- Delete
- Publish
- Export
- Rotate
- Manage
- Duplicate
- **Response Status**: Filter by HTTP response status codes
- **Workspace**: Filter by specific workspace
- **User**: Filter by the user who performed the action
- **Client IP**: Filter by originating IP address
- **Country**: Filter by geographic location of requests
- **Time Range**: Filter logs within a specific time period

## Enterprise Features

Portkey's Audit Logs include enterprise-grade capabilities:

### 1. Complete Visibility
- Full user attribution for every action
- Detailed timestamps and change history
- Cross-workspace tracking
- Searchable audit trail

### 2. Compliance & Security
- SOC 2, ISO 27001, GDPR, and HIPAA compliant
- PII data protection
- Indefinite log retention

### 3. Enterprise-Grade Features
- Role-based access control
- Cross-organization visibility
- Custom retention policies

> As a Director of AI Infrastructure at a Fortune 100 Healthcare company explained: *"Having a detailed audit trail isn't just about compliance. It's about being able to debug production issues quickly, understand usage patterns, and make data-driven decisions about our AI infrastructure."*


## Related Features

<CardGroup cols={2}>
<Card title="Access Control Management" icon="user-lock" href="/product/enterprise-offering/access-control-management">
Manage user roles and permissions across your organization
</Card>
<Card title="Organizations" icon="building" href="/product/enterprise-offering/org-management/organizations">
Learn about organization structure and management
</Card>
<Card title="Workspaces" icon="folder-tree" href="/product/enterprise-offering/org-management/workspaces">
Understand workspace management within your organization
</Card>
<Card title="API Keys" icon="key" href="/product/enterprise-offering/org-management/api-keys-authn-and-authz">
Authentication and authorization with API keys
</Card>
</CardGroup>

## Support

For questions about Audit Logs or assistance with interpreting specific entries, contact [Portkey support](mailto:[email protected]) or reach out on [Discord](https://portkey.sh/reddit-discord).

<Card title="Schedule a Demo" icon="calendar" color="#0e7490" href="https://portkey.sh/demo-20">
Ready to bring enterprise-grade governance to your AI infrastructure? Learn more about Portkey's Audit Logs and other enterprise features in a personalized demo.

</Card>
---