Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Add controller-level metrics #3464

Merged
merged 2 commits into from
Jul 14, 2020
Merged

docs: Add controller-level metrics #3464

merged 2 commits into from
Jul 14, 2020

Conversation

simster7
Copy link
Member

Closes #3057

@alexec alexec self-assigned this Jul 13, 2020
alexec
alexec approved these changes Jul 14, 2020
View reviewed changes
docs/metrics.md Outdated
@@ -18,7 +21,11 @@ best way to define metrics in Argo to avoid problems such as [cardinality explos

## Metrics and metrics in Argo

Emitting metrics is the responsibility of the emitter owner. Since the user defines Workflows in Argo, the user is responsible
There are two kinds of metrics emitted by Argo: controller metrics and custom metrics. Controller metrics are metrics that inform
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe bold terms?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or use bullet points

docs/metrics.md

There are several controller-level metrics. These include:

* `workflows_processed_count`: a count of all Workflow updates processed by the controller
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't capitalize "Workflow" - it's should really be lowercase, same for workflow templates and cron workflows. It makes it harder to read.

@simster7 simster7 merged commit 58097a9 into argoproj:master Jul 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alexec alexec alexec approved these changes

Assignees

@alexec alexec

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document new controller-level metrics
2 participants
@simster7 @alexec