Conversation
added 2 commits
January 30, 2017 13:19
ccaraman
reviewed
Feb 1, 2017
README.md
Outdated
|
|
||
| # Overview | ||
|
|
||
| The rate limit service is a Go/GRPC service designed to enable generic rate limit scenarios from different types of |
ccaraman
reviewed
Feb 1, 2017
README.md
Outdated
|
|
||
| ## Loading Configuration | ||
|
|
||
| The ratelimit service uses a library written by Lyft called goruntime to do configuration loading. Goruntime monitors |
Contributor
There was a problem hiding this comment.
add hyperlink to go runtime here.
ccaraman
reviewed
Feb 1, 2017
README.md
Outdated
| # Building and Testing | ||
|
|
||
| * Install redis-server | ||
| * Make sure go is setup correctly and checkout rate limit service into your go path |
Contributor
There was a problem hiding this comment.
are there specifics verification steps that a user can perform to ensure that go is setup correctly? I remember this being a bit confusing.
Member
Author
There was a problem hiding this comment.
added link to golang install page
ccaraman
reviewed
Feb 1, 2017
README.md
Outdated
| requests_per_unit: 500 | ||
| ``` | ||
|
|
||
| The rate limit configuration file format is YAML (mainly so that comments are supported). In the configuration above |
Contributor
There was a problem hiding this comment.
I would move this line about configuration file being in yaml under the configuration format.
ccaraman
reviewed
Feb 1, 2017
README.md
Outdated
| ``` | ||
|
|
||
| In the preceding example, we setup a generic rate limit for individual IP addresses. The architecture's edge proxy can | ||
| be configured to make a rate limitservice call with the descriptor ("ip_address", "50.0.0.1") for example. This IP would |
Contributor
There was a problem hiding this comment.
nit: limit service - separate
ccaraman
reviewed
Feb 1, 2017
| would any other IP. However, the configuration also contains a second configuration that explicitly defines a | ||
| value along with the same key. If the descriptor ("ip_address", "50.0.0.5") is received, the service will | ||
| *attempt the most specific match possible*. This means both the most nested matching descriptor entry, as well as | ||
| the most specific at any descriptor list level. Thus, key/value is always attempted as a match before just key. |
Contributor
There was a problem hiding this comment.
the last part is a bit confusing the most specific at any descriptor list level.
Member
Author
There was a problem hiding this comment.
this is going away in the most recent version
ccaraman
reviewed
Feb 1, 2017
README.md
Outdated
| *attempt the most specific match possible*. This means both the most nested matching descriptor entry, as well as | ||
| the most specific at any descriptor list level. Thus, key/value is always attempted as a match before just key. | ||
|
|
||
| ### Descriptor list definition |
Contributor
There was a problem hiding this comment.
I would move this up before the examples.
Merged
mattklein123
approved these changes
Feb 2, 2017
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
@lyft/network-team