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

Update SDK Diagram and add gRPC deadline explanation #3065

Closed karansohi closed 10 months ago

karansohi commented 10 months ago

Description of change

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 10 months ago

Walkthrough

The recent updates across various documentation files focus on the implementation of gRPC deadlines within API calls. These changes highlight the importance of setting a maximum duration for requests to remain in a queue for prioritization purposes, ensuring that requests are either processed or discarded in a timely manner. The updates also refine the decision-making process related to request handling and telemetry.

Changes

File Path Change Summary
.../api-quota-management.md Expanded logic for API limit handling with gRPC deadline in startFlow call.
.../guides/openai.md Added instructions for setting gRPC deadline in startFlow call.
.../introduction.md Removed bold formatting from "Caching".
.../sdk/*/manual.md Emphasized setting higher gRPC deadline for request prioritization and clarified request handling.

🐇✨ In the land of code, where the data streams flow, A rabbit hopped in, with deadlines in tow. "Set your timers," it squeaked with delight, "For requests to queue, then take flight!" 🚀 🐇✨


Tips ### Chat with CodeRabbit Bot (`@coderabbitai`) - You can reply to a review comment made by CodeRabbit. - You can tag CodeRabbit on specific lines of code or files in the PR by tagging `@coderabbitai` in a comment. - You can tag `@coderabbitai` in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions. ### 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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`