Skip to content

Commit

Permalink
fix: Metrics documentation (#4829)
Browse files Browse the repository at this point in the history
Signed-off-by: saranyaeu2987 <[email protected]>
  • Loading branch information
saranyaeu2987 committed Jan 5, 2021
1 parent 5f8a83a commit 2243d34
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,13 @@ best way to define metrics in Argo to avoid problems such as [cardinality explos

There are two kinds of metrics emitted by Argo: **controller metrics** and **custom metrics**.

* Controller metrics are metrics that inform on the state of the controller; i.e., they answer the question "What is the state of the controller right now?".
* Custom metrics are metrics that inform on the state of a Workflow, or a series of Workflows. These custom metrics are defined by the user in the Workflow spec.
#### Controller metrics
Metrics that inform on the state of the controller; i.e., they answer the question "What is the state of the controller right now?"
Default controller metrics can be scraped from service ```workflow-controller-metrics``` at the endpoint ```<host>:9090/metrics```


#### Custom metrics
Metrics that inform on the state of a Workflow, or a series of Workflows. These custom metrics are defined by the user in the Workflow spec.

Emitting custom metrics is the responsibility of the emitter owner. Since the user defines Workflows in Argo, the user is responsible
for emitting metrics correctly.
Expand Down

0 comments on commit 2243d34

Please sign in to comment.