[release-4.22] OCPBUGS-109638: Fix clock_state metric: HOLDOVER mapped to 0, stale when CEP enabled

[jzding]

Summary

Backport of upstream PR k8snetworkplumbingwg/linuxptp-daemon#250 to release-4.22.

Two fixes for the openshift_ptp_clock_state Prometheus metric:

• HOLDOVER mapped to 0 instead of 2 — updateClockStateMetrics only distinguished LOCKED (1) from everything else (0). HOLDOVER was indistinguishable from FREERUN despite the help text declaring 0 = FREERUN, 1 = LOCKED, 2 = HOLDOVER. Replaced the if/else with a switch using typed constants shared between metrics.go and event.go.

• Metric stale when CEP enabled — EventHandler.UpdateClockStateMetrics was guarded by if e.stdoutToSocket { return }, skipping Prometheus updates when cloud-event-proxy was enabled. Since CEP does not register its own openshift_ptp_clock_state gauge, this left the metric stale. Removed the guard so the metric is always updated.

Fixes: OCPBUGS-95587

Test plan

• TestUpdateClockStateMetrics — verifies FREERUN→0, LOCKED→1, HOLDOVER→2
• go build ./... passes
• Lab tested on cnfdg32 (OCP 4.22) with upstream PR

[openshift-ci-robot]

@jzding: This pull request references Jira Issue OCPBUGS-95587, which is invalid:

• expected the bug to be open, but it isn't
• expected the bug to target either version "4.22.0." or "openshift-4.22.0.", but it targets "5.0.0" instead
• expected the bug to be in one of the following states: NEW, ASSIGNED, POST, but it is Closed (Done) instead
• release note text must be set and not match the template OR release note type must be set to "Release Note Not Required". For more information you can reference the OpenShift Bug Process.
• expected Jira Issue OCPBUGS-95587 to depend on a bug targeting a version in 5.0.0 and in one of the following states: MODIFIED, ON_QA, VERIFIED, but no dependents were found

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

Details

In response to this:

Summary

Backport of upstream PR k8snetworkplumbingwg/linuxptp-daemon#250 to release-4.22.

Two fixes for the openshift_ptp_clock_state Prometheus metric:

• HOLDOVER mapped to 0 instead of 2 — updateClockStateMetrics only distinguished LOCKED (1) from everything else (0). HOLDOVER was indistinguishable from FREERUN despite the help text declaring 0 = FREERUN, 1 = LOCKED, 2 = HOLDOVER. Replaced the if/else with a switch using typed constants shared between metrics.go and event.go.

• Metric stale when CEP enabled — EventHandler.UpdateClockStateMetrics was guarded by if e.stdoutToSocket { return }, skipping Prometheus updates when cloud-event-proxy was enabled. Since CEP does not register its own openshift_ptp_clock_state gauge, this left the metric stale. Removed the guard so the metric is always updated.

Fixes: OCPBUGS-95587

Test plan

• TestUpdateClockStateMetrics — verifies FREERUN→0, LOCKED→1, HOLDOVER→2
• go build ./... passes
• Lab tested on cnfdg32 (OCP 4.22) with upstream PR

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jzding

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [jzding]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[openshift-ci]

@jzding: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/unit-test	9fb37ff	link	true	/test unit-test
ci/prow/gofmt	9fb37ff	link	true	/test gofmt

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[openshift-ci-robot]

@jzding: This pull request references Jira Issue OCPBUGS-109638, which is invalid:

• release note text must be set and not match the template OR release note type must be set to "Release Note Not Required". For more information you can reference the OpenShift Bug Process.
• expected dependent Jira Issue OCPBUGS-95587 to be in one of the following states: MODIFIED, ON_QA, VERIFIED, but it is Closed (Done) instead

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

Details

In response to this:

Summary

Backport of upstream PR k8snetworkplumbingwg/linuxptp-daemon#250 to release-4.22.

Two fixes for the openshift_ptp_clock_state Prometheus metric:

• HOLDOVER mapped to 0 instead of 2 — updateClockStateMetrics only distinguished LOCKED (1) from everything else (0). HOLDOVER was indistinguishable from FREERUN despite the help text declaring 0 = FREERUN, 1 = LOCKED, 2 = HOLDOVER. Replaced the if/else with a switch using typed constants shared between metrics.go and event.go.

• Metric stale when CEP enabled — EventHandler.UpdateClockStateMetrics was guarded by if e.stdoutToSocket { return }, skipping Prometheus updates when cloud-event-proxy was enabled. Since CEP does not register its own openshift_ptp_clock_state gauge, this left the metric stale. Removed the guard so the metric is always updated.

Fixes: OCPBUGS-95587

Test plan

• TestUpdateClockStateMetrics — verifies FREERUN→0, LOCKED→1, HOLDOVER→2
• go build ./... passes
• Lab tested on cnfdg32 (OCP 4.22) with upstream PR

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.