Skip to content

Commit

Permalink
Improve docs (#144)
Browse files Browse the repository at this point in the history
* Improve docs

* Respond to review comments

* more review comments
  • Loading branch information
russgold authored Mar 12, 2021
1 parent 4d5fc9b commit 0ccee4a
Showing 1 changed file with 20 additions and 11 deletions.
31 changes: 20 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,20 @@ WebLogic Monitoring Exporter

[![Build Status](https://travis-ci.org/oracle/weblogic-monitoring-exporter.svg?branch=master)](https://travis-ci.org/oracle/weblogic-monitoring-exporter)

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.
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,
and also as a [sidecar](#sidecar), which runs as its own process, and which is configured to contact a WLS instance.
The WebLogic Monitoring Exporter is a [Prometheus](http://prometheus.io)-compatible exporter of metrics from
WebLogic Server (WLS) instances, which it obtains by using the
[WLS RESTful Management API](https://docs.oracle.com/middleware/12213/wls/WLRUR/overview.htm#WLRUR111), available in version 12.2.1 or later.
Metrics are selected using a [YAML configuration file](#Configuration).

The exporter is available in two forms:
- A [web application](#web-application) that you deploy to the server from which metrics are to be extracted.
You may include a configuration file directly in the WAR file, and you may temporarily modify the configuration in a
running system by using a web form. If a [coordination configurator](config_coordinator/README.md) is running and configured,
that temporary configuration will be sent to all servers configured to use it.

- A [separate process](#sidecar) that is run alongside a server instance. You supply the configuration to such a
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.


## Configuration
Here is an example `yaml` file configuration:
Expand Down Expand Up @@ -36,14 +47,14 @@ Note that there are two parts to the configuration. The optional top portion def

| Name | Description |
| --- | --- |
| `query_sync` | Optional. Configuration for a [service](config_coordinator/README.md) which coordinates updates to the query configuration. |
| `query_sync` | Optional, used in the web application only. Configuration for a [service](config_coordinator/README.md) which coordinates updates to the query configuration. |
| `query_sync.url` | The URL of the service. Required if this section is present. |
| `query_sync.interval` | The interval, in seconds, at which the service will be queried. Defaults to 10. |
| `metricsNameSnakeCase` | If true, metrics names will be converted to snake case. Defaults to false. |
| `domainQualifier` | If true, the domain name will be included as a qualifier for all metrics. Defaults to false. |
| `restPort` | Optional. Overrides the port on which the exporter should contact the REST API. Needed if the exporter cannot find the REST API. |
| `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. |

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`.
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`.
Within each section, there are a number of options:

| Name | Description |
Expand Down Expand Up @@ -147,8 +158,7 @@ the version number to simplify deployment to WebLogic Server.

# Sidecar

The sidecar is a standalone process that runs the exporter. It is primarily intended for use by the
[WebLogic Server Kubernetes Operator](https://github.com/oracle/weblogic-kubernetes-operator/).
The sidecar is a standalone process that runs the exporter.

## Build and run with Maven

Expand All @@ -175,9 +185,8 @@ Use https | `false` | `WLS_SECURE`

## Configure the exporter

The sidecar does not have a landing page. Configuration is done by sending a PUT request to the path `/configuration`.
You can do this with `curl`; when used with the [operator](https://github.com/oracle/weblogic-kubernetes-operator/),
the operator will automatically configure the exporter.
You configure the sidecar by sending a PUT request to the path `/configuration`.
You can do this with `curl`; that is how the operator does it.

```
curl -X PUT -i -u myname:mypassword \
Expand Down

0 comments on commit 0ccee4a

Please sign in to comment.