Skip to content

Commit

Permalink
docs: fix metrics page admonitions and other tidying (#13632)
Browse files Browse the repository at this point in the history
Signed-off-by: Alan Clucas <[email protected]>
  • Loading branch information
Joibel authored Sep 20, 2024
1 parent a7205b2 commit ce7f9bf
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
8 changes: 5 additions & 3 deletions docs/metrics.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Prometheus Metrics
# Metrics

> v2.7 and after
!!! Metrics changes in 3.6
!!! Warning "Metrics changes in 3.6"
Please read [this short guide](upgrading.md#metrics-changes) on what you must consider when upgrading to 3.6.

## Introduction
Expand Down Expand Up @@ -197,10 +197,12 @@ Metrics for the [Four Golden Signals](https://sre.google/sre-book/monitoring-dis
- Errors: `count` and `error_count`
- Saturation: `workers_busy` and `workflow_condition`

!!! High cardinality
!!! Warning "High cardinality"
Some metric attributes may have high cardinality and are marked with ⚠️ to warn you. You may need to disable this metric or disable the attribute.

<!-- titles should be the exact metric name for deep-linking, alphabetical ordered -->
<!-- titles are without argo_workflows prefix -->

#### `cronworkflows_concurrencypolicy_triggered`

A counter of the number of times a CronWorkflow has triggered its `concurrencyPolicy` to limit the number of workflows running.
Expand Down
4 changes: 2 additions & 2 deletions docs/workflow-creator.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ metadata:
name: my-wf
labels:
workflows.argoproj.io/creator: admin
# labels must be DNS formatted, so the "@" is replaces by '.at.'
# labels must be DNS formatted, so the "@" is replaces by '.at.'
workflows.argoproj.io/creator-email: admin.at.your.org
workflows.argoproj.io/creator-preferred-username: admin-preferred-username
```
!!! NOTE
!!! Note
Labels only contain `[-_.0-9a-zA-Z]`, so any other characters will be turned into `-`.

0 comments on commit ce7f9bf

Please sign in to comment.