ratelimit

0.3.1 Opens a new window with list of versions in this module.

A Go blocking leaky-bucket rate limit implementation For more information about how to use this package see README

Latest version published 1 month ago

GitHub

Package Health Score

89 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Active

Popularity

Popular

Imported By: 685
GitHub Stars: 4.09K
Forks: 292
Contributors: 7

Usage Popularity

Based on project statistics from the GitHub repository for the Golang package ratelimit, we found that it has been 4,095 times.

The popularity score for Golang modules is calculated based on the number of stars that the project has on GitHub as well as the number of imports by other modules.

Security

No known security issues

Security risks

Direct Vulnerabilities: 0
C
0
H
0
M
0
L

Indirect Vulnerabilities: Check with Snyk

Release Date

Mar 4, 2024

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like ratelimit is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 7
Open PR: 3
Last Release: 1 month ago
Last Commit: 1 month ago

Further analysis of the maintenance status of go.uber.org/ratelimit based on released golang versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that go.uber.org/ratelimit demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Active

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 7
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like go.uber.org/ratelimit is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your go.mod

Ensure all the packages you're using are healthy and well-maintained

Readme

Go rate limiter

This package provides a Golang implementation of the leaky-bucket rate limit algorithm. This implementation refills the bucket based on the time elapsed between requests instead of requiring an interval clock to fill the bucket discretely.

Create a rate limiter with a maximum number of operations to perform per second. Call Take() before each operation. Take will sleep until you can continue.

import (
	"fmt"
	"time"

	"go.uber.org/ratelimit"
)

func main() {
    rl := ratelimit.New(100) // per second

    prev := time.Now()
    for i := 0; i &lt; 10; i++ {
        now := rl.Take()
        fmt.Println(i, now.Sub(prev))
        prev = now
    }

    // Output:
    // 0 0
    // 1 10ms
    // 2 10ms
    // 3 10ms
    // 4 10ms
    // 5 10ms
    // 6 10ms
    // 7 10ms
    // 8 10ms
    // 9 10ms
}

FAQ:

What's the major diff v.s. https://pkg.go.dev/golang.org/x/time/rate? (based on #77)

This ratelimiter was meant to have a (1) simple API and (2) minimal overhead. For more complex use-cases x/time/rate is a great choice. See here for historical context, and here for benchmarks (from 2016).
Why does example_test.go fail when I run it locally on Windows? (based on #80)

Windows has some known issues with timers precision. See golang/go#44343. We don't expect to work around it.

FAQs

What is ratelimit?

A Go blocking leaky-bucket rate limit implementation. Visit Snyk Advisor to see a full health score report for ratelimit, including popularity, security, maintenance & community analysis.

Is ratelimit popular?

The golang package ratelimit receives a total of ? weekly downloads. As such, ratelimit popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is ratelimit well maintained?

We found that ratelimit demonstrated a healthy version release cadence and project activity. It has a community of 7 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is ratelimit safe to use?

The golang package ratelimit was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 16 April-2024, at 03:35 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP