What information do I supply when opening a Middleware support case?
When opening a case with JBoss Middleware Support, it is not known what information the support engineers will need to diagnose the issue. As a result, the first response from JBoss Support is often a request for additional information. This results in an initial delay to resolving the issue.
Assumptions
You are opening a JBoss Middleware support case in the Red Hat Customer Portal.
Solution
Technology specific information to supply when opening a JBoss support case.
- Apache HTTPD Server
- JBoss HTTP Connector
- Apache Tomcat Connectors
- Apache Tomcat
- Java Virtual Machine (JVM)
- JBoss Enterprise Application Platform (EAP)
- JBoss Portal
- JBoss Fuse Service Works (FSW)
- JBoss Fuse 6.*
- JBoss A-MQ 6.*
- JBoss Data Services (EDS 5) and JBoss Data Virtualization (DV 6)
- Red Hat MRG Messaging (MRG-M)
- BRMS 6.0.*
- BPM Suite 6.0.*
- JBoss Operations Network (JBoss ON)
- Red Hat JBoss Developer Studio 8.0.0
Apache HTTPD Server
Files:
/etc/httpd/conf/*.conf/etc/httpd/conf.d/*.conf- httpd access and error logging from relevant hosts
/etc/sysconfig/httpd
Information:
- Output from running
httpd -Von Apache. For example:httpd -V > httpd.out. Note the capital "V". A small "v" will not produced the desired output.
JBoss HTTP Connector (mod_cluster)
- Files from Apache HTTPD Server section (Include conf.d/JBoss_HTTP.conf or similar)
- Files from JBoss EAP section
Apache Tomcat Connectors (mod_jk)
Files:
boot.loghttpd.confworkers.propertiesmod_jk.confmod_jk.logJBOSS_HOME/server/SERVERCONF/deploy/JBOSSWEB/server.xmlJBOSS_HOME/server/SERVERCONF/deploy/JBOSSWEB/META-INF/jboss-service.xml/etc/sysconfig/httpd(RHEL)
Information:
-
Output from running
httpd -Von Apache. For example:httpd -V > httpd.out. Note the capital "V". A small "v" will not produced the desired output. -
Output from running the ldd command on the mod_jk binary. For example:
ldd mod_jk.so. -
How many CPUs and RAM does the JBoss box have?
-
Are the JBoss instances collocated or on dedicated boxes?
-
Is there a firewall between Apache and JBoss?
-
Where was the mod_jk binary obtained (e.g. downloaded from apache.org, compiled in house, from OS vendor, etc.)?
-
What version of mod_jk are you using? If not sure, run the following command:
strings mod_jk.so | grep mod_jk/ -
Exact version of JBoss.
Apache Tomcat
Files:
server.confcatalina.out- application
web.xml
Information:
- Exact version of Tomcat.
- Exact OS and version.
Java Virtual Machine (JVM)
Files:
boot.log- GC logging
run.conf,run.bat, or wherever JVM options are defined.
Information:
- Exact OS and version.
- Exact JVM and version.
JBoss Enterprise Application Platform (EAP)
Files:
boot.logserver.log
Information:
- Exact version of JBoss.
- Exact OS and version.
- Is it a single node, or multiple clustered nodes?
- List application deployables (jar/war/ear/sar) and where they are deployed.
On JBoss EAP 6.x run the 'JBoss Diagnostics Reporter' JDR
See https://access.redhat.com/solutions/221103
JBoss Portal
Files:
boot.logserver.logportlet.xmljboss-portlet.xml
Information:
- Exact OS and version.
- Is it a single portal node, or multiple clustered nodes?
JBoss Fuse Service Works (FSW)
- As FSW is based on either EAP or Fuse, supply the same artifacts these would require.
- Note that in some cases, a combination of artifacts may be best (i.e. if running Camel on EAP, then artifacts of both types)
JBoss Fuse 6.*
Files:
$data/log/fuse.log*
Where $data is the default value of the KARAF_DATA environment variable which is your ./data directory in your installation.
Information:
- Exact version of JBoss Fuse with patches
- Are the containers deployed in a Fabric?
-
Exact version of Java, as reported by
java -version -
Application spring configuration, or Blueprint configuration file (located in META-INF/spring/.xmllocated or in OSGI-INF/blueprint/.xml)
Camel
-
debug logging - enable debug logging by changing the
etc/org.ops4j.pax.loggingfile,log4j.rootLoggerproperty to DEBUG -
It can be helpful to enable the tracer on camel routes (trace="true" on the camel context). You may also do this dynamically through the route MBean operation using JConsole or Hawtio.
-
Full camel route definitions
-
Any relevant camel processor code
-
If project is maven based, the complete project if it is small or at least pom file.
-
If the route had been previously working, a thorough description of when the problem arose, system related activities and what changes may have been made around that time.
Bundle related issues
- Increase the logging level according, set DEBUG in the Karaf console will be suitable
- Identify the bundle ID using the osgi:list command and attach the output.
- Execute the command "headers
" and capture the output. Note items in red as these are missing dependencies.
Security related issues
- Capture the output of jaas:realms
- If you have configured an alternative security system as LDAP, please provide details of that system and the corresponding configuration file.
- Increase the logging level to DEBUG from karaf console
- If LDAP is deployed, use the debug=true in the module definition
Fabric
-
Provide the output of the fabric:container-list command.
-
Provide the output of fabric:ensemble-list
-
Identify which container is problematic and when the issue started.
-
Maximize the logging to DEBUG via etc/org.ops4j.pax.logging file.
-
If the issue is specific to one profile, provide the out of the fabric:profile-display command
-
If a specific application is at hand, please provide the corresponding application.
-
Please provide the contents of the etc/org.ops4j.pax.url.mvn.cfg if a maven related issue occurs.
-
Provide the output of config:list from the affected container.
-
$data/log/karaf.log*from each container in the fabric.
Where $data is the default value of the KARAF_DATA environment variable which is your ./data directory in your installation.
JBoss A-MQ 6.*
Files:
data/log/amq.log*etc/activemq.xml
Where data is the default value of the KARAF_DATA environment variable. By default this is the
Information:
-
Exact version of JBoss A-MQ
-
Exact version of Java, as reported by
java -version -
For stuck or missing messages attach the output of the
activemq:bstatcommand -
For message store issues, a backup of the message store (e.g. kahadb)
-
For out of memory issues - a heap dump
-
For performance issues - capture multiple (e.g. 3) thread dumps spaced every 20 seconds in combination with GC logging.
-
Screen shots of broker stats
-
Screen shot of the JMX stats for the destination in question
-
For failover issues turn on
org.apache.activemq.transportlogging
JBoss Data Services (EDS 5) and JBoss Data Virtualization (DV 6)
Files:
boot.logserver.logteiid-command.logxxx-vdb.xmlxxx.vdbxxx-ds.xml$JBOSS_HOME/server/$PROFILE/deploy/teiid/teiid-jboss-beans.xml(EDS 5 only)- Configuration file
standalone.xml or domain.xml(DV 6 only)
For DV 6 also refer to:
TRACE logging for Data Virtualization
How do I generate a Query Plan in EDS and JDV?
Information:
- Exact version of EDS or DV
- Exact OS and version.
-
Exact JBDS and Teiid Designer version.
-
JBDS version - Run JBDS -> Help -> About JBoss Developer Studio
-
Teiid Designer version - Run JBDS -> Help -> About JBoss Developer Studio -> Installation Details -> Installed Software -> Teiid Designer
-
-
If you provide the
teiid-command.log, we can check calling query from clients.- You have to uncomment following
jboss-log4j.xmlconfiguration.
<!-- un-comment to enable Teiid COMMAND log, NOTE: if there are categories above this appender, this will need to be moved above the categories in order for this appender to work. <appender name="COMMAND" class="org.jboss.logging.appender.RollingFileAppender"> <param name="File" value="${jboss.server.log.dir}/teiid-command.log"/> <param name="MaxFileSize" value="1000KB"/> <param name="MaxBackupIndex" value="25"/> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%d %-5p [%c] (%t:%x) %m%n"/> </layout> </appender> --> <!-- un-comment to enable COMMAND log - also needs the COMMAND appender to be uncommented <category name="org.teiid.COMMAND_LOG" additivity="false"> <priority value="DEBUG"/> <appender-ref ref="COMMAND"/> </category> --> - You have to uncomment following
-
If you provide following files under the
$PROFILE/deploydirectory, we can check your EDS application detail.-
xxx-vdb.xmlfile - If you deployed dynamic VDB -
xxx.vdbfile - If you deployed VDB which is created JBDS
-
-
If you provide
xxx-ds.xml, we will confirm data source configuration for your EDS application
Red Hat MRG Messaging (MRG-M)
Follow this solution (basically, provide sosreport and qpidd broker logs).
To run sosreport the sos package must be installed. If for any reason the package is not present, please follow the steps in this article to install it: What is a sosreport and how do I create one
BRMS 6.0.*
Information:
Issues about runtime rules not firing or wrong order:
-
Exact version of BRMS
-
Is the latest roll up patch applyed ?
-
Rule files (DRL, Guided Decision Tables, JCR export (version 5 only), git repository (version 6 only))
-
Knowledge Runtime logger: How to enable runtime logging in BRMS and BPM Suite?
-
Fact model used (model jars)
-
kmodule.xml
-
Reproducer (when possible)
Issues about Business Central editors:
-
Application Server log (e.g. server.log for EAP)
-
Screenshots
-
Browser used
-
Application server where it is deployed
-
Rule files (DRL, Guided Decision Tables, JCR export (version 5 only), git repository (version 6 only))
BPM Suite 6.0.*
Information:
Issues about runtime process execution:
-
Exact version of BPM Suite
-
Is the latest roll up patch applyed ?
-
Database used
-
Application Server log (e.g. server.log for EAP)
-
Is the process executed by Kie Remote APIs (Rest, JMS) or wrapping the jBPM API directly ?
-
Is spring being used ? If yes, provide spring beans file
-
Process Files (.bpmn2, custom domain workitems if used, JCR export (version 5 only), git repository (version 6 only))
-
Fact model used (model jars)
-
kmodule.xml
-
Reproducer (when possible)
Issues about Business Central editors:
- Application Server log (e.g. server.log for EAP)
- Screenshots
- Browser used
- Application server where it is deployed
- Rule and Process files (.bpmn2, DRLs, repository exports, etc)
JBoss Operations Network (JBoss ON)
Files:
server.logagent.logrhq-server.properties
Information:
- Exact version of JBoss ON.
- Exact OS and version.
- Screenshot of the issue, if relevant.
Red Hat JBoss Developer Studio 8.0.0
Files:
jbdevstudio.ini- From inside JBDS go to the
Report a problemmenu and attach the resulting zip to the case - Possible screen cast showing the problem if it's UI based issue
Information:
1. Exact version of Developer Studio
2. What tooling was the issue seen on?
3. What sort of project was being worked on?
