mirror of
https://github.com/status-im/consul.git
synced 2025-01-10 13:55:55 +00:00
d4c435856b
Adds automation for generating the map of `gRPC Method Name → Rate Limit Type` used by the middleware introduced in #15550, and will ensure we don't forget to add new endpoints. Engineers must annotate their RPCs in the proto file like so: ``` rpc Foo(FooRequest) returns (FooResponse) { option (consul.internal.ratelimit.spec) = { operation_type: READ, }; } ``` When they run `make proto` a protoc plugin `protoc-gen-consul-rate-limit` will be installed that writes rate-limit specs as a JSON array to a file called `.ratelimit.tmp` (one per protobuf package/directory). After running Buf, `make proto` will execute a post-process script that will ingest all of the `.ratelimit.tmp` files and generate a Go file containing the mappings in the `agent/grpc-middleware` package. In the enterprise repository, it will write an additional file with the enterprise-only endpoints. If an engineer forgets to add the annotation to a new RPC, the plugin will return an error like so: ``` RPC Foo is missing rate-limit specification, fix it with: import "proto-public/annotations/ratelimit/ratelimit.proto"; service Bar { rpc Foo(...) returns (...) { option (hashicorp.consul.internal.ratelimit.spec) = { operation_type: OPERATION_READ | OPERATION_WRITE | OPERATION_EXEMPT, }; } } ``` In the future, this annotation can be extended to support rate-limit category (e.g. KV vs Catalog) and to determine the retry policy.
28 lines
816 B
YAML
28 lines
816 B
YAML
version: v1
|
|
managed:
|
|
enabled: true
|
|
go_package_prefix:
|
|
# this is not github.com/hashicorp/consul/proto because we are going
|
|
# to execute buf generate from the top level directory so that the filepaths
|
|
# contain the full path within the repo. This avoids registration conflicts
|
|
# in protocolbuffers/protobuf-go when Consul starts. Those conflicts would
|
|
# have been due to a protobuf file being registered to a global registry
|
|
# using a relative file name.
|
|
default: github.com/hashicorp/consul
|
|
plugins:
|
|
- name: go
|
|
out: .
|
|
opt:
|
|
- paths=source_relative
|
|
- name: go-grpc
|
|
out: .
|
|
opt:
|
|
- paths=source_relative
|
|
- require_unimplemented_servers=false
|
|
- name: go-binary
|
|
out: .
|
|
- name: consul-rate-limit
|
|
out: .
|
|
opt:
|
|
- paths=source_relative
|