Table of Contents | ||||||
---|---|---|---|---|---|---|
|
Introduction
The tags beginning with web.
...
jboss
identify
...
events generated by the WildFly Web Server (formerly JBoss web application server
...
This article describes the tag naming structure, a little about logging in JBoss v7, and how to send log events from the JBoss server to Devo using rsyslog.
...
) belonging to Red Hat.
Valid tags and data tables
The full tag must have at least six 3 levels. The first two are fixed as asweb.jboss
. The and the third level identifies the log type /format and currently must be one of boot, access-clf, access-combined, access-lt, or server.
The fourth, fifth and sixth levels are required and should identify the environment type, web application, and instance respectively.
- environment - Describes the environment in when the event occurred. For example, development, testing, or production.
- web application - The name of the web application.
- clon - This is the instance that generated the event. Depending on your network, this can be a machine name, or the virtual name of a JBoss process.
The values of these levels should be guided by the structure we propose because they will be saved in the events when saved in Devo. When you open the resulting data table, these will appear in the environment, site and clon columns.
...
Technology
...
Brand
...
Log type/format
...
Environment
...
Web application
...
Clon
...
- boot
access-clf
access-combined
access-lt
- server
free but required
...
Therefore, the valid tags include:
...
of events sent.
These are the valid tags and corresponding data tables that will receive the parsers' data:
Product / Service | Tags | Data tables |
---|---|---|
WildFly Web Server (formerly JBoss web application server) |
|
|
|
| |
|
| |
|
| |
|
|
For more information, read more about Devo tags.
JBoss logs
Server.log and boot.log
For general information about these log files and their default directories, see the JBoss Documentation.
You should review the configuration for the generation of boot.log and modify it as needed. You want to ensure it is generated using the default PATTERN formatter and that it is written in append mode. The configuration file is usually found in standalone/configuration/logging.properties or domain/configuration/logging.properties depending on if the server is started in managed domain or standalone server mode.
These are the lines you should review and edit as needed:
Code Block | ||
---|---|---|
| ||
# File handler configuration
handler.FILE=org.jboss.logmanager.handlers.FileHandler
handler.FILE.level=DEBUG
handler.FILE.properties=autoFlush,append,fileName
handler.FILE.autoFlush=true
handler.FILE.append=true
handler.FILE.fileName=${org.jboss.boot.log.file:boot.log}
handler.FILE.formatter=PATTERN |
Expand | ||
---|---|---|
| ||
Access logs (access_log.yyyy-MM-dd)JBoss v7 access log files are identical to those of the Apache Tomcat application server but you can control the actual event content in terms of format and fields included. The access log is not enabled by default so you need to edit the urn:jboss:domain:web:1.1 subsystem inthe standalone/configuration/standalone.xml file to add the access-log definition as in this example: |
...
Code Block | ||
---|---|---|
JBoss 7.x access-log configuration:
Devo supports three formats for access logs; two of them are based upon standard formats and the other is defined by Devo to offer a format that contains more details. Each of these formats corresponds with the third level of an access log tag.
|
...
|
...
|
...
|
...
Server.log and boot.logFor general information about these log files and their default directories, see the WildFly Documentation. You should review the configuration for the generation of boot.log and modify it as needed. You want to ensure it is generated using the default PATTERN formatter and that it is written in append mode. The configuration file is usually found in standalone/configuration/logging.properties or domain/configuration/logging.properties depending on if the server is started in managed domain or standalone server mode. These lines below are those you should review and edit as needed. boot.log JBoss 7.x configuration:
|
Sending to Devo using file monitoring
...
|
Table structure
These are the fields displayed in these tables:
web.jboss.accessClf
Field | Type | Source field name | Extra fields |
---|---|---|---|
eventdate |
|
| |
environment |
| venv | |
application |
| vapp | |
clon |
| vclon | |
serverdate |
|
| |
srcIp |
|
| |
user |
|
| |
method |
|
| |
url |
|
| |
protocol |
|
| |
statusCode |
|
| |
responseLength |
|
| |
srcIdentd |
|
| |
hostchain |
|
| ✓ |
tag |
|
| ✓ |
rawMessage |
|
| ✓ |
web.jboss.accessCombined
Field | Type | Source field name | Extra fields |
---|---|---|---|
eventdate |
|
| |
environment |
| venv | |
application |
| vapp | |
clon |
| vclon | |
serverdate |
|
| |
srcIp |
|
| |
user |
|
| |
method |
|
| |
url |
|
| |
protocol |
|
| |
statusCode |
|
| |
responseLength |
|
| |
referer |
|
| |
userAgent |
|
| |
srcIdentd |
|
| |
hostchain |
|
| ✓ |
tag |
|
| ✓ |
web.jboss.accessLt
Field | Type | Source field name | Extra Label |
---|---|---|---|
eventdate |
|
| |
environment |
| venv | |
application |
| vapp | |
clon |
| vclon | |
serverdate |
|
| |
srcIp |
|
| |
serverName |
|
| |
serverPort |
|
| |
user |
|
| |
sessionId |
|
| |
method |
|
| |
url |
|
| |
protocol |
|
| |
statusCode |
|
| |
referer |
|
| |
userAgent |
|
| |
cookies |
|
| |
responseTime |
|
| |
requestLength |
|
| |
threadName |
|
| |
srcIdentd |
|
| |
hostchain |
|
| ✓ |
tag |
|
| ✓ |
web.jboss.boot
Field | Type | Source field name | Extra fields |
---|---|---|---|
eventdate |
|
| |
environment |
| venv | |
application |
| vapp | |
clon |
| vclon | |
message |
|
| |
hostchain |
|
| ✓ |
tag |
|
| ✓ |
web.jboss.server
Field | Type | Source field name | Extra fields |
---|---|---|---|
eventdate |
|
| |
environment |
| venv | |
application |
| vapp | |
clon |
| vclon | |
message |
|
| |
hostchain |
|
| ✓ |
tag |
|
| ✓ |
How is the data sent to Devo?
To send data to Devo, you con use file monitor as shown below.
File monitor using rsyslog in Unix-like environments
You can read more about using rsyslog to monitor and send files to a Devo endpoint in the Sending data to Devo section of our documentation. here. These are the different aspects to consider:
Rw ui steps macro | ||||
---|---|---|---|---|
/etc/rsyslog.d/45-jboss.conf file: Here we offer a sample rsyslog configuration file that is set up to monitor the server and boot logs and one access log, and forward them to a Devo Relay.
| ||||
/etc/rsyslog.d/45-jboss.conf file |
Note the following placeholder values and other values that allow modification or required configuration in the sample file above:
|
...
/etc/logrotate.d/jboss.conf: To configure file rotation, you can use the logrotate utility. The following in an example of a jboss.conf might be set up.
| ||||||
title | /etc/logrotate.d/jboss.conf
Restart rsyslog process: When you have made all the configuration changes necessary, don't forget to restart the rsyslog process:
|
---|
Related articles
...