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
The WebLogic Monitoring Exporter uses the [WLS RESTful Management API](https://docs.oracle.com/middleware/1221/wls/WLRUR/overview.htm#WLRUR111) to scrape runtime information and then exports [Prometheus](http://prometheus.io)-compatible metrics.
7
-
It is available both as a [web application](#web-application) to be deployed to the WebLogic Server (WLS) instance, version 12.2.1 or later, from which you want to get metrics,
8
-
and also as a [sidecar](#sidecar), which runs as its own process, and which is configured to contact a WLS instance.
6
+
The WebLogic Monitoring Exporter is a [Prometheus](http://prometheus.io)-compatible exporter of metrics from
7
+
WebLogic Server (WLS) instances, which it obtains by using the
8
+
[WLS RESTful Management API](https://docs.oracle.com/middleware/12213/wls/WLRUR/overview.htm#WLRUR111), available in version 12.2.1 or later.
9
+
Metrics are selected using a [YAML configuration file](#Configuration).
10
+
11
+
The exporter is available in two forms:
12
+
- A [web application](#web-application) that you deploy to the server from which metrics are to be extracted.
13
+
You may include a configuration file directly in the WAR file, and you may temporarily modify the configuration in a
14
+
running system by using a web form. If a [coordination configurator](config_coordinator/README.md) is running and configured,
15
+
that temporary configuration will be sent to all servers configured to use it.
16
+
17
+
- A [separate process](#sidecar) that is run alongside a server instance. You supply the configuration to such a
18
+
process with a PUT command, as described below. The [WebLogic Server Kubernetes Operator](https://github.com/oracle/weblogic-kubernetes-operator/) has special support for the exporter in this form.
19
+
9
20
10
21
## Configuration
11
22
Here is an example `yaml` file configuration:
@@ -36,14 +47,14 @@ Note that there are two parts to the configuration. The optional top portion def
36
47
37
48
| Name | Description |
38
49
| --- | --- |
39
-
|`query_sync`| Optional. Configuration for a [service](config_coordinator/README.md) which coordinates updates to the query configuration. |
50
+
|`query_sync`| Optional, used in the web application only. Configuration for a [service](config_coordinator/README.md) which coordinates updates to the query configuration. |
40
51
|`query_sync.url`| The URL of the service. Required if this section is present. |
41
52
|`query_sync.interval`| The interval, in seconds, at which the service will be queried. Defaults to 10. |
42
53
|`metricsNameSnakeCase`| If true, metrics names will be converted to snake case. Defaults to false. |
43
54
|`domainQualifier`| If true, the domain name will be included as a qualifier for all metrics. Defaults to false. |
44
-
|`restPort`| Optional. Overrides the port on which the exporter should contact the REST API. Needed if the exporter cannot find the REST API. |
55
+
|`restPort`| Optional, used in the web application only. Overrides the port on which the exporter should contact the REST API. Needed if the exporter cannot find the REST API. The most common case is running on a system with the administration port enabled. In that case, you must specify the administration port in this field and access the exporter by using the SSL port. |
45
56
46
-
The `query` field is more complex. Each query consists of a hierarchy of the [MBeans](https://docs.oracle.com/middleware/1221/wls/WLMBR/core/index.html), starting relative to `ServerRuntimes`.
57
+
The `query` field is more complex. Each query consists of a hierarchy of the [MBeans](https://docs.oracle.com/middleware/12213/wls/WLMBR/core/index.html), starting relative to `ServerRuntimes`.
47
58
Within each section, there are a number of options:
48
59
49
60
| Name | Description |
@@ -147,8 +158,7 @@ the version number to simplify deployment to WebLogic Server.
147
158
148
159
# Sidecar
149
160
150
-
The sidecar is a standalone process that runs the exporter. It is primarily intended for use by the
151
-
[WebLogic Server Kubernetes Operator](https://github.com/oracle/weblogic-kubernetes-operator/).
161
+
The sidecar is a standalone process that runs the exporter.
152
162
153
163
## Build and run with Maven
154
164
@@ -175,9 +185,8 @@ Use https | `false` | `WLS_SECURE`
175
185
176
186
## Configure the exporter
177
187
178
-
The sidecar does not have a landing page. Configuration is done by sending a PUT request to the path `/configuration`.
179
-
You can do this with `curl`; when used with the [operator](https://github.com/oracle/weblogic-kubernetes-operator/),
180
-
the operator will automatically configure the exporter.
188
+
You configure the sidecar by sending a PUT request to the path `/configuration`.
189
+
You can do this with `curl`; that is how the operator does it.
0 commit comments