Skip to content
This repository was archived by the owner on Jan 6, 2023. It is now read-only.

Commit aaef5bd

Browse files
authored
Merge pull request #3 from oracle/rmarano
minor edits
2 parents 44b4c21 + 158f3ba commit aaef5bd

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ The goal of this project is to provide an easy to configure, robust, and product
44
WLS log information through Elasticsearch and Kibana.
55

66
The WebLogic Logging Exporter adds a log event handler to WebLogic Server,
7-
such that WebLogic server logs can be integrated into [Elastic Stack](https://www.elastic.co/products)
7+
such that WebLogic Server logs can be integrated into [Elastic Stack](https://www.elastic.co/products)
88
in Kubernetes directly, by using the [Elasticsearch](https://www.elastic.co/products/elasticsearch) REST API.
99

1010
The current version of the WebLogic Logging Exporter is 0.1, which was released on March 16, 2019.
1111
This version supports pushing logs into Elasticsearch using the REST API.
1212

1313
The following features are planned for the next few releases:
1414

15-
* Push logs into a fleuntd aggregator using the REST API,
15+
* Push logs into a fleuntd aggregator using the REST API.
1616
* Write logs in JSON format into the file system so that they could be collected and published by a
17-
sidecar, e.g. fluentd or Logstash,
17+
sidecar, e.g. fluentd or Logstash.
1818
* Provide the ability to publish other logs (i.e. other than the server logs).
1919

2020
## Contents
@@ -37,9 +37,9 @@ You can download the WebLogic Logging Exporter already compiled for you from the
3737
If you prefer, you can build the WebLogic Logging Exporter from the source code. To do this, you will
3838
need access to some WebLogic Server libraries. There are two ways to get these libraries:
3939

40-
* Populate you local Maven repository with the required files from a local WebLogic Server installation
40+
* Populate your local Maven repository with the required files from a local WebLogic Server installation
4141
using the Oracle Maven Synchronization plugin, or
42-
* Use the Oracle Maven repository to download them as part of your build, this requires registration and
42+
* Use the Oracle Maven repository to download them as part of your build; this requires registration and
4343
configuring your local Maven installation with the appropriate authentication details.
4444

4545
### Populating your local Maven repository from a local WebLogic Server installation
@@ -49,13 +49,13 @@ to install the necessary dependencies into your local Maven repository.
4949

5050
There are two steps:
5151

52-
* Install the Oracle Maven Synchronization plugin,
53-
* Run the "push" goal to populate your local Maven repository from your WebLogic Server installation.
52+
* Install the Oracle Maven Synchronization plugin.
53+
* Run the `push` goal to populate your local Maven repository from your WebLogic Server installation.
5454

5555
#### Installing the Oracle Maven Synchronization plugin
5656

57-
To install the plugin, navigate to your WebLogic Server installation then enter the commands (this example
58-
assumes you installed WebLogic Server in /u01/wlshome):
57+
To install the plugin, navigate to your WebLogic Server installation, then enter the commands (this example
58+
assumes you installed WebLogic Server in `/u01/wlshome`):
5959

6060
```
6161
cd /u01/wlshome/oracle_common/plugins/maven/com/oracle/12.2.1/oracle-maven-sync
@@ -76,7 +76,7 @@ normally located at `~/.m2/repository/com/oracle/weblogic`.
7676

7777
### Using the Oracle Maven repository
7878

79-
Note: If you populated your local repository using the Oracle Maven Synchronization plugin, then this
79+
**Note**: If you populated your local repository using the Oracle Maven Synchronization plugin, then this
8080
step is *not* required.
8181

8282
To access the Oracle Maven repository, refer to the documentation
@@ -104,8 +104,8 @@ This section outlines the steps that are required to add the Weblogic Logging Ex
104104

105105
1. Add a startup class to your domain configuration.
106106

107-
* In the administration console, navigate to "Environment" then "Startup and Shutdown classes" in the main menu.
108-
* Add a new Startup class, you may choose any descriptive name, and the class name must be
107+
* In the Administration Console, navigate to "Environment" then "Startup and Shutdown classes" in the main menu.
108+
* Add a new Startup class. You may choose any descriptive name and the class name must be
109109
`weblogic.logging.exporter.Startup`.
110110
* Target the startup class to each server that you want to export logs from.
111111

@@ -163,14 +163,14 @@ This section outlines the steps that are required to add the Weblogic Logging Ex
163163
164164
1. Restart the servers to activate the changes. After restarting the servers, they will load the WebLogic
165165
Logging Exporter and start sending their logs to the specified Elasticsearch instance. You can then
166-
access them in Kibana as shown in the example below, you will need to create an index first and then go to
166+
access them in Kibana as shown in the example below. You will need to create an index first and then go to
167167
the visualization page.
168168
169169
![Kibana screenshot](images/screenshot.png)
170170
171171
172172
You can also use a curl command similar to the following example to verify that logs have been posted to Elasticsearch.
173-
The default index name is "wls", and docs.count should be greater than zero indicating that log entries
173+
The default index name is `wls`, and `docs.count` should be greater than zero indicating that log entries
174174
are being sent to Elasticsearch.
175175
176176
```

0 commit comments

Comments
 (0)