Chat now with support
Chat mit Support

Foglight APM for Real User Experience 5.9.9 - Administration and Configuration Guide

Getting started Configuring traffic capture
Managing Sniffers Managing Archivers Managing capture groups Managing sessionizing policies Managing monitored ports Managing monitored IP addresses Managing monitored subnets Managing identifiers for virtual addressing schemes Managing private keys Managing web services and SOAP operations
Configuring traffic analysis Configuring analyzers Capturing traffic outside the network Configuring advanced options Integrating Foglight APM with other products Maintaining and troubleshooting Appendix: Building regular expressions in Foglight Appendix: Traffic analysis processing
Understanding the traffic analysis workflow Stage 1: Run hit analysis Stage 2: Run sequence analysis Stage 3: Finalize stopped sequences Stage 4: Finalize the session Example of interdependent analyzers Online-Only Topics
Removing items from a table Defining extraction expressions Adding, copying, and editing archivers Testing archivers Configuring archiver database shard settings Adding, copying, and editing sniffers Testing sniffers Adding and editing capture groups Testing capture groups Adding and copying sessionizing policies Editing sessionizing policies Selecting session identifiers from a discovery list Adding and editing session identifier variables Organizing session identifiers Selecting user name variables from a discovery list Adding and editing username rules Selecting URL prefixes from a discovery list Adding or adding URL prefixes Selecting ports from a discovery list Adding or editing monitored ports Selecting IP addresses from a discovery list Adding or editing monitored IP addresses Looking up host names for all monitored IP addresses Associating private keys with IP addresses Selecting subnets from a discovery list Adding and editing monitored subnets Adding identifiers Editing identifiers Finding IP addresses in HTTP headers Configuring a custom HTTP header using Microsoft IIS Manager Adding and editing local private keys Adding and editing HSM private keys Exporting keys using Microsoft Management Console Adding or editing web services Importing WSDL files to define web services Managing custom fields and metrics Adding, copying, and editing custom fields Removing custom fields Editing custom metrics Removing custom metrics Managing sensitive data Adding, copying, and editing sensitive hit detail policies Adding, copying, and editing sensitive content expression policies Modifying members of pivot categories Selecting aliases from a discovery list Adding, copying, and editing domain rules Adding, copying, and editing large hit details Adding, copying, and editing URL classifiers Reviewing rules for browser category, browser, and operating system hit details Adding user-defined user agent rules Adding and editing additional parsed response types Adding and editing captured request body types Adding, copying, and editing scripts Removing scripts Referencing configuration objects in a script Testing regular expressions Syntax for test data Adding simple hit analyzers using the Setup Wizard Adding simple sequence analyzers using the Setup Wizard Adding analyzers Copying analyzers Editing analyzers Adding and editing conditions Creating a simple Boolean expression Creating a complex Boolean expression Disabling standard metrics generated by a hit analyzer Adding custom metrics Editing custom metrics Selecting pivot categories Breaking out metrics into dynamically-named topology objects Publishing metric timeslices for the Geographical Perspectives dashboard Changing SLA thresholds Adding custom field updates Editing custom field updates Adding scripts to an analyzer Editing scripts Creating new scripts on the fly Adding hit storage restrictions Editing hit storage restrictions Adding sequence events Editing sequence events Adding static page elements Editing static page elements Viewing resource files defined by static page elements Adding and editing subnet filters Exporting configurations Exporting encrypted configurations Restoring a previous configuration Importing saved configurations Importing hit analysis configurations from Foglight Experience Viewer Using the Import Configuration Wizard

Managing scripts

Scripts are snippets of custom logic that extend the functionality of Foglight APM. You create scripts using the Groovy scripting language. With scripts, you can perform the following tasks:
•
create sophisticated match conditions for analyzers
•
match patterns and extract data from traffic analysis details
•
run calculations
•
match URLs to classify URLs as types of pages or hits
•
expose the results of scripts as output variables, which in turn can be used as values for custom fields or metrics
 
* 
NOTE: Scripts for traffic analysis run on the Archiver database and directly affect data analysis and storage activities. Foglight also offers a Script Console dashboard. You can use the Script Console to query data stored in topology objects in the Foglight database.
To define and manage scripts, navigate to APM > Configure > Traffic Analysis, select Advanced Options, and expand Scripts. You can also create scripts from hit analyzers, session analyzers, and sequence analyzer events; the Scripts view is the same in all dashboards. In the Scripts dashboard, you can add, copy, edit, and remove scripts using the standard controls. The Used By column contains a list of analyzers and events currently configured to execute each script.
For more information, see the following topics:
•
Before you begin
•
Determining requirements
•
Creating scripts
•
Testing scripts
•
Defining scripts

Before you begin

To create scripts, you require a good working knowledge of the Groovy scripting language and Java™ regular expressions. You also need to become familiar with the Traffic Analysis APIs, which are installed automatically with the Foglight APM software.
 
* 
NOTE: The Groovy scripting engine incorporates a security policy that limits access to certain classes and methods. Most notably, it prevents access to the file system, system commands, threads, or processes.
 
Table 47. Reference information
Resource
Information
Javadoc for the Traffic Analysis APIs
For Javadoc on the Traffic Analysis APIs, see http://<Foglight_IP_address>:8080/euwebgui/scriptdocs/index.htm.
Groovy scripting language
For general information about Groovy scripts, see
http://groovy.codehaus.org/Documentation.
Syntax for Java regular expressions
For a primer on regular expressions, see Appendix: Building regular expressions in Foglight.

Determining requirements

Before you begin adding scripts in the Scripts view, you should take the time to identify the key requirements for your script. Then when you create the script, you know exactly which values to select in the Script - Add dashboard and Edit Script dialog box.
Planning a script includes the following steps:
1
Select an appropriate API
2
Define output variables
3
Decide when to execute the script
4
Decide how many uncaught failures are allowed

Select an appropriate API

You have a choice of four Traffic Analysis API. When selecting an API, you need to consider:
•
the traffic analysis data your script requires
•
where you want to execute your script
For example, do you need only basic hit-level data, or do you require sequence-level detail such as the reason a sequence stopped, or possibly session-level data such as the session hit count? Do you want to run your script from a hit analyzer or a sequence analyzer or some other location?
Based on your data requirements, use the following table to select an appropriate API.
 
* 
NOTE: Each API includes all the data available with the API that precedes it in the table. For example, the SessionAnalysis API includes all hit details available in the HitAnalysis API. The APIs do not correspond to the traffic analysis processing phases described in Appendix: Traffic analysis processing.
 
Table 48. Selecting an appropriate API
Data Requirements
Traffic Analysis API
Basic hit details, such as the URL, browser, response content, and headers. For a complete list, see HitDetails in the Scripting API JavaDoc.
HitAnalysis
Basic session details, such as hit count and end to end time, plus extended hit details, such as custom fields. For a complete list, see SessionDetails and HitDetailsExt in the Scripting API JavaDoc.
Also includes all data available with the HitAnalysis API.
SessionAnalysis
Basic sequence details for the current sequence, such as pages in the sequence and back end time. For a complete list, see SequenceDetails in the Scripting API JavaDoc.
Also includes all data available with the SessionAnalysis API.
SequenceAnalysis
Extended sequence details such as stop reason and stop time. For a complete list, see SequenceDetailsExt in the Scripting API JavaDoc.
Also includes all data available with the SequenceAnalysis API.
PostSequenceAnalysis
Generally speaking, as an API provides access to more data, the script execution options become more restrictive. In other words, the more data you can access, the fewer places the script can run. For example, a script that uses the HitAnalysis API can run anywhere a script is supported in the APM dashboards. On the other hand, a script that uses the PostSequenceAnalysis API can be run only when the sequence analyzer event is in a Stopped state.
Based on where you want to execute the script, use the following table to understand your options.
 
Table 49. Executing a script
 
Select one of the following APIs:







To execute a script from a:

HitAnalysis

SessionAnalysis

SequenceAnalysis

PostSequenceAnalysis
 
Hit Analyzer
—
—
—
Session Analyzer1
—
—
Sequence Analyzer Event
with Sequence Entry State=Not Started
—
—
Sequence Analyzer Event
with Sequence Entry State=Active
—
Sequence Analyzer Event
with Sequence Entry State=Stopped
Special Event—Stop Session Event
—
—
Special Event—Stop Sequence Event
—
1
When a timeout causes a session or sequence to stop, hit details are not available. If your script attempts to access hit details, null values are returned. Therefore, whenever a script can be executed due to a timeout, the script needs to be programmed either to avoid accessing hit details or to handle the case where hit details are null.

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen