hyperledger / fabric-x-committer / 30786346119

91%

Build Type

push

github

Committed by web-flow

Commit Message

[coordinator] Fix swapped manager metrics, report queues on scrape (#724)

#### Type of change

- Bug fix
- Improvement (improvement to code, performance, etc)
- Breaking change
- Test update

#### Description

- Register the metric set common to both service managers from a single
`newManagerMetrics`,
instantiated once per manager, so the verifier and vcservice series can
no longer be given
  each other's subsystem.
- Rename `retired_transaction_total` to `transaction_retried_total` and
shorten the queue-size
gauge names. Dashboards querying the old names need updating; see the
mapping below.
- Report the queue depths with `prometheus.NewGaugeFunc`, through a new
`monitoring.Provider.NewGaugeFunc`, and drop `Service.monitorQueues`
along with its goroutine
and ticker. The reported value is now exact at scrape time instead of up
to one sampling
interval stale. `queue-monitor-sampling-time` is unchanged and still
used by the dependency
  graph, which keeps its own sampler.
- `scripts/metrics_doc_extract.py`: follow a metric helper defined in
the file being parsed (it
resolved only `package.Func` against `utils/<package>/metrics.go`),
recognise `NewGaugeFunc`,
and skip a definition whose namespace is still `params.Namespace` — it
is emitted once per call
  site with the namespace substituted.
- `TestManagerMetricsSubsystem` asserts on the exported series names.
The existing tests asserted
on the `perfMetrics` fields, which is why they passed while the series
were swapped.

#### Additional details (Optional)

Metric name changes, for dashboard migration. The first two rows also
change meaning, since the
counters were reporting each other's manager:

| before | after |
|---|---|
| `coordinator_vcservice_retired_transaction_total` (held verifier
retries) | `coordinator_verifier_transaction_retried_total` |
| `coordinator_verifier_retired_transaction_total` (held vcservice
retries) | `coordinator_vcservice_transaction_retried_total` |
| `coordinator_verifier... (continued)

Coverage Stats

46 of 46 new or added lines in 5 files covered. (100.0%)

18 existing lines in 7 files now uncovered.

10524 of 11539 relevant lines covered (91.2%)

34210.96 hits per line