diff options
Diffstat (limited to 'integrations/templates/metrics.md')
-rw-r--r-- | integrations/templates/metrics.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/integrations/templates/metrics.md b/integrations/templates/metrics.md new file mode 100644 index 00000000..95fa7504 --- /dev/null +++ b/integrations/templates/metrics.md @@ -0,0 +1,49 @@ +[% if entry.metrics.scopes %] +## Metrics + +[% if entry.metrics.folding.enabled %] +{% details summary="[[ entry.metrics.folding.title ]]" %} +[% endif %] +Metrics grouped by *scope*. + +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. + +[[ entry.metrics.description ]] + +[% for scope in entry.metrics.scopes %] +### Per [[ scope.name ]] + +[[ scope.description ]] + +[% if scope.labels %] +Labels: + +| Label | Description | +|:-----------|:----------------| +[% for label in scope.labels %] +| [[ label.name ]] | [[ label.description ]] | +[% endfor %] +[% else %] +This scope has no labels. +[% endif %] + +Metrics: + +| Metric | Dimensions | Unit |[% for a in entry.metrics.availability %] [[ a ]] |[% endfor %] + +|:------|:----------|:----|[% for a in entry.metrics.availability %]:---:|[% endfor %] + +[% for metric in scope.metrics %] +| [[ metric.name ]] | [% for d in metric.dimensions %][[ d.name ]][% if not loop.last %], [% endif %][% endfor %] | [[ metric.unit ]] |[% for a in entry.metrics.availability %] [% if not metric.availability|length or a in metric.availability %]•[% else %] [% endif %] |[% endfor %] + +[% endfor %] + +[% endfor %] +[% if entry.metrics.folding.enabled %] +{% /details %} +[% endif %] +[% else %] +## Metrics + +[[ entry.metrics.description ]] +[% endif %] |