Skip to content

chore: mongo maintainance notice #127

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.

Sign up for GitHub

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

Open
sk-portkey wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: mongo maintainance notice #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions charts/portkey-app/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ config:

# -- Log storage configuration
# Used to store raw inputs & outputs of all requests going through portkey
# We support all S3 and mongo compliant store, AWS s3, Azure blob storage, and GCS, R2, Wasabi, NetApp,etc and MongoDB, AWS DocumentDB
# You can also use s3 via AWS IAM Assume Role if you s3 buckets are in a different account.
# We support all S3 compliant stores: AWS S3, Azure Blob Storage, GCS, R2, Wasabi, NetApp, etc.
# You can also use S3 via AWS IAM Assume Role if your S3 buckets are in a different account.
# logStorage:
# -- S3 specific configuration
logStorage:
Expand All @@ -124,6 +124,7 @@ logStorage:
LOG_STORE_REGION: ""
LOG_STORE_GENERATIONS_BUCKET: ""
LOG_STORE_BASEPATH: ""
# -- MongoDB configuration (⚠️ MAINTENANCE MODE)
mongo:
enabled: false
MONGO_DB_CONNECTION_URL: ""
Expand Down
14 changes: 13 additions & 1 deletion charts/portkey-gateway/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,19 @@ AZURE_ENTRA_TENANT_ID: "<Azure Entra Tenant Id>"
```
</details>

### MongoDB
### MongoDB (⚠️ Maintenance Mode)

> **⚠️ MAINTENANCE MODE NOTICE**
>
> MongoDB as a LOG_STORE is now in **maintenance mode**. We recommend using S3-compatible storage (AWS S3, Azure Blob, GCS, etc.) for new deployments.
>
> **Known Limitations:**
> - **16MB document size limit**: MongoDB has a maximum document size of 16MB, which can be exceeded by large LLM request/response payloads
> - **No streaming support**: MongoDB doesn't support streaming writes, requiring the entire document to be buffered before insert
> - **Bulk insert limitations**: Large batch operations may face performance issues and transaction timeouts
>
> Existing MongoDB deployments will continue to be supported, but no new features will be added.

<details>
<summary>Detailed MongoDB setup</summary>

Expand Down
10 changes: 6 additions & 4 deletions charts/portkey-gateway/docs/Configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,10 +156,12 @@ environment:
| `environment.data.SERVICE_NAME` | string | `"portkeyenterprise"` | Service name identifier |
| `environment.data.PORT` | string | `"8787"` | Gateway service port |
| `environment.data.LOG_STORE` | string | `""` | Log storage backend (e.g., s3, azure) |
| `environment.data.MONGO_DB_CONNECTION_URL` | string | `""` | MongoDB connection URL (consider using secretKeys) |
| `environment.data.MONGO_DATABASE` | string | `""` | MongoDB database name |
| `environment.data.MONGO_COLLECTION_NAME` | string | `""` | MongoDB collection for logs |
| `environment.data.MONGO_GENERATIONS_HOOKS_COLLECTION_NAME` | string | `""` | MongoDB collection for generation hooks |
| `environment.data.MONGO_DB_CONNECTION_URL` | string | `""` | ⚠️ **Maintenance Mode** - MongoDB connection URL (consider using secretKeys) |
| `environment.data.MONGO_DATABASE` | string | `""` | ⚠️ **Maintenance Mode** - MongoDB database name |
| `environment.data.MONGO_COLLECTION_NAME` | string | `""` | ⚠️ **Maintenance Mode** - MongoDB collection for logs |
| `environment.data.MONGO_GENERATIONS_HOOKS_COLLECTION_NAME` | string | `""` | ⚠️ **Maintenance Mode** - MongoDB collection for generation hooks |

> **Note**: MongoDB as LOG_STORE is in maintenance mode. Known limitations include: 16MB document size limit, no streaming support for writes, and bulk insert performance issues. We recommend using S3-compatible storage for new deployments.
| `environment.data.LOG_STORE_REGION` | string | `""` | AWS/Azure region for log storage |
| `environment.data.LOG_STORE_ACCESS_KEY` | string | `""` | Access key for log storage (consider using secretKeys) |
| `environment.data.LOG_STORE_SECRET_KEY` | string | `""` | Secret key for log storage (consider using secretKeys) |
Expand Down
9 changes: 5 additions & 4 deletions charts/portkey-gateway/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,17 +76,18 @@ environment:
SERVICE_NAME: portkeyenterprise
PORT: "8787"
LOG_STORE:
MONGO_DB_CONNECTION_URL:
MONGO_DATABASE:
MONGO_COLLECTION_NAME:
MONGO_GENERATIONS_HOOKS_COLLECTION_NAME:
LOG_STORE_REGION:
LOG_STORE_ACCESS_KEY:
LOG_STORE_SECRET_KEY:
LOG_STORE_GENERATIONS_BUCKET:
LOG_STORE_BASEPATH:
LOG_STORE_AWS_ROLE_ARN:
LOG_STORE_AWS_EXTERNAL_ID:
# -- MongoDB configuration (⚠️ MAINTENANCE MODE)
MONGO_DB_CONNECTION_URL:
MONGO_DATABASE:
MONGO_COLLECTION_NAME:
MONGO_GENERATIONS_HOOKS_COLLECTION_NAME:
AWS_ASSUME_ROLE_ACCESS_KEY_ID:
AWS_ASSUME_ROLE_SECRET_ACCESS_KEY:
AWS_ASSUME_ROLE_REGION:
Expand Down