fluxninja / aperture

Rate limiting, caching, and request prioritization for modern workloads
https://docs.fluxninja.com
Apache License 2.0
641 stars 25 forks source link

Ksohi/add quota scheduler guide #3038

Closed karansohi closed 11 months ago

karansohi commented 11 months ago

Description of change

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 11 months ago

Walkthrough

The recent updates introduce comprehensive guidance and examples for managing API quotas and rate limiting using the Aperture SDK. New documents and scripts have been added to assist users in setting up quota scheduling policies and monitoring their performance. The SDK examples have been enriched with functions to initialize the Aperture Client, handle request rate limits, and schedule requests based on user tiers, enhancing the developer experience with practical, executable code.

Changes

File Path Change Summary
docs/content/guides/api-quota-management.md Added new document for API Quota Management with Aperture SDK instructions and examples.
docs/content/guides/assets/managing-quotas/validate.sh Introduced new Bash script for validating quota management setups.
docs/content/guides/assets/per-user-rate-limiting/validate.sh Updated paths for copying generated policy and graph files.
docs/content/guides/openai.md Updated sidebar position and import paths for managing OpenAI API rate limits.
docs/content/guides/per-user-rate-limiting.md Added instructions for setting up and monitoring rate limiting policies in Aperture.
sdks/aperture-js/example/quota_scheduler_example.ts Added new SDK example for quota scheduling with ApertureClient and inquirer.
sdks/aperture-js/example/rate_limit_example.ts Added new SDK example for rate limiting with ApertureClient and inquirer.

🐇✨ In the land of code where the data streams flow,
The Aperture SDK has put on a show.
With quotas and limits all neatly in line,
The rabbits rejoice, "The API's fine!"
🎉🐰


Tips ### Chat with CodeRabbit Bot (`@coderabbitai`) - If you reply to a *review comment* from CodeRabbit, the bot will automatically respond. - To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment - Note: Review comments are made on code diffs or files, not on the PR overview. - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Note: For conversation with the bot, please use the review comments on code diffs or files. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json`