sentry benchmark:

- docker-compose.harness.yml - add sentry release services
- sentry - bin - seed - the sentry
- primitives - test_util - add testing Campaigns
- sentry - Makefile - add tasks for running the benchmark
- sentry - benchmark - multiple_benchmark with 3 campaigns
- Docker-sentry - fixes and changes for release build
- sentry - README - document how to run benchmarks
- scripts - sentry-docker - entrypoint - fixes to hosts & default values

Author: elpiel

Dockerfile-sentry

@@ -10,18 +10,21 @@ WORKDIR /usr/src/app
 RUN mkdir -p primitives/src/ adapter/src/ sentry/src/
 
 COPY ./primitives/Cargo.toml ./primitives/Cargo.toml
+# we also need to copy the examples otherwise we will get error for them
+COPY ./primitives/examples ./primitives/examples
 RUN touch ./primitives/src/lib.rs && echo "pub fn main() {println!(\"cargo:rerun-if-changed=\\\"/tmp/build.rs\\\"\");}" >> ./primitives/src/lib.rs
 
 COPY ./adapter/Cargo.toml ./adapter/Cargo.toml
 RUN touch ./adapter/src/lib.rs && echo "pub fn main() {println!(\"cargo:rerun-if-changed=\\\"/tmp/build.rs\\\"\");}" >> ./adapter/src/lib.rs
 
 COPY ./sentry/Cargo.toml ./sentry/Cargo.toml
+COPY ./sentry/src/bin ./sentry/src/bin
 RUN touch ./sentry/src/main.rs && echo "fn main() {println!(\"cargo:rerun-if-changed=\\\"/tmp/build.rs\\\"\");}" >> ./sentry/src/main.rs
 
 COPY ./Cargo.lock ./Cargo.lock
 RUN touch Cargo.toml && echo "[workspace]\n members = [ 'primitives', 'adapter', 'sentry' ]" >> Cargo.toml
 
-RUN cargo build -p sentry --release
+RUN cargo build -p sentry --bin sentry --release
 
 # remove the not needed build artifacts
 RUN rm -f target/release/deps/sentry*
@@ -35,7 +38,7 @@ COPY . .
 # We install the sentry binary with all features in Release mode
 # Include the full backtrace for easier debugging
 
-RUN RUST_BACKTRACE=full cargo install --locked --path sentry --all-features
+RUN RUST_BACKTRACE=full cargo install --locked --path sentry --bin sentry --all-features
 
 WORKDIR /usr/local/bin
 
@@ -79,13 +82,11 @@ COPY docs/config/cloudflare_origin.crt /usr/local/share/ca-certificates/
 
 RUN update-ca-certificates
 
-RUN mkdir scripts
-
-COPY ./scripts/sentry-docker ./scripts
+COPY ./scripts/sentry-docker ./scripts/sentry-docker
 
 COPY --from=builder /usr/local/bin/sentry .
 
-ENTRYPOINT ["./scripts/entrypoint.sh"]
+ENTRYPOINT ["./scripts/sentry-docker/entrypoint.sh"]
 
 CMD sentry -a ${ADAPTER:-ethereum} \
             ${KEYSTORE_FILE:+-k $KEYSTORE_FILE} \

docker-compose.harness.yml

@@ -58,5 +58,28 @@ services:
     networks:
       - adex-external
 
+  # Service used to bechmark the sentry application in release mode
+  # It uses the dummy adapter and the Leader
+  sentry-dummy-leader-release:
+    restart: unless-stopped
+    build:
+      context: .
+      dockerfile: Dockerfile-sentry
+    container_name: adex-sentry-dummy-leader-release
+    ports:
+      - "8005:8005"
+    environment:
+      ENV: development
+      IP_ADDR: 0.0.0.0
+      PORT: 8005
+      POSTGRES_DB: sentry_leader
+      POSTGRES_HOST: adex-postgres
+      REDIS_HOST: adex-redis
+      ADAPTER: dummy
+      DUMMY_IDENTITY: '0x80690751969B234697e9059e04ed72195c3507fa'
+      REDIS_URL: redis://adex-redis:6379/0
+    networks:
+      - adex-external
+
 networks:
   adex-external:

scripts/sentry-docker/entrypoint.sh

@@ -4,15 +4,15 @@ set -o errexit
 set -o pipefail
 
 >&2 echo "Waiting for redis..."
-REDIS_HOST=${REDIS_HOST:-redis}
+REDIS_HOST=${REDIS_HOST:-localhost}
 REDIS_PORT=${REDIS_PORT:-6379}
-./scripts/wait-for-it.sh -h ${REDIS_HOST} -p ${REDIS_PORT} -t 10
+./scripts/sentry-docker/wait-for-it.sh -h ${REDIS_HOST} -p ${REDIS_PORT} -t 10
 >&2 echo "Redis is up - continuing..."
 
 >&2 echo "Waiting for postgres..."
-POSTGRES_HOST=${POSTGRES_HOST:-postgres}
+POSTGRES_HOST=${POSTGRES_HOST:-localhost}
 POSTGRES_PORT=${POSTGRES_PORT:-5432}
-./scripts/wait-for-it.sh -h ${POSTGRES_HOST} -p ${POSTGRES_PORT} -t 10
+./scripts/sentry-docker/wait-for-it.sh -h ${POSTGRES_HOST} -p ${POSTGRES_PORT} -t 10
 >&2 echo "Postgres is up - continuing..."
 
 exec "$@"

sentry/Cargo.toml

@@ -9,6 +9,16 @@ authors = [
 ]
 edition = "2021"
 
+default-run = "sentry"
+
+[[bin]]
+name = "seed"
+test = false # Is tested by default.
+doctest = false # Documentation examples are tested by default.
+bench = false # Is benchmarked by default.
+doc = false # Is documented by default.
+required-features = ["test-util"]
+
 [features]
 
 test-util = ["primitives/test-util", "adapter/test-util", "dashmap"]
@@ -18,8 +28,8 @@ test-util = ["primitives/test-util", "adapter/test-util", "dashmap"]
 futures = "0.3"
 async-trait = "0.1"
 # Primitives
-primitives = { path = "../primitives", features = ["postgres", "test-util"] }
-adapter = { version = "0.2", path = "../adapter", features = ["test-util"] }
+primitives = { path = "../primitives", features = ["postgres"] }
+adapter = { version = "0.2", path = "../adapter" }
 chrono = { version = "0.4", features = ["serde"] }
 # used for redis test pool
 dashmap = { version = "5", optional = true }
@@ -65,6 +75,9 @@ reqwest = { version = "0.11", features = ["json", "cookies"] }
 [dev-dependencies]
 pretty_assertions = "1"
 
+primitives = { path = "../primitives", features = ["postgres", "test-util"] }
+adapter = { version = "0.2", path = "../adapter", features = ["test-util"] }
+
 [package.metadata.docs.rs]
 all-features = true
 rustdoc-args = ["--cfg", "docsrs"]

sentry/Makefile.toml

@@ -23,3 +23,43 @@ script = "docker-compose -f ../docker-compose.harness.yml up -d adex-redis adex-
 
 [tasks.services-down]
 script = "docker-compose -f ../docker-compose.harness.yml down"
+
+[tasks.run-benchmark]
+category = "Development"
+
+dependencies = [
+  "benchmark-services-up",
+  "run-seed",
+  "run-wrk2",
+  "benchmark-services-down",
+]
+
+[tasks.run-seed]
+category = "Development"
+
+command = "cargo"
+
+args = ["run", "--bin", "seed", "--features=test-util"]
+
+[tasks.run-wrk2]
+category = "Development"
+
+command = "wrk2"
+
+args = [
+  "-s",
+  "./benchmark/multiple_benchmark.lua",
+  "-t3",
+  "-c100",
+  "-d30s",
+  "-R2000",
+  "--latency",
+  "http://127.0.0.1:8005/v5/campaign",
+]
+
+[tasks.benchmark-services-up]
+# `--renew-anon-volumes` is required to make sure that the Databases are dumpped.
+script = "docker-compose -f ../docker-compose.harness.yml up --renew-anon-volumes -d adex-redis adex-postgres sentry-dummy-leader-release && sleep 3"
+
+[tasks.benchmark-services-down]
+script = "docker-compose -f ../docker-compose.harness.yml down"

sentry/README.md

@@ -24,4 +24,13 @@ to create them for you.
 2) And setup the `Migrant.toml` file, a reference to which you can find
 in [Migrant.dist.toml](Migrant.dist.toml).
 
-For more options see the [migrant homepage](https://github.com/jaemk/migrant)
+For more options see the [migrant homepage](https://github.com/jaemk/migrant)
+
+#### Benchmarks
+
+Starts the `Sentry` application along side `redis` and `postgres` databases,
+and runs `wrk2` on the POST `/v5/campaign/0xXXXX../events` route for 3 campaigns:
+
+```bash
+cargo make run-benchmark
+```

sentry/benchmark/benchmark.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 # Run the benchmark using 
-# t3 - one thread
+# t3 - three threads
 # c100 - one hundred concurrent connections
 # d30s - 30 seconds
 # R2000 - 2000 requests per second (total, across all connections combined)

sentry/benchmark/multiple_benchmark.lua

@@ -0,0 +1,26 @@
+-- This script will submit events for 3 campaigns
+-- The 3 campaigns can be found in `primitives::test_util`
+wrk.method = "POST"
+-- uses the PUBLISHER address
+wrk.body   = "{ \"events\": [ {\"type\": \"IMPRESSION\", \"publisher\": \"0xE882ebF439207a70dDcCb39E13CA8506c9F45fD9\", \"adUnit\": \"Qmasg8FrbuSQpjFu3kRnZF9beg8rEBFrqgi1uXDRwCbX5f\", \"adSlot\": \"QmcUVX7fvoLMM93uN2bD3wGTH8MXSxeL8hojYfL2Lhp7mR\"} ] }"
+wrk.headers["Content-Type"] = "application/json"
+-- uses the DUMMY_AUTH[CREATOR] token
+-- wrk.headers["authorization"] = "Bearer AUTH_awesomeCreator:chain_id:1337"
+
+
+init = function(args)
+    local r = {}
+
+    -- Campaign 1
+    r[1] = wrk.format(nil, "/v5/campaign/0x936da01f9abd4d9d80c702af85c822a8/events") 
+    -- Campaign 2
+    r[2] = wrk.format(nil, "/v5/campaign/0x127b98248f4e4b73af409d10f62daeaa/events") 
+    -- Campaign 3
+    r[3] = wrk.format(nil, "/v5/campaign/0xa78f3492481b41a688488a7aa1ff17df/events") 
+
+    req = table.concat(r)
+end
+
+request = function()
+    return req
+ end

sentry/src/bin/seed.rs

@@ -0,0 +1,122 @@
+use adapter::{client::Unlocked, dummy::Options, Adapter, Dummy, UnlockedState};
+use primitives::{
+    config::GANACHE_CONFIG,
+    sentry::SuccessResponse,
+    test_util::{ADVERTISER, ADVERTISER_2, CAMPAIGNS, DUMMY_AUTH, IDS, LEADER},
+    unified_num::FromWhole,
+    util::ApiUrl,
+    Campaign, ChainOf, Channel, Deposit, UnifiedNum, ValidatorId,
+};
+use reqwest::Client;
+use sentry::routes::channel::ChannelDummyDeposit;
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let advertiser_adapter = Adapter::with_unlocked(Dummy::init(Options {
+        dummy_identity: IDS[&ADVERTISER],
+        dummy_auth_tokens: DUMMY_AUTH.clone(),
+        dummy_chains: GANACHE_CONFIG.chains.values().cloned().collect(),
+    }));
+
+    let advertiser2_adapter = Adapter::with_unlocked(Dummy::init(Options {
+        dummy_identity: IDS[&ADVERTISER_2],
+        dummy_auth_tokens: DUMMY_AUTH.clone(),
+        dummy_chains: GANACHE_CONFIG.chains.values().cloned().collect(),
+    }));
+
+    let client = reqwest::Client::new();
+    // add deposit for campaigns
+    let intended_for = (
+        "http://127.0.0.1:8005".parse::<ApiUrl>().unwrap(),
+        IDS[&LEADER],
+    );
+
+    // create campaign
+    // Chain 1337
+    let campaign_1 = CAMPAIGNS[0].clone();
+    // Chain 1337
+    let campaign_2 = CAMPAIGNS[1].clone();
+    // Chain 1
+    let campaign_3 = CAMPAIGNS[2].clone();
+    // chain 1337
+    dummy_deposit(
+        &client,
+        &advertiser_adapter,
+        &campaign_1.of_channel(),
+        &intended_for,
+    )
+    .await?;
+    // chain 1337
+    dummy_deposit(
+        &client,
+        &advertiser_adapter,
+        &campaign_2.of_channel(),
+        &intended_for,
+    )
+    .await?;
+    // chain 1
+    dummy_deposit(
+        &client,
+        &advertiser2_adapter,
+        &campaign_3.of_channel(),
+        &intended_for,
+    )
+    .await?;
+
+    create_campaign(&client, &advertiser_adapter, &campaign_1, &intended_for).await?;
+    create_campaign(&client, &advertiser_adapter, &campaign_2, &intended_for).await?;
+    create_campaign(&client, &advertiser2_adapter, &campaign_3, &intended_for).await?;
+
+    Ok(())
+}
+
+async fn create_campaign(
+    client: &Client,
+    adapter: &Adapter<Dummy, UnlockedState>,
+    campaign: &ChainOf<Campaign>,
+    (sentry_url, intended_for): &(ApiUrl, ValidatorId),
+) -> Result<(), Box<dyn std::error::Error>> {
+    let auth_token = adapter.get_auth(campaign.chain.chain_id, *intended_for)?;
+
+    let _result = client
+        .post(sentry_url.join("/v5/campaign")?)
+        .bearer_auth(auth_token)
+        .json(&campaign.context)
+        .send()
+        .await?
+        .error_for_status()?
+        .json::<Campaign>()
+        .await?;
+
+    Ok(())
+}
+
+async fn dummy_deposit(
+    client: &Client,
+    adapter: &Adapter<Dummy, UnlockedState>,
+    channel: &ChainOf<Channel>,
+    (sentry_url, for_validator): &(ApiUrl, ValidatorId),
+) -> Result<(), Box<dyn std::error::Error>> {
+    let auth_token = adapter.get_auth(channel.chain.chain_id, *for_validator)?;
+
+    let request = ChannelDummyDeposit {
+        channel: channel.context,
+        deposit: Deposit {
+            total: UnifiedNum::from_whole(1_000_000),
+        },
+    };
+
+    let result = client
+        .post(sentry_url.join("/v5/channel/dummy-deposit")?)
+        .bearer_auth(auth_token)
+        .json(&request)
+        .send()
+        .await?
+        .error_for_status()?
+        .json::<SuccessResponse>()
+        .await?;
+
+    assert!(result.success);
+
+    Ok(())
+}

sentry/src/db/accounting.rs

@@ -5,7 +5,7 @@ use primitives::{
 };
 use tokio_postgres::{
     types::{FromSql, ToSql},
-    IsolationLevel, Row,
+    Row,
 };
 
 use super::{DbPool, PoolError};