Add metrics module

Author: JulienLavocat

Cargo.lock

@@ -52,6 +52,7 @@ members = [
   "modules/sdk-test-view-pk",
   "modules/sdk-test-event-table",
   "modules/tpcc",
+  "modules/tpcc-metrics",
   "sdks/rust/tests/test-client",
   "sdks/rust/tests/test-counter",
   "sdks/rust/tests/connect_disconnect_client",

Cargo.toml

@@ -0,0 +1,19 @@
+[package]
+name = "tpcc-metrics"
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+anyhow.workspace = true
+log.workspace = true
+spacetimedb = { workspace = true, features = ["unstable"] }
+spacetimedb-sats = { workspace = true, features = ["serde"] }
+http.workspace = true
+serde_json.workspace = true
+
+[lints]
+workspace = true

modules/tpcc-metrics/Cargo.toml

@@ -0,0 +1,54 @@
+use spacetimedb::{reducer, table, ReducerContext, Table};
+
+#[table(accessor = state, public)]
+pub struct State {
+    #[primary_key]
+    pub id: i64,
+
+    pub run_start_ms: u64,
+    pub run_end_ms: u64,
+    pub measure_start_ms: u64,
+    pub measure_end_ms: u64,
+
+    pub order_count: u64,
+    pub measurement_time_ms: u64,
+}
+
+#[reducer]
+pub fn reset(ctx: &ReducerContext, warmup_duration_ms: u64, measure_start_ms: u64, measure_end_ms: u64) {
+    for row in ctx.db.state().iter() {
+        ctx.db.state().delete(row);
+    }
+
+    ctx.db.state().insert(State {
+        id: 0,
+        order_count: 0,
+        measurement_time_ms: 0,
+        run_start_ms: measure_start_ms - warmup_duration_ms,
+        run_end_ms: measure_end_ms + warmup_duration_ms,
+        measure_start_ms,
+        measure_end_ms,
+    });
+}
+
+#[reducer]
+pub fn clear_state(ctx: &ReducerContext) {
+    for row in ctx.db.state().iter() {
+        ctx.db.state().delete(row);
+    }
+}
+
+#[reducer]
+pub fn register_completed_order(ctx: &ReducerContext) {
+    // We intentionally do not check if the current time is within the measurement window,
+    // this is the driver's reponsibility
+
+    let current_time_ms = ctx.timestamp.to_duration_since_unix_epoch().unwrap().as_millis() as u64;
+
+    let mut state = ctx.db.state().id().find(0).unwrap();
+
+    state.order_count += 1;
+    state.measurement_time_ms = current_time_ms;
+
+    ctx.db.state().id().update(state);
+}

modules/tpcc-metrics/src/lib.rs

@@ -0,0 +1,23 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[src/**.ts]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+max_line_length = 120
+
+[src/**.tsx]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+max_line_length = 120
+
+[*.json]
+indent_style = space
+indent_size = 2

tools/tpcc-dashboard/.editorconfig

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

tools/tpcc-dashboard/.gitignore

@@ -0,0 +1,73 @@
+# React + TypeScript + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Oxc](https://oxc.rs)
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/)
+
+## React Compiler
+
+The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+
+```js
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      // Other configs...
+
+      // Remove tseslint.configs.recommended and replace with this
+      tseslint.configs.recommendedTypeChecked,
+      // Alternatively, use this for stricter rules
+      tseslint.configs.strictTypeChecked,
+      // Optionally, add this for stylistic rules
+      tseslint.configs.stylisticTypeChecked,
+
+      // Other configs...
+    ],
+    languageOptions: {
+      parserOptions: {
+        project: ['./tsconfig.node.json', './tsconfig.app.json'],
+        tsconfigRootDir: import.meta.dirname,
+      },
+      // other options...
+    },
+  },
+])
+```
+
+You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+
+```js
+// eslint.config.js
+import reactX from 'eslint-plugin-react-x'
+import reactDom from 'eslint-plugin-react-dom'
+
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      // Other configs...
+      // Enable lint rules for React
+      reactX.configs['recommended-typescript'],
+      // Enable lint rules for React DOM
+      reactDom.configs.recommended,
+    ],
+    languageOptions: {
+      parserOptions: {
+        project: ['./tsconfig.node.json', './tsconfig.app.json'],
+        tsconfigRootDir: import.meta.dirname,
+      },
+      // other options...
+    },
+  },
+])
+```

tools/tpcc-dashboard/README.md

@@ -0,0 +1,29 @@
+[connection]
+uri = "http://127.0.0.1:3000"
+database = "tpcc"
+confirmed_reads = true
+timeout_secs = 30
+
+[load]
+warehouses = 1
+batch_size = 500
+reset = true
+
+[driver]
+driver_id = "driver-a"
+terminal_start = 1
+terminals = 10
+warehouses = 1
+warmup_secs = 5
+measure_secs = 30
+delivery_wait_secs = 60
+keying_time_scale = 1.0
+think_time_scale = 1.0
+
+[coordinator]
+run_id = "tpcc-demo"
+listen = "127.0.0.1:7878"
+expected_drivers = 2
+warmup_secs = 5
+measure_secs = 30
+output_dir = "tpcc-results/coordinator"

tools/tpcc-dashboard/config.toml

@@ -0,0 +1,23 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import reactHooks from 'eslint-plugin-react-hooks'
+import reactRefresh from 'eslint-plugin-react-refresh'
+import tseslint from 'typescript-eslint'
+import { defineConfig, globalIgnores } from 'eslint/config'
+
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      js.configs.recommended,
+      tseslint.configs.recommended,
+      reactHooks.configs.flat.recommended,
+      reactRefresh.configs.vite,
+    ],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+    },
+  },
+])

tools/tpcc-dashboard/eslint.config.js

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>tpcc-dashboard</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>