diff --git a/README.md b/README.md index e08e647..b314c9a 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ sources: Metric definitions are `yml` and use `sql` in a number of supported dialects to aggregate, enrich, and materialize metric values. -Metric materialization expects two fields in the query resultset: a `struct` field of `tags` and a `value` column corresponding to the metric value. +Metric materialization expects a single field in the resultset that correponds to the **metric value**. This field can be titled `value`, `val`, or simply `v`. All other fields are considered **metric labels**. #### Prometheus Metric Types diff --git a/todo/todo.md b/todo/todo.md deleted file mode 100644 index bedbd2f..0000000 --- a/todo/todo.md +++ /dev/null @@ -1,49 +0,0 @@ - -# To-Do, Features - -## Tests dude - - Write them ❌ - -## Code stuff - - Interface/genericize metrics ❌ - -## Database stuff - - Support duckdb-based secrets registration ❌ - - Namespace all packages using a database so they don't collide ❌ - -## Sources - - Refresh on each `select` ❌ - - Refresh on http-post (POST collector:9100/sources/$BLAH/refresh) ❌ - -## Metrics - - Genericize/interface metrics ❌ - - Metric definition packages - - Support named path groupings ❌ - - Support package - - Support push-based OTEL ❌ - -## Secrets - - Support passing env-based secrets ❌ - -## Operator Niceties - - Meta metrics - - Source refresh timing ❌ - - Metric materialization timing ❌ - - Metric endpoint response time ❌ - -## Developer niceties - - jsonschema-based config (validation, auto-complete) ❌ - - config validation (run through a local duckdb) ❌ - -## Distribution stuff - - Build docker and publish to ghcr.io ❌ - - Build binaries and publish to package registry ❌ - - Tests and badge ❌ - - Lint and badge ❌ - - Codespaces ❌ - -## Package distribution stuff - - Turn dashes to underscores in package names so the metrics get properly registered ❌ - -## Outstanding questions - -