Unable to normalize Spring WebService URLs

Document ID : KB000100666
Last Modified Date : 10/08/2018
Show Technical Document Details
Issue:
Configuration
- Introscope Agent 10.5.x or 10.7.0
- Spring WS agent extension (SpringWS-f85e8b22-1.0.0.tar.gz )

Problems:
When using the above configuration you encounter the below 2 issues:

Issue # 1 : Metric explosion because you unable to normalize the Spring WebServices URLs (services called over SpringWS) which are available under :

“<agent>|backends” 
“<agent>|webservices” 
“<agent|Frontends|apps|<app>|URLs|<url>|CalledBackends|”

Example:
 
User-added image
 
User-added image

Issue # 2: User sensitive data included as part of the Spring Webservices URL is available from both Investigator (as illustrated above) and Traces View (as below):

Example:
 User-added image
Cause:
The above 2 problems are related to a limitation in the Spring Webservices agent extension (SpringWS-f85e8b22-1.0.0.tar.gz Extension)
There is no mechanism to normalize the generated Spring Webservices metrics (Enhancement # DE324280)
Resolution:
The Spring WS Agent extension has been enhanced to address the above 2 issues, the below new properties have been created to be able to :
 
a) normalize the Spring Webservices URLs 
b) mask the URL in the traces

This new Spring WS agent extension is available as part of the following 2 agent hotfixes:
 
10.5.1 Hotfix#68
10.7.SP2

If you would like to obtain a copy contact CA Support.


################################################
# Webservices Namespace Grouping Configuration
#
# ================
# Configuration settings for Webservices namespace naming.  By default, webservices' namespace/service-name
# go into their actual value in the metric-string.  
# For example, Webservices with a metric: Webservices|Server|SampleNameSpace|SampleOperationName is reported as is
# until the number of namespace/service-name groups created across all apps reach a value defined in the property 
# "introscope.agent.webservicesnamespacegroup.clamp" below.
# After the clamp is reached, all namespaces go into the "Default" group.
# To get customized metrics out please use the regex-based grouping via the properties below.  
# Changes to this property take effect immediately and do not require the managed application to be restarted.
introscope.agent.webservicesnamespacegroup.keys=default
introscope.agent.webservicesnamespacegroup.group.default.pathprefix=*
introscope.agent.webservicesnamespacegroup.group.default.format=={path_delimited:/:0:5}
introscope.agent.webservicesnamespacegroup.clamp=5

########################
# URL Trace Parameter Masking 
#
# ================
# The following property will enable the masking of URL trace parameter in Frontend and Servlet traces.
# It is useful in case the the executed URL has sensitive/private data which shouldn't be exposed in traces.
# The mask is same as the URL metric-group assigned, hence would only work in congruence with URL grouping configurations.
# By default the property is set as false. 
# Changes to this property take effect immediately and do not require the managed application to be restarted
introscope.agent.trace.frontend.urlmasking.enabled=false

 
Additional Information:
https://comm.support.ca.com/kb/apm-10-7-hotfixes/KB000105898