Skip to content
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

Feature/1273 rate limiting redis #1285

Merged
merged 2 commits into from
Mar 23, 2024

Conversation

happyRip
Copy link
Member

Summary

Closes #1273

Screenshots

localhost_1313_reference_rate-limiting_(Laptop with HiDPI screen)

Changes

  • Add section regarding rate limiting providers
  • Remove duplicate of rate limiting configuration example

Notes for Reviewers

nil

Checklist

  • Scope: The referenced issue is addressed, there are no unrelated changes.
  • Run Locally: Verified that the docs build using make server, posted screenshots, verified external links. Test with HUGO_PARAMS_SEARCH_ENABLED=true if style changes will affect the search bar.
  • New Features Marked: Documentation for new features is marked using the new-in-version shortcode, according to the guidelines in CONTRIBUTING.
  • Style Guidelines: Documentation obeys style guidelines in CONTRIBUTING.
  • Commits: Commit messages follow guidelines in CONTRIBUTING, there are no fixup commits left.

@happyRip happyRip added this to the Mar 2024 milestone Mar 14, 2024
@happyRip happyRip self-assigned this Mar 14, 2024
max-burst: 1500
associations:
- gs:up
provider: `redis`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you set the provider along with profiles or?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, provider is one of the possible options for rate-limiting, so you can use

rate-limiting:
  provider: ...
  profiles:
    - ...
    - ...

but the same example (that was removed) is available at

```yaml
rate-limiting:
profiles:
- name: HTTP servers
max-per-min: 30
associations:
- http
- name: User login
max-per-min: 10
associations:
- http:account
- name: Create new users
max-per-min: 10
associations:
- grpc:method:/ttn.lorawan.v3.UserRegistry/Create
- name: Application downlink traffic
max-per-min: 10
associations:
- as:down:web
- as:down:mqtt
- grpc:method:/ttn.v3.lorawan.v3.AppAs/DownlinkQueuePush
- grpc:method:/ttn.v3.lorawan.v3.AppAs/DownlinkQueueReplace
- name: Gateway connections
max-per-min: 5
associations:
- gs:accept:mqtt
- gs:accept:ws
- grpc:stream:accept:/ttn.lorawan.v3.GtwGs/LinkGateway
- name: gRPC API
max-per-min: 60
associations:
- grpc:method
- grpc:stream:accept
- name: Override rate for uplink simulation
max-per-min: 5
associations:
- grpc:method:/ttn.lorawan.v3.AppAs/SimulateUplink
- name: Gateway uplink traffic
max-per-min: 1000
max-burst: 1500
associations:
- gs:up
```

@happyRip happyRip requested a review from nejraselimovic March 19, 2024 23:04
@nejraselimovic nejraselimovic merged commit 29854c2 into master Mar 23, 2024
1 check passed
@nejraselimovic nejraselimovic deleted the feature/1273-rate-limiting-redis branch March 23, 2024 07:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rate limiting Redis backend
2 participants