Skip to content

Commit

Permalink
Document metrics in the data model
Browse files Browse the repository at this point in the history
  • Loading branch information
nineinchnick committed Sep 16, 2022
1 parent c3dc4cf commit 3a96397
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/data-model/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,13 @@ erDiagram
}
MEASUREMENT ||--|| BENCHMARK-RUN-MEASUREMENT : "has one"
MEASUREMENT ||--|| EXECUTION-MEASUREMENT : "has one"
MEASUREMENT ||--|| METRIC : "has one"
MEASUREMENT {
varchar name
varchar unit
double value
bigint id PK
bigint metric_id FK
}
BENCHMARK-RUN-MEASUREMENT {
bigint benchmark_run_id PK
Expand All @@ -97,6 +99,17 @@ erDiagram
bigint execution_id PK
bigint measurement_id PK
}
METRIC ||--|{ METRIC-ATTRIBUTE : "has many"
METRIC {
varchar name
varchar unit
bigint id PK
}
METRIC-ATTRIBUTE {
varchar name
varchar value
bigint metric_id FK
}
```

## Environment
Expand Down Expand Up @@ -145,3 +158,9 @@ A measurement represents the value for a specific metric. Measurements recorded
can include the query duration or other statistics related to this execution.
Measurements recorded for the whole benchmark run can include the SUT statistics or the host resource usage (CPU, memory, network, etc.).

## Metric

A metric represents a measurable property. Every metric should have a `scope` attribute, where the values can be:
* `driver` for metrics measured by the driver, like `duration` and `throughput`
* `prestoQuery` for metrics related to the executed query, extracted from the server
* `cluster` for metrics related to the whole benchmark run, extracted from an agent monitoring the cluster

0 comments on commit 3a96397

Please sign in to comment.