Skip to content
This repository has been archived by the owner on May 2, 2024. It is now read-only.

Create relay-meter-service.md #9

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create relay-meter-service.md #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions relay-meter-service.md
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One think to take into account is that the tx db service does not hold specific info regarding rate limiting, it holds data of all relays which then is aggregated to data warehouse in multiple ways, one of them being available for rate limiting. What I mean is that tx db service does not have special data structures specific for rate limiting, so all the code for this will be made in a way that this is only presented as a reporting service, which then can be consumed by services like rate limiter

Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
TxDB as replacement for relay-meter

```mermaid
flowchart

%% TxDB Service
%% -------------------------------------
subgraph txdbs [TxDB Service]
receiver(Relay Metrics Receiver)
pgA[(Central Postgres DB)]
aggA(Metrics Aggregator)
persistenceA[(Aggregated Metrics Persistence)]
meterA(Relay Metrics Reporter/relay-meter replacement)

receiver-->pgA
receiver-->aggA
aggA-->persistenceA
aggA-->meterA

end

%% Portal Region 1
%% -------------------------------------
subgraph pi1 [Portal Region 1]
relayer1(Relayer)
lim1(Rate-Limit Enforcement Plugin)
metrics1(Metrics Recorder)
pubsub1(Regional Portal Pubsub Service/NATS)
tx1(TxDB Pubsub Service: Reports Relay Metrics to TxDB)

metrics1-->pubsub1
pubsub1-->tx1
relayer1-->metrics1
lim1-->relayer1
end

%% Portal Region 2
%% -------------------------------------
subgraph pi2 [Portal Region 2]
relayer2(Relayer)
lim2(Rate-Limit Enforcement Plugin)
metrics2(Metrics Recorder)
pubsub2(Regional Portal Pubsub Service/NATS)
tx2(TxDB Pubsub Service: Reports Relay Metrics to TxDB)

relayer2-->metrics2
metrics2-->pubsub2
pubsub2-->tx2
lim2-->relayer2
end

subgraph rateLimiter [Rate-Limiter]
rateLimiterCollector(Relay Metrics Collector)
rateLimitsPublisher(Rate-Limit List Publisher)

rateLimiterCollector-->rateLimitsPublisher
end


%% Connections between subgraphs
%% -------------------------------------
tx1-->receiver
meterA-->rateLimiterCollector
rateLimitsPublisher-->lim1

tx2-->receiver
rateLimitsPublisher-->lim2
```