You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-7
Original file line number
Diff line number
Diff line change
@@ -8,17 +8,18 @@ It is deployed as a web application in a WebLogic Server (WLS) instance, version
8
8
9
9
## Downloading the release
10
10
11
-
You can find all the releases on the [releases page](https://github.com/oracle/weblogic-monitoring-exporter/releases).
12
-
To download the web application wls-exporter.war and put your configuration file into the WAR, download the getXXX.sh script and then run:
11
+
You can find all the releases on the [Releases page](https://github.com/oracle/weblogic-monitoring-exporter/releases).
12
+
13
+
To download the web application `wls-exporter.war` and put your configuration file into the WAR, download the `getXXX.sh` script, which is provided with each release and also can be downloaded from the Releases page, and then run:
13
14
14
15
```
15
16
bash getXXX.sh <your-config-file>
16
17
```
17
18
18
19
## Building from source
19
20
20
-
Use `mvn install` to build the web application. This will create `wls-exporter-<version>`, where <version>
21
-
is the Maven-assigned version number, It is intended for release to Maven Central.
21
+
Use `mvn install` to build the web application. This will create `wls-exporter-<version>`, where _version_
22
+
is the Maven-assigned version number.
22
23
23
24
Adding `-Dconfiguration=<some-config-file>` will insert the specified configuration as its default and remove
24
25
the version number to simplify deployment to WebLogic Server.
@@ -72,7 +73,7 @@ Within each section, there are a number of options:
72
73
73
74
Note that all fields other than the above, will be interpreted as collections of values.
74
75
75
-
In the above example, the presumed underlying data structure is:
76
+
In the preceding example, the presumed underlying data structure is:
76
77
```
77
78
+---------------+ applicationRuntimes
78
79
| ServerRuntime |-----------+
@@ -120,7 +121,7 @@ The exporter produces metrics for monitoring its own performance:
120
121
121
122
The exporter must be able to contact the REST API of the WLS instance on which it is deployed. It does so by using
122
123
the primary host address of its server and the port on which the request for metrics was made. Usually, that will work;
123
-
however, if the metrics request is made via a load balancer or Kubernetes NodePort service, the port to which the
124
+
however, if the metrics request is made using a load balancer or Kubernetes NodePort service, the port to which the
124
125
original request was made might not be the same as the instance's HTTP port. In such a case, the configuration should
125
126
include the `restPort` configuration to tell the exporter which port to use.
126
127
@@ -134,4 +135,5 @@ include the `restPort` configuration to tell the exporter which port to use.
## Monitoring WebLogic Server with the Grafana Dashboard
2
-
This is an end-to-end sample that shows you the steps to set up monitoring for WebLogic domains using Prometheus and Grafana. In the end, you'll have Prometheus, Grafana, and WebLogic domains installed, configured, and running. This sample includes Grafana dashboards to visualize the WebLogic Server runtime metrics. Also, we demonstrate how to fire alerts based on the metrics.
2
+
This is an end-to-end sample that demonstrates setting up monitoring for WebLogic domains using Prometheus and Grafana. When completed, you'll have Prometheus, Grafana, and WebLogic domains installed, configured, and running. This sample includes Grafana dashboards to visualize the WebLogic Server runtime metrics and demonstrates how to fire alerts based on the metrics.
3
3
4
-
First, let's look at [what's in the WebLogic Server Dashboard](docs/dashboard.md).
4
+
First, look at [what's in the WebLogic Server Dashboard](docs/dashboard.md).
5
5
6
-
Before going into the detailed steps, look at the diagram below for the overall architecture containing the basic components we'll deploy to a Kubernetes cluster.
6
+
See the following diagram for the overall architecture containing the basic components that we'll deploy to a Kubernetes cluster.
7
7
8
8
9
9
10
10
Here's how the WebLogic runtime metrics are generated, scraped, stored, and used:
11
-
- WebLogic Servers expose their runtime data via the REST API.
11
+
- WebLogic Servers expose their runtime data using the REST API.
12
12
- The exporter, running on each WebLogic Server instance, acquires WebLogic data by calling the REST API, which it then translates to the Prometheus metrics format and exposes in an HTTP endpoint.
13
13
- The Prometheus server periodically scrapes the metrics from the endpoints and stores them in its time series database.
14
14
- Graphing - The Grafana server queries the metrics from the Prometheus server using PromQL and displays the metrics and series in a visualization dashboard.
15
15
- Alerting
16
16
- Alerting rules are defined in the Prometheus server using PromQL expressions.
17
17
- When alert conditions are met, the Prometheus server fires alerts to the Alertmanager.
18
-
- The Alertmanager can potentially deduplicate, group, and route all the alerts and send notifications accordingly to various receivers like email, Slack, webhook, and such. In this sample, the Alertmanager simply sends notifications to a test webhook.
18
+
- The Alertmanager can potentially deduplicate, group, and route all the alerts and send notifications accordingly to various receivers, like email, Slack, webhook, and such. In this sample, the Alertmanager simply sends notifications to a test webhook.
19
19
20
20
## Prerequisites
21
21
- Have a running Kubernetes cluster version 1.10 or higher.
@@ -24,7 +24,7 @@ Here's how the WebLogic runtime metrics are generated, scraped, stored, and used
Copy file name to clipboardExpand all lines: samples/kubernetes/end2end/docs/01-pv-path.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
## Configuring the PV Path
2
-
In this sample, we need to create four Persistent Volumes (PV) and Persistent Volume Claims (PVC) to store data for MySQL, Prometheus server, Prometheus Alertmanager, and Grafana. See the YAML files for the four PVs/PVCs.
3
-
-[PV and PVC for MYSQL server](../mysql/persistence.yaml).
4
-
-[PV and PVC for Prometheus server](../prometheus/persistence.yaml).
5
-
-[PV and PVC for Prometheus Alertmanager](../prometheus/alert-persistence.yaml).
6
-
-[PV and PVC for Grafana server](../grafana/persistence.yaml).
2
+
In this sample, we need to create four Persistent Volumes (PV) and Persistent Volume Claims (PVC) to store data for MySQL, Prometheus server, Prometheus Alertmanager, and Grafana. See the following YAML files for the four PVs/PVCs:
3
+
-[PV and PVC for MYSQL server](../mysql/persistence.yaml)
4
+
-[PV and PVC for Prometheus server](../prometheus/persistence.yaml)
5
+
-[PV and PVC for Prometheus Alertmanager](../prometheus/alert-persistence.yaml)
6
+
-[PV and PVC for Grafana server](../grafana/persistence.yaml)
7
7
8
-
> **Note**: To simplify the configuration, we use `hostPath` PV that can work only in a single-node Kubernetes cluster; therefore, it's for demonstration purposes only. In a production environment, you would need to use a more sophisticated PV type like NFS, iSCSI. For detailed information, see the Kubernetes [Types of Persistent Volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#types-of-persistent-volumes) document.
8
+
> **Note**: To simplify the configuration, we use `hostPath` PV that works only in a single-node Kubernetes cluster; therefore, it's for demonstration purposes only. In a production environment, you would need to use a more sophisticated PV type like NFS, iSCSI. For detailed information, see the Kubernetes [Types of Persistent Volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#types-of-persistent-volumes) document.
9
9
10
10
To simplify the configuration and management, the four PVs will share the same root path. Prepare a host folder as the root path of the PVs.
11
11
@@ -15,7 +15,7 @@ mkdir <someDIR>
15
15
export PV_ROOT=<someDIR>
16
16
```
17
17
18
-
Then use the following commands to auto-update the path values in the PV and PVC YAML files.
18
+
Then use the following commands to auto-update the path values in the PV and PVC YAML files:
19
19
20
20
```
21
21
sed -i 's@%PV_ROOT%@'"$PV_ROOT"'@' mysql/persistence.yaml
Copy file name to clipboardExpand all lines: samples/kubernetes/end2end/docs/02-mysql.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
## Setting up MYSQL Server
2
2
3
-
In this step, we describe how to set up MySQL database in the Kubernetes cluster. In this sample, we are using the MySQL database to store application data. The WebLogic domain created in a later step will store its data in the database, for example, persistent JMS messages.
3
+
In this step, we describe how to set up MySQL database in the Kubernetes cluster. We are using the MySQL database to store application data. The WebLogic domain created in a later step, will store its data in the database, for example, persistent JMS messages.
4
4
5
5
Deploy the PV and PVC.
6
6
```
@@ -39,4 +39,4 @@ kubectl exec -it $POD_NAME -- mysql -u wluser1 -pwlpwd123 -D domain1 -e "show ta
39
39
```
40
40
Note that we have not created any user tables in the database. The purpose of running this query is to verify that the MySQL database has been created correctly.
41
41
42
-
Next: [Installing the WebLogic Kubernetes Operator](03-wls-operator.md)
42
+
Next: [Installing the WebLogic Server Kubernetes Operator](03-wls-operator.md)
Copy file name to clipboardExpand all lines: samples/kubernetes/end2end/docs/03-wls-operator.md
+9-10
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,15 @@
1
-
## Installing the WebLogic Kubernetes Operator
2
-
We depend on the [WebLogic Kubernetes Operator](https://github.com/oracle/weblogic-kubernetes-operator) to create and manage WebLogic domains. For detailed installation information, see [Install the Operator](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-operators/installation/).
1
+
## Installing the WebLogic Server Kubernetes Operator
2
+
We depend on the [WebLogic Server Kubernetes Operator](https://github.com/oracle/weblogic-kubernetes-operator) to create and manage WebLogic domains. For detailed installation information, see [Install the Operator](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-operators/installation/).
3
3
4
-
In this example, we provide the steps to install the 2.3.0 release of the WebLogic Kubernetes Operator.
4
+
In this example, we provide the steps to install the operator 2.3.0 release.
5
5
6
6
### Pulling the Images
7
-
We need two images, the WebLogic Kubernetes Operator image from [Docker Hub](https://hub.docker.com) and the WebLogic Server image from the [Oracle Container Registry](https://container-registry.oracle.com).
8
-
Before pulling the image, you must:
7
+
We need two images, the WebLogic Server Kubernetes Operator image from [Docker Hub](https://hub.docker.com) and the WebLogic Server image from the [Oracle Container Registry](https://container-registry.oracle.com). Before pulling the image, you must:
9
8
- Acquire a user account to the image sites.
10
9
If you do not already have Oracle Single Sign-On credentials, go to https://container-registry.oracle.com and create them by clicking the Sign In link at the top of the page.
11
10
- Log in to the site in your browser, find the image, and accept the license.
12
11
13
-
Pull the WebLogic Kubernetes Operator 2.3.0 image.
12
+
Pull the WebLogic Sever Kubernetes Operator 2.3.0 image.
@@ -87,8 +86,8 @@ Verify that the domain CRD version is correct.
87
86
```
88
87
kubectl get crd domains.weblogic.oracle -o jsonpath="{.spec.version}"
89
88
```
90
-
The expected version should be `v5`. Because the WebLogic operator is backward compatible, a domain resource with any version older than `v5` should be supported.
89
+
The expected version should be `v5`. Because the operator is backward compatible, a domain resource with any version older than `v5` should be supported.
91
90
92
-
Now the WebLogic Kubernetes Operator is running and it's monitoring the default namespace. Later we'll deploy a domain resource to the default namespace and the operator will be responsible for creating, running, and managing the WebLogic domain.
91
+
Now the WebLogic Server Kubernetes Operator is running and it's monitoring the default namespace. Later we'll deploy a domain resource to the default namespace and the operator will be responsible for creating, running, and managing the WebLogic domain.
93
92
94
93
Next: [Running a WebLogic Domain](04-wls-domain.md)
Copy file name to clipboardExpand all lines: samples/kubernetes/end2end/docs/04-wls-domain.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
## Running a WebLogic Domain
2
-
The WebLogic Kubernetes Operator has detailed documentation about creating domains, including important considerations and different options to consider. For more information, see the [Manage Domains](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/) guide. To integrate with Prometheus, the only extra step needed is to install the `wls-exporter` web application to WebLogic servers/clusters.
2
+
The WebLogic Server Kubernetes Operator has detailed documentation about creating domains, including important considerations and different options to consider. For more information, see [Manage WebLogic Domains](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/). To integrate with Prometheus, the only extra step needed is to install the `wls-exporter` web application to WebLogic Servers/clusters.
3
3
4
-
In this task, we provide scripts that create a demonstration domain.
4
+
In this step, we provide scripts that create a demonstration domain.
5
5
6
6
### Set Proxy Before Run
7
-
In the scripts below, we use `wget` to download the WebLogic Deploy Tool archive from GitHub. If you are behind a proxy, you need to configure the proxy settings properly. One approach is to use proxy variables:
7
+
In the following scripts, we use `wget` to download the WebLogic Deploy Tool archive from GitHub. If you are behind a proxy, you need to configure the proxy settings properly. One approach is to use proxy variables:
Copy file name to clipboardExpand all lines: samples/kubernetes/end2end/docs/07-webhook.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
## Setting up a Webhook
2
-
Let's set up a simple webhook as the notification receiver. The webhook is written in[a Python script](../webhook/scripts/server.py) which simply logs all the received notifications. Typically, webhook receivers are often used to notify systems that Alertmanager doesn’t support directly.
2
+
We will set up a simple webhook as the notification receiver. The webhook is written as[a Python script](../webhook/scripts/server.py) which simply logs all the received notifications. Typically, webhook receivers are often used to notify systems that Alertmanager doesn’t support directly.
0 commit comments