Add Crossplane Metrics Documentation #802

Shwethamuralikrishnaa · 2024-08-23T12:49:01Z

This PR introduces a new documentation page dedicated to the metrics collected from Crossplane. The page is designed to help users understand the metric and how it can be used to monitor and troubleshoot Crossplane operations

netlify · 2024-08-23T12:49:18Z

✅ Deploy Preview for crossplane ready!

Name	Link
🔨 Latest commit	`9c4d1fd`
🔍 Latest deploy log	https://app.netlify.com/sites/crossplane/deploys/66e06d850610c100081b6c44
😎 Deploy Preview	https://deploy-preview-802--crossplane.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 83 (🔴 down 1 from production) Accessibility: 90 (🔴 down 2 from production) Best Practices: 83 (no change from production) SEO: 93 (no change from production) PWA: 70 (no change from production) View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

pierluigilenoci · 2024-08-28T12:18:57Z

@turkenh @plumbis, could you please take a look?

pierluigilenoci · 2024-08-30T08:19:13Z

@jbw976, could you please take a look?

AdamRussak · 2024-09-06T08:49:14Z

from first look i found a syntax error in your MD: the table formating header i think.

Signed-off-by: shwethamuralikrishnaa [email protected] Signed-off-by: shwethamuralikrishnaa <[email protected]> Signed-off-by: Pierluigi Lenoci <[email protected]>

Signed-off-by: Pierluigi Lenoci <[email protected]>

pierluigilenoci · 2024-09-06T14:28:42Z

@AdamRussak, those headers are the same across all pages.
For example,

docs/content/master/concepts/managed-resources.md

Line 667 in 1b48f47

We never touched this document.

jeanduplessis

@Shwethamuralikrishnaa @pierluigilenoci Thanks for this valuable contribution. Could we please add (duplicate) the metrics page under the /content/v1.17 path as well please.

@jbw976 I'm wondering if "Concepts" is the best area for this content? Feels like a mixture of guides/API reference as well 🤔. That said I don't strong about this, its better to have this info in the docs than bikeshedding about where it should be.

content/master/concepts/metrics.md

jeanduplessis · 2024-09-09T09:07:09Z

@pierluigilenoci please have a look at signing off your commits so it can pass the DCO check

Signed-off-by: Pierluigi Lenoci <[email protected]>

pierluigilenoci · 2024-09-09T09:11:45Z

@jeanduplessis all commit signed, duplicated the content in v1.17
@AdamRussak, your suggestion has now been integrated into the PR.

jeanduplessis

I'm happy with these as a good start that can be iterated on going forward. I'll wait for @jbw976 to confirm he's happy with the location of the content.

jeanduplessis · 2024-09-09T09:44:27Z

@pierluigilenoci removing of the table header has caused the build to fail

AdamRussak · 2024-09-09T10:17:00Z

Why?
I tested it in codespace, it is just showing Markdown syntax and is not converted to ui view.

@pierluigilenoci removing of the table header has caused the build to fail

Signed-off-by: Pierluigi Lenoci <[email protected]>

pierluigilenoci · 2024-09-09T10:19:37Z

@AdamRussak solved. Could you please approve it again?

Signed-off-by: Pierluigi Lenoci <[email protected]>

pierluigilenoci · 2024-09-09T10:36:36Z

content/master/concepts/metrics.md

+| {{<hover label="crossplane_managed_resource_first_time_to_readiness_seconds_bucket" line="27">}}crossplane_managed_resource_first_time_to_readiness_seconds_bucket{{</hover>}} | The time it took for a managed resource to become ready first time after creation |  |
+| {{<hover label="crossplane_managed_resource_first_time_to_reconcile_seconds_bucket" line="28">}}crossplane_managed_resource_first_time_to_reconcile_seconds_bucket{{</hover>}} | The time it took to detect a managed resource by the controller |  |
+| {{<hover label="upjet_resource_ttr_bucket" line="29">}}upjet_resource_ttr_bucket{{</hover>}} | Measures in seconds the `time-to-readiness` `(TTR)` for managed resources |  |
+{{< /table >}}


Can you please close this?

pierluigilenoci · 2024-09-09T10:36:42Z

content/v1.17/concepts/metrics.md

+| {{<hover label="crossplane_managed_resource_first_time_to_readiness_seconds_bucket" line="27">}}crossplane_managed_resource_first_time_to_readiness_seconds_bucket{{</hover>}} | The time it took for a managed resource to become ready first time after creation |  |
+| {{<hover label="crossplane_managed_resource_first_time_to_reconcile_seconds_bucket" line="28">}}crossplane_managed_resource_first_time_to_reconcile_seconds_bucket{{</hover>}} | The time it took to detect a managed resource by the controller |  |
+| {{<hover label="upjet_resource_ttr_bucket" line="29">}}upjet_resource_ttr_bucket{{</hover>}} | Measures in seconds the `time-to-readiness` `(TTR)` for managed resources |  |
+{{< /table >}}


Can you please close this?

pierluigilenoci · 2024-09-09T13:29:02Z

@jbw976, please give us feedback.

negz · 2024-09-10T00:09:59Z

@jbw976 I'm wondering if "Concepts" is the best area for this content?

FWIW that was my first thought too. I don't think this is a Crossplane concept. Not sure where the best fit for it is though.

negz · 2024-09-10T00:12:13Z

content/master/concepts/metrics.md

+This page offers explanations of various metrics gathered from Crossplane, which are essential for effective monitoring and alerting in your Crossplane environment.
+Understanding these metrics help you maintain the health and performance of your resources, ensuring to identify and address any issues.
+Please note that this document focuses on Crossplane specific metrics and doesn't cover standard Go metrics.


It'd be useful to mention:

That these are prometheus style metrics

Where they're exposed (i.e. the port and URL)

How to enable them (iirc they're not on by default)

I don't think it's worth explaining what Prometheus style metrics are or how they work, but we should link to the Prometheus documentation for those who are unfamiliar.

jbw976

Really cool to see you take the initiative to document this useful information
@Shwethamuralikrishnaa and @pierluigilenoci. Thank you for taking the time to do so!

I know Vale is a bit of a pain, but hopefully that pain is reduced some with all the fixes we have cooking in #810. I will hold off on merging that one though so you don't have to deal with any merge conflicts 😇

jbw976 · 2024-09-10T00:20:56Z

content/master/concepts/metrics.md

+Please note that this document focuses on Crossplane specific metrics and doesn't cover standard Go metrics.
+
+
+| Metric Name | Description | Further Explanation |


on the preview site, the table is a bit hard to read/parse because there are no visible rows: https://deploy-preview-802--crossplane.netlify.app/v1.17/concepts/metrics/

Take a look at the table for Customize the Crossplane Helm chart on
https://github.com/crossplane/docs/blob/master/content/master/software/install.md#customize-the-crossplane-helm-chart

It does some styling directives to make easily visible striped rows - see if that helps with this new table!

For example:

{{< table "table table-hover table-striped table-sm">}}

pierluigilenoci · 2024-09-10T11:06:54Z

@negz @jeanduplessis, please tell me where to move it, or just be happy, and we'll move it later. 😜
@negz I'll add a note about Prometheus metrics. However, if someone wants to use Kubernetes and Crossplane nowadays but doesn't know Prometheus metrics, maybe it's better for them not to.
@jbw976 I'll try to integrate the annotations. I had already tried, but the pipeline was broken. Ref: #802 (comment)

Signed-off-by: Pierluigi Lenoci <[email protected]>

pierluigilenoci · 2024-09-10T14:49:42Z

@negz integrated your suggestions and moved the page from Concept to Guides.
@jbw976 added the directives; let's see what happens once approved.

jbw976 · 2024-09-10T15:46:19Z

Deployment preview succeeded and the table with the colored rows looks great @pierluigilenoci!!
https://deploy-preview-802--crossplane.netlify.app/v1.17/guides/metrics/

Don't worry about any of the Vale failures, I'll make sure it's still all clean and green in #810 🟢

Signed-off-by: Pierluigi Lenoci <[email protected]>

pierluigilenoci · 2024-09-10T16:05:17Z

@jbw976, it's too late! 😄

pierluigilenoci · 2024-09-10T16:06:48Z

@jbw976, what needs to be added to merge with PR if the page looks great and everything else is 🟢 ?

jbw976

Thank you very much for continuing to drive this PR and get this important topic documented! 🙇‍♂️

Shwethamuralikrishnaa force-pushed the add-metrics-readme branch 3 times, most recently from 35f9e7e to 9a60cd0 Compare August 23, 2024 14:13

jeanduplessis requested a review from jbw976 August 28, 2024 12:29

Shwethamuralikrishnaa and others added 2 commits September 6, 2024 16:10

Add readme for Crossplane metrics

3885f02

Signed-off-by: shwethamuralikrishnaa [email protected] Signed-off-by: shwethamuralikrishnaa <[email protected]> Signed-off-by: Pierluigi Lenoci <[email protected]>

lint-fix Vale

47da6d6

Signed-off-by: Pierluigi Lenoci <[email protected]>

pierluigilenoci force-pushed the add-metrics-readme branch from 5b306f6 to 47da6d6 Compare September 6, 2024 14:10

Merge branch 'master' into add-metrics-readme

1ca6c9a

jeanduplessis requested changes Sep 9, 2024

View reviewed changes

AdamRussak reviewed Sep 9, 2024

View reviewed changes

content/master/concepts/metrics.md Outdated Show resolved Hide resolved

AdamRussak approved these changes Sep 9, 2024

View reviewed changes

pierluigilenoci force-pushed the add-metrics-readme branch from 39511ee to d501140 Compare September 9, 2024 09:06

fix markdown, duplicated in v.1.17, lint fix

4a0af10

Signed-off-by: Pierluigi Lenoci <[email protected]>

pierluigilenoci force-pushed the add-metrics-readme branch from d501140 to 4a0af10 Compare September 9, 2024 09:07

jeanduplessis approved these changes Sep 9, 2024

View reviewed changes

fix markdown 2

0b7ce7d

Signed-off-by: Pierluigi Lenoci <[email protected]>

pierluigilenoci force-pushed the add-metrics-readme branch from 4e84185 to 0b7ce7d Compare September 9, 2024 10:18

I hate Vale

da78ef2

Signed-off-by: Pierluigi Lenoci <[email protected]>

pierluigilenoci reviewed Sep 9, 2024

View reviewed changes

AdamRussak approved these changes Sep 9, 2024

View reviewed changes

negz reviewed Sep 10, 2024

View reviewed changes

jbw976 reviewed Sep 10, 2024

View reviewed changes

pierluigilenoci added 3 commits September 10, 2024 14:58

Added the prometheus related infos

3f328bf

Signed-off-by: Pierluigi Lenoci <[email protected]>

Moved in another location

6357c10

Signed-off-by: Pierluigi Lenoci <[email protected]>

Integrated Jared suggestion

1901e55

Signed-off-by: Pierluigi Lenoci <[email protected]>

Vale I hate you

9c4d1fd

Signed-off-by: Pierluigi Lenoci <[email protected]>

jbw976 approved these changes Sep 10, 2024

View reviewed changes

jbw976 merged commit 5dbfab8 into crossplane:master Sep 10, 2024
7 checks passed

pierluigilenoci deleted the add-metrics-readme branch September 11, 2024 08:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Crossplane Metrics Documentation #802

Add Crossplane Metrics Documentation #802

Shwethamuralikrishnaa commented Aug 23, 2024

netlify bot commented Aug 23, 2024 •

edited

Loading

pierluigilenoci commented Aug 28, 2024

pierluigilenoci commented Aug 30, 2024

AdamRussak commented Sep 6, 2024

pierluigilenoci commented Sep 6, 2024

jeanduplessis left a comment

jeanduplessis commented Sep 9, 2024

pierluigilenoci commented Sep 9, 2024

jeanduplessis left a comment

jeanduplessis commented Sep 9, 2024

AdamRussak commented Sep 9, 2024

pierluigilenoci commented Sep 9, 2024

pierluigilenoci Sep 9, 2024

pierluigilenoci Sep 9, 2024

pierluigilenoci commented Sep 9, 2024

negz commented Sep 10, 2024

negz Sep 10, 2024

jbw976 left a comment

jbw976 Sep 10, 2024 •

edited

Loading

pierluigilenoci commented Sep 10, 2024

pierluigilenoci commented Sep 10, 2024

jbw976 commented Sep 10, 2024

pierluigilenoci commented Sep 10, 2024

pierluigilenoci commented Sep 10, 2024

jbw976 left a comment

		Please note that this document focuses on Crossplane specific metrics and doesn't cover standard Go metrics.


		\| Metric Name \| Description \| Further Explanation \|

Add Crossplane Metrics Documentation #802

Add Crossplane Metrics Documentation #802

Conversation

Shwethamuralikrishnaa commented Aug 23, 2024

netlify bot commented Aug 23, 2024 • edited Loading

✅ Deploy Preview for crossplane ready!

pierluigilenoci commented Aug 28, 2024

pierluigilenoci commented Aug 30, 2024

AdamRussak commented Sep 6, 2024

pierluigilenoci commented Sep 6, 2024

jeanduplessis left a comment

Choose a reason for hiding this comment

jeanduplessis commented Sep 9, 2024

pierluigilenoci commented Sep 9, 2024

jeanduplessis left a comment

Choose a reason for hiding this comment

jeanduplessis commented Sep 9, 2024

AdamRussak commented Sep 9, 2024

pierluigilenoci commented Sep 9, 2024

pierluigilenoci Sep 9, 2024

Choose a reason for hiding this comment

pierluigilenoci Sep 9, 2024

Choose a reason for hiding this comment

pierluigilenoci commented Sep 9, 2024

negz commented Sep 10, 2024

negz Sep 10, 2024

Choose a reason for hiding this comment

jbw976 left a comment

Choose a reason for hiding this comment

jbw976 Sep 10, 2024 • edited Loading

Choose a reason for hiding this comment

pierluigilenoci commented Sep 10, 2024

pierluigilenoci commented Sep 10, 2024

jbw976 commented Sep 10, 2024

pierluigilenoci commented Sep 10, 2024

pierluigilenoci commented Sep 10, 2024

jbw976 left a comment

Choose a reason for hiding this comment

netlify bot commented Aug 23, 2024 •

edited

Loading

jbw976 Sep 10, 2024 •

edited

Loading