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.

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

Add prometheus metrics lists to docs #4533

Merged
merged 3 commits into from
Jul 31, 2023

Conversation

kentakozuka
Copy link
Member

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #4516

Does this PR introduce a user-facing change?:

  • How are users affected by this change:
  • Is this breaking change:
  • How to migrate (if breaking change):

@codecov
Copy link

codecov bot commented Jul 28, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.02% ⚠️

Comparison is base (ec01b39) 30.00% compared to head (2d9ef7d) 29.98%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4533      +/-   ##
==========================================
- Coverage   30.00%   29.98%   -0.02%     
==========================================
  Files         220      220              
  Lines       25808    25808              
==========================================
- Hits         7743     7739       -4     
- Misses      17418    17422       +4     
  Partials      647      647              

see 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


| Metric | Type | Description |
| --- | --- | --- |
| `deployment_status` | gauge | The current status of deployment. 1 for current status, 0 for others. |
Copy link
Member

Choose a reason for hiding this comment

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

How about other metrics of piped. We serve other as well
https://github.com/pipe-cd/pipecd/blob/master/pkg/app/piped/cmd/piped/piped.go#L815-L821

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks! I missed them.


| Metric | Type | Description |
| --- | --- | --- |
| `insight_application_total` | gauge | Number of applications currently controlled by control plane. |
Copy link
Member

Choose a reason for hiding this comment

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

Same as above, we have others metrics of controlplane as well
https://github.com/pipe-cd/pipecd/blob/master/cmd/pipecd/server.go#L512-L518

@kentakozuka
Copy link
Member Author

@khanhtc1202 Other metrics added 👍
Just thought that this doc is now located under "Managing Control Plane".
How about moving it to under "User Guide" because this doc now explains not only control planes but also piped?

@khanhtc1202
Copy link
Member

How about moving it to under "User Guide" because this doc now explains not only control planes but also piped?

That would be great 👍

Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com>
Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com>
Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com>
@kentakozuka
Copy link
Member Author

@khanhtc1202 Fixed 👍

Copy link
Member

@khanhtc1202 khanhtc1202 left a comment

Choose a reason for hiding this comment

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

lgtm ❤️

@kentakozuka kentakozuka merged commit 315748e into pipe-cd:master Jul 31, 2023
12 of 13 checks passed
@kentakozuka kentakozuka deleted the docs-metrics branch July 31, 2023 13:56
@github-actions github-actions bot mentioned this pull request Aug 23, 2023
sZma5a pushed a commit to sZma5a/pipecd that referenced this pull request Aug 27, 2023
* Add prometheus metrics lists to docs

Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com>

* Add missing metrics

Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com>

* Move metric docs to under user guide

Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com>

---------

Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com>
Signed-off-by: sZma5a <masaaki.haribote@gmail.com>
moko-poi pushed a commit to moko-poi/pipecd that referenced this pull request Nov 3, 2023
* Add prometheus metrics lists to docs

Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com>

* Add missing metrics

Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com>

* Move metric docs to under user guide

Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com>

---------

Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com>
Signed-off-by: moko-poi <mokopoi44@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs for metrics list
2 participants