register-metric-endpoint is exiting with a RC > 0 and an error message that contradicts documentation.

[Houlistonm]

Environment (edited for brevity)

+--------------------------------+----------------+-------------------+-------------------+
|              NAME              |   AVAILABLE    |      STAGED       |     DEPLOYED      |
+--------------------------------+----------------+-------------------+-------------------+
| appMetrics                     | 2.1.3-build.14 | 2.1.3-build.14    | 2.1.3-build.14    |
| cf                             | 2.12.12        | 2.12.12           | 2.12.12           |
| credhub-service-broker         | 1.5.1          | 1.5.1             | 1.5.1             |
| metric-store                   | 1.5.4          | 1.5.4             | 1.5.4             |
| p-bosh                         |                | 2.10.39-build.450 | 2.10.39-build.450 |
| p-healthwatch2                 | 2.1.9-build.31 | 2.1.9-build.31    | 2.1.9-build.31    |
| p-healthwatch2-pas-exporter    | 2.1.9-build.31 | 2.1.9-build.31    | 2.1.9-build.31    |
| p-isolation-segment-customer-a | 2.12.7         | 2.12.7            | 2.12.7            |
| p_spring-cloud-services        | 3.1.36         | 3.1.36            | 3.1.36            |
+--------------------------------+----------------+-------------------+-------------------+

Everything below was working when we were using 1.3.4 of the plugin, as soon as we switch to 1.3.5, everything started failing.

Installed cli w/o issue

$ cf install-plugin -f -r TWS "metric-registrar"
Plugin metric-registrar 1.3.5 successfully installed.

Registering the endpoint reported an error

$ cf target -o system -s system
$ cf register-metrics-endpoint forwarder /metrics
need to pass either --internal-port or --insecure
$ echo $?
1

Checking the status

$cf registered-metrics-endpoints
App        Path
forwarder  /metrics

It appears the command succeeded but threw an error (which breaks our CI pipeline).

Look for me in slack if you have a question.

[cf-gitbot]

We have created an issue in Pivotal Tracker to manage this. Unfortunately, the Pivotal Tracker project is private so you may be unable to view the contents of the story.

The labels on this github issue will be updated when the story is started.