Skip to content

Commit

Permalink
Add metric fields to metric_hub.md (#840)
Browse files Browse the repository at this point in the history
Added 'level' metric field to the metadata file and edited some comments.
  • Loading branch information
Jeffrey Silverman authored Aug 21, 2024
1 parent 9d0c79d commit 125ed3a
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions src/concepts/metric_hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,14 +144,17 @@ friendly_name = "Memory Pressure Count"
# A description that will be displayed by dashboards.
description = "Number of memory pressure events"

# This can be any string value. It's currently not being used but in the future, this could be used to visually group different metrics by category.
# An optional category that can be any string value. It's currently not being used but in the future, this could be used to visually group different metrics by category.
category = "performance"

# And optional owner or team owning this metric
# An optional owner or team owning this metric. Can be a string or list of strings.
owner = "example@mozilla.org"

# Whether the metric is deprecated and should no longer be used
# Whether the metric is deprecated and should no longer be used (optional).
deprecated = false

# An optionl string ('gold', 'silver', or 'bronze') that is the metric's current level according to the Metric Levels Taxonomy (https://mozilla-hub.atlassian.net/wiki/spaces/DATA/pages/610894135/Metrics#Metric-Levels-Taxonomy).
level = "gold"
```

Since metrics aggregate data, the metric SQL definition must contain some aggregation method (like `SUM`, `COUNT`, ...) to be valid.
Expand Down

0 comments on commit 125ed3a

Please sign in to comment.