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

Commit 3d2fe0d

Browse files
Merge pull request #1 from oracle/rmarano
review and edit
2 parents 66a71c8 + 2288334 commit 3d2fe0d

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

README.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,49 @@
1-
# Weblogic Logging Exporter
1+
# WebLogic Logging Exporter
22

3-
An exporter that adds a log event handler to the weblogic server, such that WLS server Logs can be integrated to [Elastic Stack](https://www.elastic.co/products) in Kubernetes directly, by using the REST API in [Elasticsearch](https://www.elastic.co/products/elasticsearch).
3+
The WebLogic Logging Exporter (the "logging exporter") adds a log event handler to WebLogic Server, such that WLS server logs can be integrated into [Elastic Stack](https://www.elastic.co/products) in Kubernetes directly, by using the [Elasticsearch](https://www.elastic.co/products/elasticsearch) REST API.
44

5-
The blog [Let WebLogic work with Elastic Stack in Kubernetes](https://blogs.oracle.com/weblogicserver/let-weblogic-work-with-elk-in-kubernetes) outlines steps that can be used to harvest WLS server logs using Logstash so that they can be filtered, manipulated, and viewed using Elasticsearch and Kibana.
6-
However, that approach requires the setup of a shared volume which is outside of the pod, and the logs needs to be written out to an intermediate log file for harvesting and parsing.
5+
The blog, [Let WebLogic work with Elastic Stack in Kubernetes](https://blogs.oracle.com/weblogicserver/let-weblogic-work-with-elk-in-kubernetes), outlines the steps to harvest WLS server logs using Logstash so that they can be filtered, manipulated, and viewed using Elasticsearch and Kibana.
6+
However, that approach requires the setup of a shared volume which is outside of the pod, and the logs needs to be written to an intermediate log file for harvesting and parsing.
77

8-
The goal of this project is to provide an easy to configure, robust and production ready solution to access WLS log information through Elasticsearch and Kibana.
8+
The goal of this project is to provide an easy to configure, robust, and production-ready solution to access WLS log information through Elasticsearch and Kibana.
99

1010
## Getting Started
1111

12-
These instructions outlines the steps to build the _weblogic-logging-exporter.jar_ , which can then be integrated to the [Weblogic Kubernetes Operator](https://github.com/oracle/weblogic-kubernetes-operator/) for handling the Server logs generated by the Weblogic Server Domain.
12+
These instructions outline the steps to build the `weblogic-logging-exporter.jar` file, which can then be integrated into the [WebLogic Kubernetes Operator](https://github.com/oracle/weblogic-kubernetes-operator/) for handling the server logs generated by the WebLogic Server domain.
1313

14-
### Prerequisites
14+
## Prerequisites
1515

16-
Weblogic Logging Exporter depends on the Weblogic Logging Jar which is available from the [ Oracle Maven Repository](http://maven.oracle.com/).
16+
The logging exporter depends on the WebLogic logging JAR which is available from the [ Oracle Maven Repository](http://maven.oracle.com/).
1717

1818
To access the Oracle Maven Repository, there are two fundamental requirements to be aware of:
1919

20-
1. You must be using [Maven 3.2.5](http://maven.apache.org/docs/3.2.5/release-notes.html) or later. This contains the version of the component [Wagon 2.8](http://maven.apache.org/wagon/) that has been enhanced to support access to artifacts that are protected by [HTTP authentication schemes](https://issues.apache.org/jira/projects/WAGON/issues/WAGON-422).
20+
1. You must be using [Maven 3.2.5](http://maven.apache.org/docs/3.2.5/release-notes.html) or later. This contains the version of the [Wagon 2.8](http://maven.apache.org/wagon/) component that has been enhanced to support access to artifacts that are protected by [HTTP authentication schemes](https://issues.apache.org/jira/projects/WAGON/issues/WAGON-422).
2121

22-
2. You must be registered with OTN and have accepted the agreement to access and use the Oracle Maven Repository. This can be done with either a new or an existing OTN user account by accessing the http://maven.oracle.com site and clicking the registration link.
23-
Once registered, you then just need to configure your local Maven environment with the details of the Oracle Maven Repository, including information that relates to the authentication model specifying your OTN username and password.
22+
2. You must be registered with OTN and have accepted the license agreement to access and use the Oracle Maven Repository. This can be done with either a new or an existing OTN user account by accessing the http://maven.oracle.com site and selecting the registration link.
23+
After registering, then you just need to configure your local Maven environment with the details of the Oracle Maven Repository, including the information that relates to the authentication model specifying your OTN user name and password.
2424

25-
### Building
26-
#### Configure Maven
25+
## Building
26+
### Configure Maven
2727

28-
**1. Encrypt your OTN Password**
28+
#### 1. Encrypt your OTN Password.
2929

3030
You need to configure Maven to use the Oracle Maven Repository. This involves telling Maven about the repository and providing the necessary information to authenticate to the repository.
31-
The following steps shows you how to save your OTN password in your _settings.xml_ file so that you do not have to specify them manually every time.
31+
The following steps show you how to save your OTN password in your `settings.xml` file so that you do not have to specify it manually every time.
3232
Oracle recommends that you encrypt your password, using the utilities provided with Maven.
3333

34-
Here is the steps to encrypt your password and save that in your settings. Refer to [Maven Password Encryption](http://maven.apache.org/guides/mini/guide-encryption.html) for more information.
34+
Here are the steps to encrypt your password and save it in your settings. For more information, refer to [Maven Password Encryption](http://maven.apache.org/guides/mini/guide-encryption.html).
3535

3636
```
3737
mvn --encrypt-master-password my_master_password
3838
3939
```
4040
The output will be a string similar to this:
4141

42-
_{abcdefghijklmnopqrstuvwxyz123=}_
42+
`{abcdefghijklmnopqrstuvwxyz123=}`
4343

44-
Save this value in your Maven _settings-security.xml_ file
44+
Save this value in your Maven `settings-security.xml` file.
4545

46-
A copy of your _~/.m2/settings-security.xml_ will look like this
46+
A copy of your `~/.m2/settings-security.xml` file will look like this:
4747
```
4848
<settingsSecurity>
4949
<master>{abcdefghijklmnopqrstuvwxyz123=}</master>
@@ -56,15 +56,15 @@ mvn --encrypt-password my_OTN_password
5656
```
5757
The output will be another string that looks like this:
5858

59-
_{==thisIs12My34_OTN_45_encrypted==}_
59+
`{==thisIs12My34_OTN_45_encrypted==}`
6060

61-
This will be the password that you provide in the _server_ section of your _settings.xml_ file when you configure the HTTP Wagon.
61+
This will be the password that you provide in the `server` section of your `settings.xml` file when you configure the HTTP Wagon.
6262

63-
**2. Adding the Oracle Maven Repository to Your settings.xml**
63+
#### 2. Add the Oracle Maven Repository to your `settings.xml` file.
6464

65-
Add a repository definition to your Maven settings.xml file. The repository definition should look like the following:
65+
Add a repository definition to your Maven `settings.xml` file. The repository definition should look like the following:
6666

67-
```
67+
```
6868
<profiles>
6969
<profile>
7070
<id>main</id>
@@ -92,8 +92,8 @@ Add a repository definition to your Maven settings.xml file. The repository defi
9292
</profiles>
9393
```
9494

95-
The Maven settings.xml requires additional settings to support the Oracle Maven Repository.
96-
Add the following _<server>_ element to the _<servers>_ section of the Maven settings.xml to configure the HTTP Wagon.
95+
The Maven `settings.xml` file requires additional settings to support the Oracle Maven Repository.
96+
To configure the HTTP Wagon, add the following `<server>` element to the `<servers>` section of the Maven `settings.xml` file.
9797
```
9898
<servers>
9999
<server>
@@ -121,19 +121,19 @@ Add the following _<server>_ element to the _<servers>_ section of the Maven set
121121
</servers>
122122
```
123123

124-
If needed, you will need to specify the _proxies_ that is required.
124+
If needed, specify the `proxies` that are required.
125125

126-
**3. Clone the project and build**
126+
#### 3. Clone the project and build it.
127127
```
128128
git clone git@orahub.oraclecorp.com:derek.sharpe/wls-logging-exporter.git
129129
mvn install
130130
```
131131

132-
The _weblogic-logging-exporter-1.0-SNAPSHOT.jar_ should be available under _target_ directory
132+
The `weblogic-logging-exporter-1.0-SNAPSHOT.jar` will be available under the `target` directory.
133133

134134
## Deployment
135135

136-
TBD. Update on how to integrate this jar to weblogic kubernetes operator.
136+
TBD. Update how to integrate this JAR into WebLogic Kubernetes operator.
137137

138138
## Contributing
139139

0 commit comments

Comments
 (0)