Skip to content

OCM-19740 - local observability #571

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

Open
Alcamech wants to merge 1 commit into
base: master
Choose a base branch
from
Open

OCM-19740 - local observability #571

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
- [Remotely](#remotely)
- [Trigger Reconcile](#trigger-reconcile)
- [Monitoring ongoing upgrade](#monitoring-ongoing-upgrade)
- [Viewing Metrics Locally](#viewing-metrics-locally)
- [Maintenance](#maintenance)

This document should entail all you need to develop this operator locally.
Expand Down Expand Up @@ -341,6 +342,25 @@ oc get clusterversion -w
oc logs cluster-version-operator-<POD-ID> -n openshift-cluster-version -f
```

## Viewing Metrics Locally

When running the operator locally, Prometheus metrics are exposed at `http://localhost:8383/metrics`.

```shell
# In one terminal, run the operator
make run-standard-routes

# In another terminal, view metrics
curl http://localhost:8383/metrics

# Filter to operator-specific metrics
curl -s http://localhost:8383/metrics | grep upgradeoperator
```

For details on what each metric means and when it fires, see:
- [metrics.md](metrics.md) - Metric reference and alert mappings
- [metrics-tracing.md](metrics-tracing.md) - Where metrics are triggered in code

## Maintenance

We can leverage the script for maintenance:
Expand Down
Loading