Apache Tomcat SLD-DS 20181002
Apache Tomcat SLD-DS 20181002
Apache Tomcat SLD-DS 20181002
Overview........................................................................................ 4
1 Introduction ......................................................................... 5
3 Installation ........................................................................... 8
3.1 Install SLDREG - executable.......................................................................8
3.2 Deploy the SLD-DS application ..................................................................8
3.3 Configure the SLD DS application.......................................................... 10
3.3.1 Configuration of the SLD-DS .................................................................. 10
3.4 Start the SLD-DS application ................................................................... 14
6 Limitations ......................................................................... 22
7 Troubleshooting ................................................................. 23
7.1 Version of the SLD-DS application ......................................................... 23
7.2 Logging and Tracing.................................................................................. 23
7.3 Known issues.............................................................................................. 26
This document describes the SLD Data Supplier f or Apache Tomcat. An up-to-date version of this
document is attached to the SAP note 1508421.
A SLD data supplier enables an application sy stem to deliver up-to-date landscape information to the
SLD.
The SLD Data Supplier f or Apache Tomcat is a Web application that periodically reports landscape
inf ormation to the configured SAP SLD sy stem.
Note since 20.01.28 SLD Data Supplier reports Apache Tomcat 8.5 and 9.0 as corresponding Sof tware
Component Versions 8.5 and 9.0. Th def ault f allback approach implemented with the prev ious version
(reporting 8.5 and 9.0 as 8.0) is no longer used.
The ov erall SLD data collection process consists of several steps. The SLD Data Supplier uses JMX to
collect Tomcat’s configuration and software component data. The collection’s outcome is a SLD payload
XML f ile which is created on disk in the specif ied in the conf iguration directory. The last process step is
to send the created SLD pay load f ile to the specified SLD. The SLD Data Supplier establishes the
communication to SLD using a separate component – the SLDREG executable which has to be installed
and conf igured on the Tomcat host prior to the SLD-DS execution.
The SLDREG executable is a widely used nativ e SAP component which is delivered, for example, with
SAP Host Agent. SLDREG does not require much setup; only the connectivity to the SLD has to be
conf igured.
To store the conf iguration settings the SLD - DS application uses a simple Java properties file. There
are sev eral methods to specify which conf iguration properties file the SLD-DS application shall use. See
chapter “Conf iguration of SLD-DS application” for more details.
To send the conf iguration data to SLD periodically the SLD-DS application uses the Java 1.5 Thread
API as the scheduler serv ice. According to the specified in the configuration properties file settings the
application creates at startup a SLD-DS ‘inv oker’ timer which calls periodically the SLD-DS application.
When inv oked manually with the Web UI the SLD – DS application alway s updates its configuration from
the conf iguration properties file. However, the scheduled SLD-DS background job does not reload the
conf iguration but uses the settings provided at the time when it has been scheduled.
To conf igure SLDREG create appropriate .CFG and .KEY files to be used to establish a connection to
the SLD. The path to the SLDREG executable and to the .CFG f iles have to be specified in the SLD –DS
conf iguration properties file like follows.
SLDREG_PATH=/usr/sap/hostcontrol/exe/sldreg
SLDREG_CONFIG_FILE_PATH= /tmp/sld.cfg
Make sure that SLDREG setup is v alid for the user on behalf on which Tomcat runs.
Please see SAP Note 1018839 “Registering in the Sy stem Landscape Directory using SLDREG”->
“Conf iguration f or SLDREG” for more details. See also SAP Note 1382650 f or some common setup
issues.
To deploy the .war f ile use, f or example, the default Tomcat Manager administration UI application.
2. Enter path to the in SLD DS .war f ile in the “WAR f ile to deploy ” dialog and deploy the application.
Create an appropriate conf iguration property file and store it into the SLD-DS application deployment
f older.
1. Locate to the SLD-DS deploy ment folder – typically the webapps sub directory under Tomcat’s
installation f older
2. Copy the sldDataSupplier.properties.template f ile to the
sldDataSupplier.properties.
3. Make changes as appropriate.
All av ailable parameters used by the SLD-DS application are listed in the table below.
Def ault v alues are av ailable for most parameters .Parameters with a def ault value are marked with an ‘o’
(optional). Parameters without a def ault v alue are marked with the ‘m’ (mandatory) character.
m – Mandatory parameters
o – Optional parameters
o JVM’s
The directory to store
WORKING_DIR user.dir,
created SLD pay load f iles
user.home
SLD DS uses the SLDREG executable to send the data to the SLD. There are two way s to conf igure
SLD-DS application f or this task.
a) Specif y a ‘f ull’ OS command to be inv oked for SLD data sending under SLDREG_CMD parameter.
The command must contain a ‘placeholder’ expression ${WSSLD_FILE} for the SLD payload file name
which will be replaced at runtime with the real f ile path.
For example
SLDREG_CMD=/usr/sap/hostcontrol/exe/sldreg -connectfile /tmp/sld.cfg
-file ${WSSLD_FILE}
b) Specif y the path to the SLDREG executable and the path to the SLDREG configuration file path. For
example
SLDREG_PATH=/usr/sap/hostcontrol/exe/sldreg
SLDREG_CONFIG_FILE_PATH= /tmp/sld.cfg
1. Please use either option (a) or (b) but do not specif y both parameters.
2. On some Windows OS, if the path to the SLDREG executable contains a blank (for
example, if y ou are using the SLDREG from SAP Host Agent installed in the c:
/Program Files/SAP/hostcontrol directory ), the SLDREG_CMD (option a)
cannot be used. Use SLDREG_PATH and SLDREG_CONFIG_FILE_PATH parameters
(option b) instead.
3.
VERBOSE_LEVEL
The VERBOSE_LEVEL is used to “f ine tune” diagnostics log of the SLD-DS application. This parameter
and the log conf iguration in the logging.properties f ile control logging behav ior of the SLD-DS
application.
See the chapter 7.2 “Logging and Tracing” in the troubleshooting section of the document for more
details.
SYSTEM_ID
With the SY STEM_ID parameter y ou can assign the (extended) SID to the Apache Tomcat Server
sy stem. The v alue will be used as the sy stem’s SID in SAP Solution Manager. Note the specif ied value
might be rejected by the SAP Solution Manager, if , f or example, the value is already used for another
Tomcat sy stem. This value has to be set bef ore the first SLDDS run. It is not possible to change the SID
of an existing Tomcat system with SLD-DS application. Y ou can, howev er, change the SID with the
Sy stem Maintenance UI in the SAP Solution Manager.
Note
The SY STEM_ID may contain uppercase characters, numbers and the “_” character only. The
f irst character must be a literal and the length must not exceed 8.
HOST_NAME
The optional logical host name. If specified, overwrites the physical host name collected by the SLD-DS
f rom the OS.
SHUTDOWN_PORT
If no shutdown port is specif ied in the Tomcat’s server.xml, the optional SHUTDOWN_PORT value can
be prov ided in the SLD-DS conf iguration f ile. The setting does not overwrite the Tomcat’s configuration
SERVER_INFO
If SLD-DS is not able to f ind Tomcat’s version information, the optional SERVER_INFO value can be
specif ied in the SLD-DS configuration. The setting does not ov erwrite the Tomcat’s configuration value,
howev er. See also the chapter 6.1 “Secured Apache Tomcat Serv er” f or more details.
Example:
# Controls collection of data from WebSphere Application Server.
# If IS_DISABLED = false, the SLD - DS will stop immediately after it gets
invoked
com.sap.sup.admin.sldsupplier.IS_DISABLED = false
# Path and config file to send SLD content file to SLD using the executable
# SLDREG
com.sap.sup.admin.sldsupplier.SLDREG_PATH=/usr/sap/hostcontrol/exe/sldreg
com.sap.sup.admin.sldsupplier.SLDREG_CONFIG_FILE_PATH= /tmp/slddest.cfg
# The initial interval for which SLD DS will wait before the first run.
com.sap.sup.admin.sldsupplier.SLD_SCHEDULER_INITIAL_INTEVAL=360000
# The interval between two SLD-DS invocations.
com.sap.sup.admin.sldsupplier.SLD_SCHEDULER_INTERVAL= 21600000
<TOMCAT>/webapps/sap.com~TomcatSLDDataSupplierWEB/sldDataSupplier.properties
Example:
http://<AtcHost>:<AtcPort>/sap.com~TomcatSLDDataSupplierWEB/sldsupplier?confi
gSrc=urlConfig&url=file:////usr/sap/SLDProvider/sldDataSupplier.properties
Note that the dy namically provided configuration will be ov erwritten by application/server restart.
Open the Tomcat Manager application and start the Tomcat SLD-DS WEB application
sap.com~TomcatSLDDataSupplierWEB.
For example:
http://localhost:9080/sap.com~TomcatSLDDataSupplierWEB/sldsupplier
For example,
http://localhost:9080/sap.com~TomcatSLDDataSupplierWEB/sldsupplier?action=sldSupplier
The SLD Data Supplier reports f ollowing Apache Tomcat landscape objects to SLD:
Apache Tomcat Serv er
HOST
In the SLD f or each new Apache Tomcat serv er object an instance of the SAP_ATCServ er class is
created.
Host Host name Name of the host where the serv er is running
Sof tware components are def ined in the Product and Production Management Sy stem (PPMS). PPMS
is the central knowledge repository f or technical information on SAP’s software landscape. From PPMS
the sof tware descriptions are exported to the SLD as part of the component repository.
For the installed sof tware SLD Data Supplier reports Product, Software Component and Sof tware
Feature objects to SLD. SLD Data Supplier reports server-related software inf ormation (e.g. Tomcat
serv er v ersion) as well as f or installed application software.
Furthermore the SLD-DS application can also report support package and build number to the SLD.
The metadata XML f ile has to be placed into the META-INF f older of the application’s WAR file.
The name of a meta-data XML f ile either has to be either ‘SAP_metadata.xml’ or to end with
‘SAP_metadata.xml’ string. For example, f ollowing file names are valid and will be f ound by the SLD-DS:
SAP_metadata.xml, myComponent_SAP_metadata.xml, _SAP_metadata.xml
Following f ile names are NOT v alid and will not be f ound by the SLD-DS:
SAP_meta_data.xml, SAP_metadata.txt, SAP_metadata_myComponent.xml
Product and Sof tware Component are the top lev el metadata entities. Product may have one or several
Instances and Product Versions. A Binding entity specifies the relationship between Product/Software
Component Version and Product Instance.
Product
PPMS object/XML tag Description
Product Customer oriented view on SAP's software. A product
is a deliverable unit which customers can view, install
and renew.
Vendor The name of the software vendor; must be “sap.com".
Instance Group of technically dependent Software Component
Versions which have to be installed and operated on
a single logical system/server.
ProductVersion The release of a product. A „bundle“ of software
component versions made available at the same time
for implementing a well-defined scope of functionality.
Software Component
PPMS object/XML tag Description
SoftwareComponent Technical view on SAP’s software
SoftwareComponentVersion Version or release of a software component. A
(Software) Component Version indicates the release
of a Software Component. It is a technically
distinguishable unit of software and is installed and
patched as a whole
Vendor The name of the software vendor; must be “sap.com".
SupportPackage Support package of the Software Component Version
Bindings
PPMS object/XML tag Description
SLD Data Suppliers reads the Tomcat v ersion and the reports it to the SAP SLD as the Sof tware
Component and the Product Version. Without the version number in the Tomcat configuration the SLD
Data Supplier won’t be able to report the v ersion inf ormation and the data will be missing in the SAP
Solution Manager. The v ersion number must contain the Tomcat’s release number.
For example:
Apache Tomcat/7.0
The Tomcat’s patch number is not used and can be hidden, if required.
If no Tomcat v ersion can be detected, the value can be specified with the configuration parameter
For example,
com.sap.sup.admin.sldsupplier.SERVER_INFO= 8.0
The SLD Data Supplier application uses Tomcat’s built-in logging inf rastructure for logging. Tomcat can
utilize sev eral libraries f or logging like java.util.logging, Log4J and Apache’s implementation JULI.
Logging also depends on the underly ing JVM/OS.
The library which Tomcat uses f or logging is specified by the JVM system properties
“jav a.util.logging.manager” and “jav a.util.logging.config.file”. Tomcat’s logging configuration depends on
the used logging library .
Make sure that Tomcat logging is conf igured properly . Check whether the JVM sy stem properties
“jav a.util.logging.manager” and “jav a.util.logging.config.file” are specified. For example:
-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager
-Djava.util.logging.config.file=C:\APACHE\Tomcat\Tomcat6.0.33\conf\logging.properties
By def ault Tomcat uses Apache logging (JULI) subsystem. The Tomcat’s JULI logging is conf igured in
the logging.properties f ile located in the Tomcat’s conf directory.
The SLD-DS logging is conf igured in its own logging.properties f ile. The f ile is located in the SLD-DS in
the WEB-INF/classes folder in the application's deployment directory, typically in the
$CATALINA_HOME/webapps/sap.com~TomcatSLDDataSupplierWEB/ WEB-INF/classes
f older.
Depending on the used logging library and JVM/OS SLD Data Supplier application reports into Tomcat’s
serv er log (like catalina.log) or/and create separate (rolling) log f ile sldds-trace.log.
The SLD-DS application prov ides sample logging configuration properties file logging.properties. This
conf iguration is created for the default Tomcat’s logging JULI.
By def ault all log lev els are allowed f or all SLD-DS classes - the def ault logging.properties file sets the
log lev el to ALL f or the root SLD-DS package:
com.sap.sup.admin.sldsupplier.level=ALL
So y ou hav e to way s to control SLD-DS logging: with the log lev el in the logging.properties f ile and with
VERBOSE_LEVEL in the conf iguration properties file. If you set the log level in the log
logging.properties f ile to INFO
com.sap.sup.admin.sldsupplier.level=INFO
, only inf ormation but no detailed (FINE) log messages will be reported to the SLD-DS trace f ile. Y ou can
keep the ALL log lev el in the logging.properties f ile and “tune” the amount of log messages issued by the
SLD-DS application with the SLD-DS settings.
It is recommend to set the log lev el ALL and the VERBOSE_LEVEL parameter to 3. These are the
def ault settings.
For troubleshooting set the VERBOSE_LEVEL parameter in the SLD-DS conf iguration file to 4
com.sap.sup.admin.sldsupplier.VERBOSE_LEVEL = 4
Example:
An example of a ty pical SLD-DS log message sequence is listed below:
(ATLD DS0 020 0) Tom cat SLD Dat aSu ppli erS erv let .do Ser vic e() ST ART ED
(ATL DDS 002 50) To mca tSL DDa taS upp lie rSe rvl et inv oke ac tio n d oSL DDa taS upp lie r()
(ATL DDS 002 00) [To mca tSL DDa taS upp lie rSe rvl et] : l oad SL D c onf igu rat ion fr om src nu mbe r
[url Con fig ,2]
[Tom cat Man age men tSe rvi ceI nit ial ize r] Ini tia liz ing To mca t J MX API ob jec ts
(ATL DDS 013 00) st art co lle cti ng tom cat co nfi gur ati on
(ATL DDS 013 10) Cr eat ed Tom cat Con fig ura tio n o bje ct Tom cat Con fig ura tio n{ tom cat = Tom cat { s erv ers =
1 } }
(ATL DDS 013 99) [T omc atS LDD ata Sup pli erS erv ice Imp l] fin ish ed col lec t T omc atC onf igu rat ion
[Tom cat Con fig ura tio n{ tom cat = Tom cat { s erv ers = 1 } }]
To analy ze SLDREG issues set the VERBOSE_LEVEL parameter in the SLD-DS configuration file to 5
com.sap.sup.admin.sldsupplier.VERBOSE_LEVEL = 5
and set the log lev el in the logging.properties f ile to FINEST (all).
com.sap.sup.admin.sldsupplier.level.* = ALL
SLD-DS will report the SLDREG command it used and detailed inf ormation about the SLDREG process
execution and log out the output of SLDREG command to the SLD-DS trace file. For example:
FINE ST: Th u N ov 15 13: 47: 36 201 2 S LD Reg ist rat ion Pr ogr am [7. 20. 4] (A pr 12 201 1) [No n-U nic ode ]
Thu Nov 15 13 :47 :36 20 12 Usi ng XML
'C:/ APA CHE /To mca t/T omc at7 .0. 33/ tem p/S LDD S/w ork \tc sld _12 111 5_1 347 36_ 347 .xm l' dat a i npu t f ile
Thu Nov 15 13 :47 :36 20 12 Par sin g X ML doc ume nt.
Thu Nov 15 13 :47 :36 20 12 Sup pli er Nam e: ATC App lic ati onS yst em
Thu Nov 15 13 :47 :36 20 12 Sup pli er Ver sio n: 1.2
Thu Nov 15 13 :47 :36 20 12 Sup pli er Ven dor : s ap. com
Thu Nov 15 13 :47 :36 20 12 CIM Mo del Ve rsi on: 1. 6.1 0
Thu Nov 15 13 :47 :36 20 12 Usi ng des tin ati on fil e
'C:/ APA CHE /To mca t/T omc at7 .0. 33/ tem p/S LDD S/s lds olm an. cfg '.
Thu Nov 15 13 :47 :36 20 12 Use bi nar y k ey fil e
'C:/ APA CHE /To mca t/T omc at7 .0. 33/ tem p/S LDD S/s lds olm an. cfg .ke y' for da ta dec ryp tio n
Thu Nov 15 13 :47 :36 20 12 Use en cry ted de sti nat ion fi le
'C:/ APA CHE /To mca t/T omc at7 .0. 33/ tem p/S LDD S/s lds olm an. cfg ' a s d ata so urc e
Thu Nov 15 13 :47 :36 20 12 HTT P t rac e: fal se
Thu Nov 15 13 :47 :36 20 12 Dat a t rac e: fal se
Thu Nov 15 13 :47 :36 20 12 Usi ng des tin ati on fil e
'C:/ APA CHE /To mca t/T omc at7 .0. 33/ tem p/S LDD S/s lds olm an. cfg '.
Thu Nov 15 13 :47 :36 20 12 Use bi nar y k ey fil e
'C:/ APA CHE /To mca t/T omc at7 .0. 33/ tem p/S LDD S/s lds olm an. cfg .ke y' for da ta dec ryp tio n
Thu Nov 15 13 :47 :36 20 12 Use en cry ted de sti nat ion fi le
'C:/ APA CHE /To mca t/T omc at7 .0. 33/ tem p/S LDD S/s lds olm an. cfg ' a s d ata so urc e
Thu Nov 15 13 :47 :36 20 12 *** *** *** *** *** *** *** *** *** ***
Thu Nov 15 13 :47 :36 20 12 *** St art SL D R egi str ati on ***
Thu Nov 15 13 :47 :36 20 12 *** *** *** *** *** *** *** *** *** ***
Thu Nov 15 13 :47 :36 20 12 HTT P o pen ti meo ut = 420 se c
Thu Nov 15 13 :47 :36 20 12 HTT P s end ti meo ut = 420 se c
Nov 15, 20 12 1:4 7:3 6 P M c om. sap .su p.a dmi n.s lds upp lie r.s ldr eg. SLD Tra nsp ort er exe cSL DRe g
FINE ST: Ex ecu ted SL DRe g c omm and er ror st rea m:
To troubleshot SLDREG problems log on with the Tomcat user, copy & paste the SLDREG command
f rom the SLD-DS trace and apply it manually.