Skip to content
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.

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

Update monitoring docs to use the in-cluster monitoring stack #2586

Merged
merged 44 commits into from
Apr 24, 2023

Conversation

dkwon17
Copy link
Contributor

@dkwon17 dkwon17 commented Apr 13, 2023

What does this pull request change?

Updates monitoring documentation to use OpenShift built-in monitor stack instead of template-based Prometheus + Grafana install.

Before image
After

image

To summarize, the Installing Prometheus and Grafana page was removed and the Monitoring the Dev Workspace Operator and Monitoring Che Server pages were updated.

What issues does this pull request fix or reference?

eclipse-che/che#22033

Specify the version of the product this pull request applies to

Dev Spaces 3.X

Pull Request checklist

The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.

  • Any procedure:
    • Successfully tested.
  • Any page or link rename:
  • Builds on Eclipse Che hosted by Red Hat.
  • the Validate language on files added or modified step reports no vale warnings.

@github-actions
Copy link

github-actions bot commented Apr 13, 2023

Click here to review and test in web IDE: Contribute

@github-actions
Copy link

github-actions bot commented Apr 13, 2023

🎊 Navigate the preview: https://644651017ba8f9330804f889--eclipse-che-docs-pr.netlify.app 🎊

@dkwon17 dkwon17 changed the title WIP Update monitoring docs to use the built-in monitoring stack Apr 13, 2023
@dkwon17 dkwon17 changed the title Update monitoring docs to use the built-in monitoring stack [WIP] Update monitoring docs to use the built-in monitoring stack Apr 13, 2023
@dkwon17 dkwon17 force-pushed the monitoring-with-built-in-prom branch 4 times, most recently from eff9c1b to b25f1fe Compare April 17, 2023 19:48
@dkwon17 dkwon17 changed the title [WIP] Update monitoring docs to use the built-in monitoring stack Update monitoring docs to use the built-in monitoring stack Apr 17, 2023
@dkwon17 dkwon17 force-pushed the monitoring-with-built-in-prom branch from b25f1fe to 66db837 Compare April 17, 2023 20:13
@dkwon17 dkwon17 changed the title Update monitoring docs to use the built-in monitoring stack Update monitoring docs to use the in-cluster monitoring stack Apr 17, 2023
@dkwon17 dkwon17 marked this pull request as ready for review April 17, 2023 20:29
@dkwon17 dkwon17 requested review from rkratky, max-cx, deerskindoll and a team as code owners April 17, 2023 20:29
@dkwon17 dkwon17 requested a review from svor April 17, 2023 20:29
@max-cx max-cx self-assigned this Apr 18, 2023
@max-cx max-cx merged commit 82b23fa into eclipse-che:main Apr 24, 2023
max-cx added a commit to max-cx/che-docs that referenced this pull request Apr 24, 2023
…e-che#2586)

* Update monitoring docs to use OpenShift built-in monitoring stack

Signed-off-by: David Kwon <[email protected]>

* Update modules/administration-guide/partials/ref_grafana-dashboards-for-the-dev-workspace-operator.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/ref_grafana-dashboards-for-the-dev-workspace-operator.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/ref_grafana-dashboards-for-the-dev-workspace-operator.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/ref_grafana-dashboards-for-the-dev-workspace-operator.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/ref_grafana-dashboards-for-the-dev-workspace-operator.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-dev-workspace-operator-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-dev-workspace-operator-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-dev-workspace-operator-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-dev-workspace-operator-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-dev-workspace-operator-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-dev-workspace-operator-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-dev-workspace-operator-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-dev-workspace-operator-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Add suggestion for troubleshoot tips in DWO

Signed-off-by: David Kwon <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-dev-workspace-operator-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-dev-workspace-operator-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/ref_grafana-dashboards-for-the-dev-workspace-operator.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-dev-workspace-operator-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-dev-workspace-operator-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Hardcode OpenShift-related values

Signed-off-by: David Kwon <[email protected]>

* Add empty lines withing the TIP text

Signed-off-by: David Kwon <[email protected]>

* Create disclaimer file

Signed-off-by: David Kwon <[email protected]>

* Updates to make the JVM Server metrics page more similar to DWO metrics page

Signed-off-by: David Kwon <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update Note admonition

Signed-off-by: David Kwon <[email protected]>

* Remove unnecessary +

Signed-off-by: David Kwon <[email protected]>

* Replace two AsciIDoc periods with AsciiDoc asterisks.

---------

Signed-off-by: David Kwon <[email protected]>
Co-authored-by: Max Leonov <[email protected]>
max-cx added a commit that referenced this pull request Apr 24, 2023
max-cx added a commit that referenced this pull request Apr 24, 2023
* Update monitoring docs to use OpenShift built-in monitoring stack

Signed-off-by: David Kwon <[email protected]>

* Update modules/administration-guide/partials/ref_grafana-dashboards-for-the-dev-workspace-operator.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/ref_grafana-dashboards-for-the-dev-workspace-operator.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/ref_grafana-dashboards-for-the-dev-workspace-operator.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/ref_grafana-dashboards-for-the-dev-workspace-operator.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/ref_grafana-dashboards-for-the-dev-workspace-operator.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-dev-workspace-operator-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-dev-workspace-operator-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-dev-workspace-operator-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-dev-workspace-operator-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-dev-workspace-operator-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-dev-workspace-operator-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-dev-workspace-operator-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-dev-workspace-operator-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Add suggestion for troubleshoot tips in DWO

Signed-off-by: David Kwon <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-dev-workspace-operator-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-dev-workspace-operator-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/ref_grafana-dashboards-for-the-dev-workspace-operator.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-dev-workspace-operator-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-dev-workspace-operator-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Hardcode OpenShift-related values

Signed-off-by: David Kwon <[email protected]>

* Add empty lines withing the TIP text

Signed-off-by: David Kwon <[email protected]>

* Create disclaimer file

Signed-off-by: David Kwon <[email protected]>

* Updates to make the JVM Server metrics page more similar to DWO metrics page

Signed-off-by: David Kwon <[email protected]>

* Update modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc

Co-authored-by: Max Leonov <[email protected]>

* Update Note admonition

Signed-off-by: David Kwon <[email protected]>

* Remove unnecessary +

Signed-off-by: David Kwon <[email protected]>

* Replace two AsciIDoc periods with AsciiDoc asterisks.

---------

Signed-off-by: David Kwon <[email protected]>
Co-authored-by: Max Leonov <[email protected]>
max-cx added a commit that referenced this pull request Apr 24, 2023
dkwon17 added a commit to dkwon17/che-docs that referenced this pull request Apr 25, 2023
max-cx pushed a commit that referenced this pull request Apr 26, 2023
* fix: replace namespace and app name with placeholders for #2586

Signed-off-by: David Kwon <[email protected]>

* Add role and rolebinding to dwo operators metrics setup

Signed-off-by: David Kwon <[email protected]>

---------

Signed-off-by: David Kwon <[email protected]>
max-cx pushed a commit that referenced this pull request Apr 26, 2023
* fix: replace namespace and app name with placeholders for #2586

Signed-off-by: David Kwon <[email protected]>

* Add role and rolebinding to dwo operators metrics setup

Signed-off-by: David Kwon <[email protected]>

---------

Signed-off-by: David Kwon <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants