Wrong label and container port in doc on Setting up Metrics Monitoring for Operator-backed deployments

[rm3l]

What do you want to improve?

https://github.com/janus-idp/backstage-showcase/blob/main/showcase-docs/monitoring-and-logging.md#operator-backed-deployment

Stumbled upon this while reviewing redhat-developer/red-hat-developers-documentation-rhdh#263

What is the current documentation?

# make sure to update CR_NAME value accordingly
$ CR_NAME=my-rhdh
$ MY_PROJECT=my-project
$ cat <<EOF > /tmp/${CR_NAME}.ServiceMonitor.yaml
apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  name: ${CR_NAME}
  namespace: ${MY_PROJECT}
  labels:
    app.kubernetes.io/instance: ${CR_NAME}
    app.kubernetes.io/name: backstage
spec:
  namespaceSelector:
    matchNames:
      - ${MY_PROJECT}
  selector:
    matchLabels:
      janus-idp.io/app: backstage-${CR_NAME}
  endpoints:
  - port: http-backend
    path: '/metrics'
EOF
$ oc apply -f /tmp/${CR_NAME}.ServiceMonitor.yaml

In the ServiceMonitor resource to create, the label name added by the Operator has changed from janus-idp.io/app to rhdh.redhat.com/app a long time ago (janus-idp/operator#199) before the first version of the operator was released, and we forgot to update this doc.

Also, the container port endpoint to scrape metrics from seems to be wrong. It should be backend as per the 1.1.x, 1.2.x or main branches in the operator repo.

As a consequence, the instructions depicted in this https://github.com/janus-idp/backstage-showcase/blob/main/showcase-docs/monitoring-and-logging.md#operator-backed-deployment will not work as expected.

What is the new documentation?

• Replace janus-idp.io/app with rhdh.redhat.com/app
• Replace the container port name from http-backend to backend
• Make sure the instructions provided work correctly

/good-first-issue

JIRA: https://issues.redhat.com/browse/RHIDP-2657

[openshift-ci]

@rm3l:
This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

What do you want to improve?

https://github.com/janus-idp/backstage-showcase/blob/main/showcase-docs/monitoring-and-logging.md#operator-backed-deployment

What is the current documentation?

In the ServiceMonitor resource to create, the label name added by the Operator has changed from janus-idp.io/app to rhdh.redhat.com/app a long time ago (janus-idp/operator#199) before the first version of the operator was released, and we forgot to update this doc.

Also, the container port endpoint to scrape metrics from seems to be wrong. It should be backend as per the 1.1.x, 1.2.x or main branches in the operator repo.

As a consequence, the instructions depicted in this https://github.com/janus-idp/backstage-showcase/blob/main/showcase-docs/monitoring-and-logging.md#operator-backed-deployment will not work as expected.

What is the new documentation?

• Replace janus-idp.io/app with rhdh.redhat.com/app
• Replace the container port name from http-backend to backend
• Make sure the instructions provided work correctly

/good-first-issue

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.

[Fortune-Ndlovu]

The relevant updates have been made for this issue and I have also opened up the PR: https://github.com/janus-idp/backstage-showcase/pull/1332.

[rm3l]

Fixed by #1332

/close

[openshift-ci]

@rm3l: Closing this issue.

In response to this:

Fixed by #1332

/close

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.