{"id":26597103,"url":"https://github.com/waelson/rate-limit-with-envoy","last_synced_at":"2026-04-16T05:34:19.619Z","repository":{"id":278289788,"uuid":"935107672","full_name":"Waelson/rate-limit-with-envoy","owner":"Waelson","description":"Implementação de um mecanismo de Rate Limit usando o Envoy e uso do Prometheus e Grafana para acompanhamento de métricas","archived":false,"fork":false,"pushed_at":"2025-02-21T09:28:50.000Z","size":3162,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-23T17:45:33.179Z","etag":null,"topics":["envoy","envoyproxy","golang","grafana","prometheus","redis","statsd"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Waelson.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-18T23:12:13.000Z","updated_at":"2025-03-06T02:10:20.000Z","dependencies_parsed_at":"2025-02-19T01:29:49.113Z","dependency_job_id":"2a9629f1-fd6b-476f-a677-964d8abac4f4","html_url":"https://github.com/Waelson/rate-limit-with-envoy","commit_stats":null,"previous_names":["waelson/rate-limit-with-envoy"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Waelson/rate-limit-with-envoy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Waelson%2Frate-limit-with-envoy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Waelson%2Frate-limit-with-envoy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Waelson%2Frate-limit-with-envoy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Waelson%2Frate-limit-with-envoy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Waelson","download_url":"https://codeload.github.com/Waelson/rate-limit-with-envoy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Waelson%2Frate-limit-with-envoy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31872657,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T15:24:51.572Z","status":"online","status_checked_at":"2026-04-16T02:00:06.042Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["envoy","envoyproxy","golang","grafana","prometheus","redis","statsd"],"created_at":"2025-03-23T17:31:06.582Z","updated_at":"2026-04-16T05:34:19.599Z","avatar_url":"https://github.com/Waelson.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rate Limit com Envoy Proxy\n## Introdução\nEssa solução demonstra a utilização de rate limit com Envoy. O rate limit é uma funcionalidade que permite limitar a quantidade de requisições que um serviço pode receber em um determinado período de tempo. O rate limit pode ser aplicado em diferentes níveis, como por exemplo, por serviço, por usuário, por IP, etc.\n\n## Arquitetura\n![Architecture](documentation/architecture.png)\n\n#### Componentes da Arquitetura\n| **Componente**               | **Descrição**                                                                                                                                                                               |\n|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Envoy Proxy**              | Intercepta as requisições antes de encaminhá-las para a aplicação. Verifica se a requisição excede os limites definidos.                                                                    |\n| **Envoy Rate Limit**         | Serviço responsável por verificar se uma requisição excede o limite permitido, baseado nos dados armazenados no Redis. Se o limite for excedido, retorna erro `HTTP 429 Too Many Requests`. |\n| **Redis**                    | Banco de dados utilizado para armazenar informações de Rate Limiting, como contadores de requisições por usuário.                                                                           |\n| **StatsD Exporter**          | Converte as métricas enviadas pelo Envoy Rate Limit para o formato compatível com Prometheus.                                                                                               |\n| **Prometheus**               | Coleta as métricas do StatsD Exporter a cada 5 segundos e as armazena para análise e monitoramento.                                                                                         |\n| **Grafana**                  | Visualiza as métricas coletadas pelo Prometheus e apresenta dashboards para acompanhamento do Rate Limiting.                                                                                |\n| **Target Application Cluster** | Conjunto de instâncias da aplicação de destino. Se a requisição estiver dentro do limite, o Envoy Proxy a encaminha para uma dessas instâncias.                                             |\n\n## Configurando e Inicializando a Solução\nSiga os passos abaixo para inicializar e configurar a solução de Rate Limit:\n\n### Passo 1: Subir os Contêineres com Docker Compose\nAcesse o diretório raiz da solução e execute o seguinte comando para construir e iniciar todos os contêineres:\n\n```bash\n$ docker-compose up --build\n```\n\n### Passo 2: Testar o Rate Limit\nExecute o seguinte comando para testar o Rate Limit:\n\n```bash\nchmod +x test_rate_limit.sh\n./test_rate_limit.sh\n```\n\nO script `test_rate_limit.sh` envia 20000 requisições para o Envoy. As primeiras 20 requisições a cada segundo são permitidas, enquanto o restante são bloqueadas com erro `HTTP 429 Too Many Requests`.\n\n![Architecture](documentation/script.png)\n\n### Passo 3: Criar o dashboard no Grafana\nAcesse o Grafana em `http://localhost:3000` e faça login com as credenciais padrão `admin:admin`. Em seguida, busque pelo dashboard `Rate Limit Dashboard` (sim, ele já está configurado). Aguarde alguns instantes e as métricas serão exibidas.\n\n![Architecture](documentation/dashboard.png)\n\n\n## Ajustando o Rate Limit\n\n### Rate Limit Global\nPara ajustar o Rate Limit, edite o arquivo `projects/config/ratelimite/config.yaml` e altere os valores de `unit` e `requests_per_unit`  conforme necessário. Por exemplo, para limitar a 500 requisições por minuto, utilize o seguinte trecho de código:\n\n```yaml\n  - key: path\n    value: /\n    rate_limit:\n      unit: second\n      requests_per_unit: 20\n```\n\n### Rate Limit por API Key\nPara limitar o Rate Limit por API Key, edite o arquivo `projects/config/ratelimite/config.yaml` e descomente o trecho de código abaixo.:\n\n```yaml\n  ...\n  - key: \"x-api-key\"\n    descriptors:\n      - key: path\n        value: /\n        rate_limit:\n          unit: minute\n          requests_per_unit: 400\n  ...\n```\nAgora, no arquivo `projects/config/envoy/proxy.yaml` descomente o trecho de código abaixo e depois reinicie o docker-compose:\n\n```yaml\n  ...\n  route:\n    cluster: application\n    rate_limits:\n      - actions:\n        - request_headers:\n            header_name: \"x-api-key\"\n            descriptor_key: \"x-api-key\"\n  ...\n```\n\n## FAQ\n### O que é Envoy?\nEnvoy é um proxy de borda de alto desempenho e código aberto, projetado para aplicações modernas de microsserviços. Ele foi projetado para ser distribuído, resiliente, inteligente e altamente configurável.\n\n### O que é Rate Limit?\nRate Limit é uma funcionalidade que permite limitar a quantidade de requisições que um serviço pode receber em um determinado período de tempo. O rate limit pode ser aplicado em diferentes níveis, como por exemplo, por serviço, por usuário, por IP, etc.\n\n### Por que usar Rate Limit?\nO Rate Limit é uma técnica importante para proteger serviços de abusos e ataques de negação de serviço (DDoS). Ele também pode ser utilizado para garantir a qualidade de serviço (QoS) e evitar que um único usuário ou serviço monopolize os recursos disponíveis.\n\n### Como o Rate Limit funciona?\nO Rate Limit funciona verificando se uma requisição excede o limite permitido. Se o limite for excedido, o Rate Limit retorna um erro `HTTP 429 Too Many Requests`. Caso contrário, a requisição é encaminhada para o serviço de destino.\n\n### Como o Rate Limit é implementado?\nO Rate Limit é implementado utilizando um proxy como Envoy. O Envoy intercepta as requisições antes de encaminhá-las para a aplicação. Ele verifica se a requisição excede os limites definidos e, se necessário, bloqueia a requisição.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwaelson%2Frate-limit-with-envoy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwaelson%2Frate-limit-with-envoy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwaelson%2Frate-limit-with-envoy/lists"}