Skip to content

Commit c85fb3b

Browse files
authored
Merge pull request #691 from ellen-lau/updateObs4.18
Update observability docs for RHOCP 4.18
2 parents bb1956b + 900bb22 commit c85fb3b

3 files changed

+8
-8
lines changed

doc/observability-deployment.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Observability with Open Liberty
22

3-
The following document covers various topics for configuring and integrating your Open Liberty runtime with monitoring tools in a Kubernetes environment. This document has been tested and is supported with Red Hat OpenShift Container Platform (RHOCP) versions 4.14, 4.15, 4.16, and 4.17.
3+
The following document covers various topics for configuring and integrating your Open Liberty runtime with monitoring tools in a Kubernetes environment. This document has been tested and is supported with Red Hat OpenShift Container Platform (RHOCP) versions 4.14, 4.15, 4.16, 4.17, and 4.18.
44

55
== How to analyze Open Liberty logs
66

doc/openshift-logging-rhocp_4.17+.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Application Logging on Red Hat OpenShift Container Platform (RHOCP) with Loki, Vector, and the RHOCP Cluster Observability Operator
22

3-
The following guide has been tested and is supported with Red Hat OpenShift Container Platform (RHOCP) version 4.17.
3+
The following guide has been tested and is supported with Red Hat OpenShift Container Platform (RHOCP) version 4.17 and 4.18.
44

55
Pod processes running in Kubernetes frequently produce logs. To effectively manage this log data and ensure no loss of log data occurs when a pod terminates, a log aggregation tool should be deployed on the Kubernetes cluster. Log aggregation tools help users persist, search, and visualize the log data that is gathered from the pods across the cluster. Log aggregation tools in the market today include: EFK, LogDNA, Splunk, Datadog, IBM Operations Analytics, etc. When considering log aggregation tools, enterprises make choices that are inclusive of their journey to cloud, both new cloud-native applications running in Kubernetes and their existing traditional IT choices.
66

7-
With the release of Logging 6.0 in RHOCP 4.17, the EFK stack is no longer supported. Logging 6.0 now manages log storage, collection, and visualization using Loki, Vector, and the Cluster Observability's new Logging UI Plugin. This guide describes the process of deploying the new stack using the Loki, RedHat OpenShift Logging, and Cluster Observability Operators. Use this stack to aggregate all container logs. After a successful installation, the Loki and log collector pods should reside inside the *openshift-logging* namespace of the cluster. Check out this link:++https://docs.openshift.com/container-platform/4.17/observability/logging/logging-6.0/log6x-upgrading-to-6.html[doc] for more information on the new changes introduced in Logging 6.0.
7+
With the release of Logging 6.0 in RHOCP 4.17, the EFK stack is no longer supported. Logging 6.0 now manages log storage, collection, and visualization using Loki, Vector, and the Cluster Observability's new Logging UI Plugin. This guide describes the process of deploying the new stack using the Loki, RedHat OpenShift Logging, and Cluster Observability Operators. Use this stack to aggregate all container logs. After a successful installation, the Loki and log collector pods should reside inside the *openshift-logging* namespace of the cluster. Check out this link:++https://docs.openshift.com/container-platform/4.18/observability/logging/logging-6.0/log6x-upgrading-to-6.html[doc] for more information on the new changes introduced in Logging 6.0.
88

99
## Setup LokiStack and Cluster Log Forwarding
1010

11-
Follow this link:++https://docs.openshift.com/container-platform/4.17/observability/logging/logging-6.0/log6x-about.html#quick-start[guide] to set up LokiStack and a ClusterLogForwarder in the `openshift-logging` namespace.
11+
Follow this link:++https://docs.openshift.com/container-platform/4.18/observability/logging/logging-6.0/log6x-about.html#quick-start[guide] to set up LokiStack and a ClusterLogForwarder in the `openshift-logging` namespace.
1212

1313
After the LokiStack and ClusterLogForwarder deployments are completed, you should see the following pods running in the openshift-logging namespace.
1414

@@ -38,7 +38,7 @@ collector-z75z5 1/1 Running 0 3h16
3838

3939
## Tips
4040

41-
You can configure LokiStack and the CustomLogForwarder according to your needs. Check out this link:https://docs.openshift.com/container-platform/4.17/observability/logging/logging-6.0/log6x-loki.html[doc] for how to configure LokiStack storage, and this link:https://docs.openshift.com/container-platform/4.17/observability/logging/logging-6.0/log6x-clf.html[doc] for how to configure log fowarding.
41+
You can configure LokiStack and the CustomLogForwarder according to your needs. Check out this link:https://docs.openshift.com/container-platform/4.18/observability/logging/logging-6.0/log6x-loki.html[doc] for how to configure LokiStack storage, and this link:https://docs.openshift.com/container-platform/4.18/observability/logging/logging-6.0/log6x-clf.html[doc] for how to configure log fowarding.
4242

4343
### Object storage
4444

doc/openshift-monitoring.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Application Monitoring on Red Hat OpenShift Container Platform (RHOCP) with Prometheus and Grafana
22

3-
The following guide has been tested and is supported with Red Hat OpenShift Container Platform (RHOCP) versions 4.14, 4.15, 4.16, 4.17.
3+
The following guide has been tested and is supported with Red Hat OpenShift Container Platform (RHOCP) versions 4.14, 4.15, 4.16, 4.17, and 4.18.
44

55
## Prerequisites
66

@@ -14,9 +14,9 @@ In RHOCP 4.6+, application monitoring can be set up by enabling monitoring for u
1414

1515
There is no separate Grafana deployment that comes with enabling user-defined monitoring and the existing Grafana instance provided with the default monitoring stack is read-only, so a community-powered Grafana Operator must be installed later to create custom dashboards for viewing your metrics.
1616

17-
. To configure the monitoring stack, follow this OpenShift guide link:++https://docs.openshift.com/container-platform/4.17/observability/monitoring/configuring-the-monitoring-stack.html#preparing-to-configure-the-monitoring-stack++[Configuring the monitoring stack]. Here, you will create two config maps, `cluster-monitoring-config` and `user-workload-monitoring-config`, that will allow you to enable monitoring for user-defined projects in the next step. After creating the `user-workload-monitoring-config` config map, return to this guide to continue setting up monitoring for user-defined projects.
17+
. To configure the monitoring stack, follow this OpenShift guide link:++https://docs.openshift.com/container-platform/4.18/observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.html++[Configuring the monitoring stack]. Here, you will create two config maps, `cluster-monitoring-config` and `user-workload-monitoring-config`, that will allow you to enable monitoring for user-defined projects in the next step. After creating the `user-workload-monitoring-config` config map, return to this guide to continue setting up monitoring for user-defined projects.
1818

19-
. To enable monitoring for user-defined projects, follow the OpenShift guide link:++https://docs.openshift.com/container-platform/4.17/observability/monitoring/enabling-monitoring-for-user-defined-projects.html++[Enabling monitoring for user-defined projects].
19+
. To enable monitoring for user-defined projects, follow the OpenShift guide link:++https://docs.openshift.com/container-platform/4.18/observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.html++[Enabling monitoring for user-defined projects].
2020

2121
. Deploy a Service Monitor inside the `myapp` namespace to define the service endpoint that will be monitored by the Prometheus instance. Add the following YAML to your OpenLibertyApplication Custom Resource (CR):
2222

0 commit comments

Comments
 (0)