Introduce MR metrics #1281

mergenci · 2024-04-22T11:18:35Z

Description of your changes

Consume crossplane/crossplane-runtime#683 and crossplane/upjet#390.

I have:

Read and followed Crossplane's contribution process.
Run make reviewable to ensure this PR is ready for review.
Added backport release-x.y labels to auto-backport this PR if necessary.

How has this code been tested

I used the following configuration and followed the steps below:

apiVersion: ec2.aws.upbound.io/v1beta1
kind: VPC
metadata:
  name: test-pr-1281-vpc
spec:
  forProvider:
    region: us-west-1
    cidrBlock: 172.16.0.0/16
    tags:
      Name: test-pr-1281-vpc

Before applying the configuration, visit :8080/metrics and check that no metrics with prefix “managed_resource” are reported.
Apply the configuration: kubectl apply -f vpc.yaml
Upon successful creation, relevant metrics should look like below:

# HELP crossplane_managed_resource_exists The number of managed resources that exist
# TYPE crossplane_managed_resource_exists gauge
crossplane_managed_resource_exists{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC"} 1
# HELP crossplane_managed_resource_first_time_to_readiness_seconds The time it took for a managed resource to become ready first time after creation
# TYPE crossplane_managed_resource_first_time_to_readiness_seconds histogram
crossplane_managed_resource_first_time_to_readiness_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="1"} 0
crossplane_managed_resource_first_time_to_readiness_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="5"} 0
crossplane_managed_resource_first_time_to_readiness_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="10"} 0
crossplane_managed_resource_first_time_to_readiness_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="15"} 1
crossplane_managed_resource_first_time_to_readiness_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="30"} 1
crossplane_managed_resource_first_time_to_readiness_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="60"} 1
crossplane_managed_resource_first_time_to_readiness_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="120"} 1
crossplane_managed_resource_first_time_to_readiness_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="300"} 1
crossplane_managed_resource_first_time_to_readiness_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="600"} 1
crossplane_managed_resource_first_time_to_readiness_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="1800"} 1
crossplane_managed_resource_first_time_to_readiness_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="3600"} 1
crossplane_managed_resource_first_time_to_readiness_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="+Inf"} 1
crossplane_managed_resource_first_time_to_readiness_seconds_sum{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC"} 11.314458
crossplane_managed_resource_first_time_to_readiness_seconds_count{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC"} 1
# HELP crossplane_managed_resource_first_time_to_reconcile_seconds The time it took for a managed resource to be detected by the controller
# TYPE crossplane_managed_resource_first_time_to_reconcile_seconds histogram
crossplane_managed_resource_first_time_to_reconcile_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="1e-08"} 0
crossplane_managed_resource_first_time_to_reconcile_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="1e-07"} 0
crossplane_managed_resource_first_time_to_reconcile_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="1e-06"} 0
crossplane_managed_resource_first_time_to_reconcile_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="9.999999999999999e-06"} 0
crossplane_managed_resource_first_time_to_reconcile_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="9.999999999999999e-05"} 0
crossplane_managed_resource_first_time_to_reconcile_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="0.001"} 0
crossplane_managed_resource_first_time_to_reconcile_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="0.01"} 0
crossplane_managed_resource_first_time_to_reconcile_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="0.1"} 0
crossplane_managed_resource_first_time_to_reconcile_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="1"} 1
crossplane_managed_resource_first_time_to_reconcile_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="10"} 1
crossplane_managed_resource_first_time_to_reconcile_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="+Inf"} 1
crossplane_managed_resource_first_time_to_reconcile_seconds_sum{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC"} 0.174357
crossplane_managed_resource_first_time_to_reconcile_seconds_count{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC"} 1
# HELP crossplane_managed_resource_ready The number of managed resources in Ready=True state
# TYPE crossplane_managed_resource_ready gauge
crossplane_managed_resource_ready{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC"} 1
# HELP crossplane_managed_resource_synced The number of managed resources in Synced=True state
# TYPE crossplane_managed_resource_synced gauge
crossplane_managed_resource_synced{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC"} 1

Edit the resource, add a tag for example, to introduce a drift: kubectl edit vpc.ec2.aws.upbound.io/test-pr-1281-vpc. Upon reconciliation, crossplane_managed_resource_drift_seconds should appear:

# HELP crossplane_managed_resource_drift_seconds ALPHA: How long since the previous successful reconcile when a resource was found to be out of sync; excludes restart of the provider
# TYPE crossplane_managed_resource_drift_seconds histogram
crossplane_managed_resource_drift_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="1e-08"} 0
crossplane_managed_resource_drift_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="1e-07"} 0
crossplane_managed_resource_drift_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="1e-06"} 0
crossplane_managed_resource_drift_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="9.999999999999999e-06"} 0
crossplane_managed_resource_drift_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="9.999999999999999e-05"} 0
crossplane_managed_resource_drift_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="0.001"} 0
crossplane_managed_resource_drift_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="0.01"} 0
crossplane_managed_resource_drift_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="0.1"} 0
crossplane_managed_resource_drift_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="1"} 0
crossplane_managed_resource_drift_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="10"} 0
crossplane_managed_resource_drift_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="+Inf"} 1
crossplane_managed_resource_drift_seconds_sum{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC"} 65.694694333
crossplane_managed_resource_drift_seconds_count{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC"} 1

Finally, delete the resource, to observe crossplane_managed_resource_deletion_seconds: kubectl delete vpc.ec2.aws.upbound.io/test-pr-1281-vpc.

# HELP crossplane_managed_resource_deletion_seconds The time it took for a managed resource to be deleted
# TYPE crossplane_managed_resource_deletion_seconds histogram
crossplane_managed_resource_deletion_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="1"} 0
crossplane_managed_resource_deletion_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="5"} 0
crossplane_managed_resource_deletion_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="10"} 1
crossplane_managed_resource_deletion_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="15"} 1
crossplane_managed_resource_deletion_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="30"} 1
crossplane_managed_resource_deletion_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="60"} 1
crossplane_managed_resource_deletion_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="120"} 1
crossplane_managed_resource_deletion_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="300"} 1
crossplane_managed_resource_deletion_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="600"} 1
crossplane_managed_resource_deletion_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="1800"} 1
crossplane_managed_resource_deletion_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="3600"} 1
crossplane_managed_resource_deletion_seconds_bucket{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC",le="+Inf"} 1
crossplane_managed_resource_deletion_seconds_sum{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC"} 5.061364
crossplane_managed_resource_deletion_seconds_count{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC"} 1

Note that because of a known issue in the draft crossplane-runtime PR, MR status metrics are not set to zero after resource deletion:

# HELP crossplane_managed_resource_exists The number of managed resources that exist
# TYPE crossplane_managed_resource_exists gauge
crossplane_managed_resource_exists{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC"} 1
# HELP crossplane_managed_resource_ready The number of managed resources in Ready=True state
# TYPE crossplane_managed_resource_ready gauge
crossplane_managed_resource_ready{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC"} 1
# HELP crossplane_managed_resource_synced The number of managed resources in Synced=True state
# TYPE crossplane_managed_resource_synced gauge
crossplane_managed_resource_synced{gvk="ec2.aws.upbound.io/v1beta1, Kind=VPC"} 1

mergenci · 2024-04-23T09:42:33Z

/test-examples="examples/iam/v1beta1/role.yaml"

Signed-off-by: Cem Mergenci <[email protected]>

mergenci · 2024-04-25T13:06:00Z

/test-examples="examples/ec2/v1beta1/securitygroupingressrule.yaml"

ulucinar

Thank you @mergenci, lgtm.

mergenci mentioned this pull request Apr 22, 2024

Introduce MR metrics crossplane/upjet#390

Merged

3 tasks

mergenci force-pushed the mr-metrics branch from 61075f8 to e282ed8 Compare April 22, 2024 14:55

This was referenced Apr 23, 2024

Introduce MR metrics crossplane-contrib/provider-upjet-azure#720

Merged

Introduce MR metrics crossplane-contrib/provider-upjet-gcp#512

Merged

Introduce MR metrics crossplane-contrib/provider-upjet-azuread#127

Merged

mergenci force-pushed the mr-metrics branch from e282ed8 to aed2ed4 Compare April 24, 2024 17:27

Introduce MR metrics.

f51748f

Signed-off-by: Cem Mergenci <[email protected]>

mergenci force-pushed the mr-metrics branch from aed2ed4 to f51748f Compare April 25, 2024 13:03

mergenci marked this pull request as ready for review April 25, 2024 13:06

mergenci requested review from ulucinar, sergenyalcin, turkenf and mbbush as code owners April 25, 2024 13:06

ulucinar approved these changes Apr 25, 2024

View reviewed changes

ulucinar merged commit 58c7765 into crossplane-contrib:main Apr 25, 2024
12 checks passed

mergenci deleted the mr-metrics branch April 25, 2024 13:47

arththebird mentioned this pull request Jun 28, 2024

feat: introduce MR metrics upbound/provider-terraform#277

Merged

1 task

sergenyalcin mentioned this pull request Jul 30, 2024

chore: bump up dependencies and enable metrics crossplane/upjet-provider-template#69

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce MR metrics #1281

Introduce MR metrics #1281

mergenci commented Apr 22, 2024 •

edited

Loading

mergenci commented Apr 23, 2024

mergenci commented Apr 25, 2024

ulucinar left a comment

Introduce MR metrics #1281

Introduce MR metrics #1281

Conversation

mergenci commented Apr 22, 2024 • edited Loading

Description of your changes

How has this code been tested

mergenci commented Apr 23, 2024

mergenci commented Apr 25, 2024

ulucinar left a comment

Choose a reason for hiding this comment

mergenci commented Apr 22, 2024 •

edited

Loading