Chat now with support
Chat mit Support

Foglight for Microsoft DOT NET 5.9.13 - Application Servers Administration and Configuration Guide

Using the text editor

If you are familiar with the recording settings from previous version of Foglight for Java EE Technologies, and you are comfortable editing the settings in a plain text format, you can edit the Nexus recording settings manually.

To edit Nexus recording settings in a plain text format:
1
On the navigation panel, under Dashboards, click Application Servers > Administration.
2
On the Application Servers Administration dashboard, click the Nexuses tab.
3
On the Nexuses view, do one of the following:
•
On the Agents tab, click the name of the Nexus that is using the configuration you want to edit. Click Text edit recording settings to edit the settings in a plain text file.
Or
•
On the Recording Settings tab, click the name of the configuration you want to edit. Click Text edit to edit the settings in a plain text file.

The recording.config file opens in a text editor.

For information about the settings contained in this file, see the following topics:

•
Request sampling
•
Collection details
•
Advanced settings

Request sampling

Use the Request Sampling tab Nexus Recording editor for the Nexus to configure request separation rules, URL transformation rules, and filtering rules. Request separation is the first process that occurs when the agent collects request metrics. Next, any rule transformations are applied. Filtering occurs after request separation and URL transformation rules are applied. As a result, the filters can refer to parameter names and values from request separation, and must reference the transformed URL.

For more information, see:

•
Setting rules for separating requests
•
Setting rules for transforming URLs
•
Setting rules for filtering requests

Setting rules for separating requests

Setting rules for separating requests

Request separation is the first process that takes place when collecting request metrics. On the Request Sampling tab, you can specify how to separate a request into multiple request types based on the request's parameters and cookies. Separation occurs if any of the parameters in a request match the request separation rules (SeparationRules) for that URL, meaning that a request may be separated based on more than one parameter. SeparationRules are configured in the recording.config property file.

The default setting is:

SeparationRules = {
};

Keys and values can be used to customize the SeparationRule parameter.

•
Keys — Strings or regular expressions
•
Values — Lists of URL parameter names (strings)
 
* 
NOTE: Do not include the HTTP method in this rule.
For example:
In the Nexus Recording editor:
1
Open the Nexus Recording Editor, as described in Using the text editor .
2
Click Edit beside SeparationRules.
3
In the Settings Editor, click Add to add each rule (one per row).
4
Click OK to close the Settings Editor.
The rules display in the editor.
In the text editor:
1
Open the recording.config file. For details, see Using the text editor .
2
Edit the SeparationRules entry:
 
SeparationRules = {
/\/path\/servlet$/ : ("parameter1", "parameter2"),
"/account/balance.do" : ("type"),
"/main.action" : ("parameter1"),
};
 
3
Save your changes.
Next steps:
•
Define the transformation of the URL path. See Setting rules for transforming URLs
•
Set the rules for filtering, as described in Setting rules for filtering requests .

Setting rules for transforming URLs

The Nexus recording settings define transformation of URLs. If separation parameters are defined for a URL that is to be transformed, the transformation is performed on the resulting separated URL, which includes the path and separation parameters. There may be more than one transformation defined. Each transformation may contain more than one replacement definition.

The URL transformation rules also control how requests are grouped for display on the Requests view of the Application Servers Monitor dashboard. A set of default transformations shorten the request URLs. Request types that have request separation configured are not transformed by the default rule. Static file requests (for example, images) are also not transformed.

 
* 
NOTE: Changing any of these settings requires advanced knowledge of the product. Do not modify any of the settings if you are unfamiliar with this product.

Make a backup of the Nexus profile before editing.

You do not have to restart your instrumented application servers after editing the Nexus recording settings. Data collection is stopped and restarted automatically when the recording settings change.
To set URL Transformation Rules in the Nexus Recording editor:
1
Open the Nexus Recording editor, as described in Editing the Nexus recording settings .
2
Review the default transformation rules. These rules automatically shorten request URLs as follows:
If the request has more than three '/', it is shortened to the third '/'.
If the request has only two '/', it is shortened to the 2nd '/'.
If the request has only one '/', it is shortened to: '/'.
 
* 
NOTE: These default transformations are only available for new installations. Upgrading from a previous version does not change your existing transformation rules.
3
Click Edit beside URLTransformationRules.
4
In the Settings Editor, click Add URL transformation.
5
In the Add Matching URL Regex box, type the regular expression that you want to use to match the URLs that need to be transformed.
 
* 
NOTE: Regular expression special characters that should be matched as literal characters in the URL must be escaped with a “\” character; for example, “\?” to match a literal “?” in the URL.
6
Click OK to save the matching URL.
7
Optional — Repeat steps 5 and 6 as many times as necessary to add more matching URLs.
8
Click Add URL replacement. In the new row that appears, click in each box to type the required information.
9
In the Text in URL Regex box, type the regular expression used to match the text that needs to be replaced in the URL.
 
* 
NOTE: Regular expression special characters that should be matched as literal characters in the URL must be escaped with a “\” character; for example, “\?” to match a literal “?” in the URL.
10
In the Replacement Text box, type the literal string of the replacement text; this can be an empty string, or it can contain markers used to substitute sub-expressions from the Text in URL Regex, which are sequences of characters surrounded by parentheses. Valid markers for substitution are:
•
“&”’ or “\0” are replaced with a copy of the entire matched region
•
“\n”, where n is a digit from 1 to 9, is replaced with a copy of the nth subexpression
•
“\” followed by any other character is replaced with just that character. For example, “\&” or “\\” are replaced with just “&” or “\”.
Any other character is passed through.
Order is important. The transformation is performed using the list of replacements defined for the first Matching URL Regex that is found. The replacements are performed in the order in which they are defined. Each replacement is performed on the URL resulting from the previous replacement.
In the text editor:
1
Open the recording.config file. For details, see Using the text editor .
2
Edit the URLTransformationRules entry:
URLTransformationRules = {
/<url-regex>/ : {
/<text-in-url-regex>/ : <replacement-literal>,
},
/<url-regex>/ : {
/<text-in-url-regex-1>/ : <replacement-literal-1>,
/<text-in-url-regex-2>/ : <replacement-literal-2>,
},
};
 
* 
NOTE: Regular expression special characters that should be matched as literal characters must be escaped with a “\” character; for example, “\?” to match a literal “?”.

where:

<url-regex> is a regular expression used to match the URLs that need to be transformed. The ‘/’ and ‘?’ characters must be escaped with a ‘\’ character.

<text-in-url-regex> is a regular expression used to match the text that needs to be replaced in the URL. The ‘/’ and ‘?’ characters must be escaped with a ‘\’ character.

<replacement-literal> is a string literal of the replacement text, as described in Step 10 in the previous procedure. Backslashes must be doubled (“\\”) .

3
Save your changes.
 
* 
NOTE: Check the Separation Rules to confirm if the separation parameters are defined. For more information, see Setting rules for separating requests.
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen