Token Bucket

rodrigopizzi — Fri, 10 Mar 2023 17:02:53 +0000

O que é token bucket?

Token bucket é um algoritmo para controlar a quantidade de transmissões de modo que não ultrapasse uma determinada capacidade.

No contexto de aplicações esse algoritmo ajuda a limitar a carga que a aplicação vai receber, evitando qualquer tipo de abuso de requisições.

Como ele funciona?

A quantidade máxima de tokens que podemos usar é determina pelo seu bucket. Um bucket é como se fosse um balde cheio de fichas (tokens). Cada requisição pode consumir uma ou mais fichas, dependendo da regra de controle do fluxo. Todo bucket possui uma taxa de reposição de tokens, ou seja, a cada "x" tempo, ou quando algo acontece, o token é devolvido ao bucket permitindo assim novas requisições.

Para entender melhor vamos usar o Pix do banco central como exemplo. Veja a tabela a seguir como o bacen descreveu suas regras de token bucket:

A regra para criar uma chave pix possui limitações. O bucket tem tamanho de 36k de tokens. Isso significa que é possivel fazer uso de 36k de requests para criar chaves pix. Se algum dia acontecer uma rajada de requisições o máximo possivel será de 36k e a partir dai o bucket ficará vazio, forçando a aguardar até que a taxa de reposição aconteça. Neste caso a cada minuto serão repostos 1200 tokens. Esse limite é compartilhado nas funcionalidades de criar e deletar chaves.

Alem disso é possivel realizar combinações da taxa de reposição com regras de negocio de sua aplicação. Por exemplo o banco central consome mais de um token quando uma chave pix é lida e não é utilizada em seguida em algum pagamento. Isso evita abuso do consumo desse recurso pois se isso acontece o bucket fica vazio rapidamente e não é mais possivel utilizar esse recurso.

Da pra imanigar muitas formas diferentes de evitar sobrecarga e abuso da API que esta sendo protegida por este método.

Legal, como implemento isso na minha aplicação?

É possivel implementar o algoritmo token bucket do zero. Mas isso pode dar trabalho e desprender muito esforço. Uma boa opção é utilizar a biblioteca bucket4j.

O bucket4j possui a implementação do token bucket e pode ajudar muito nesse sentido.

Referências

C4 Model + C4-PlantUML

rodrigopizzi — Thu, 02 Mar 2023 16:59:40 +0000

C4 Model

O C4 Model é uma forma de desenhar e documentar a arquitetura de um software. Ele foi criado pelo Engenheiro Simon Brown. O nome C4 deriva do modelo 4+1 que significa fazer uso de multiplas visões concorrentes, onde cada uma esta sob uma perspectiva diferente. Neste sentido temos 4 níveis: Context, Containers, Component and Code.

Porque usar C4 Model?

Ajuda a documentação da arquitetura de um software de forma clara, padronizada e eficiente
Cada um dos níveis oferece visões diferentes e isso ajuda a publicos diferentes a entender o software.

C4-PlantUML

O C4-PlantUML é uma ferramenta que permite a criação de diagramas C4 Model usando uma linguagem de programação simples e intuitiva de código aberto e independente de plataforma. Segue um exemplo:



@startuml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml
' uncomment the following line and comment the first to use locally
' !include C4_Context.puml

LAYOUT_WITH_LEGEND()

title System Context diagram for Internet Banking System

Person(customer, "Personal Banking Customer", "A customer of the bank, with personal bank accounts.")
System(banking_system, "Internet Banking System", "Allows customers to view information about their bank accounts, and make payments.")

System_Ext(mail_system, "E-mail system", "The internal Microsoft Exchange e-mail system.")
System_Ext(mainframe, "Mainframe Banking System", "Stores all of the core banking information about customers, accounts, transactions, etc.")

Rel(customer, banking_system, "Uses")
Rel_Back(customer, mail_system, "Sends e-mails to")
Rel_Neighbor(banking_system, mail_system, "Sends e-mails", "SMTP")
Rel(banking_system, mainframe, "Uses")
@enduml

Por que usar o C4-PlantUml?

Os diagramas podem ser facilmente atualizados e mantidos por meio de seu código fonte, bem como versionados juntamente ao projeto
Os diagramas são gerados automaticamente a partir do código e isso força a padronização e consistencia, facilitando a comunicação entre todos os envolvidos do projeto

Na pratica

Uma recomendação de organização para seu projeto seria adicionar na raiz do projeto o arquivo C4Context.puml. Este arquivo terá o codigo fonte do diagrama de contexto.

Você pode utilizar um plugin para o IntelliJ para ajudar a criar os diagramas:

Feito isso é so salvar a imagem final do diagrama em uma pasta em seu projeto e usando o readme.md documentar seu projeto fazendo uso do diagrama criado.

Conclusão

O C4 Model pode ser bem util para criar um diagrama de arquitertura rico e eficiente que pode atender a diferentes publicos. Esse recurso combinado ao C4 PlantUML permite que os diagramas fiquem versionados junto ao código fonte do projeto, fazendo com que a documentação evolua da mesma maneira que o código fonte.

Referências

https://c4model.com/
https://github.com/plantuml-stdlib/C4-PlantUML

DEV Community: rodrigopizzi

Token Bucket

O que é token bucket?

Como ele funciona?

Legal, como implemento isso na minha aplicação?

Referências

C4 Model + C4-PlantUML

C4 Model

Porque usar C4 Model?

C4-PlantUML

Por que usar o C4-PlantUml?

Na pratica

Conclusão

Referências