Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

FREE TRIALS

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

Table of Contents

Getting started

Understanding how Foglight captures real user data

Software components

Foglight Management Server Archiver Sniffer Browser instrumentation Relayer Archiver databases

Simplest monitoring solution Foglight APM Appliances and real user data

Logging in to Foglight Finding the Foglight APM dashboards Registering Sniffers and Archivers

Creating Capture Groups Registering Sniffers Registering Archivers

Verifying that you are capturing data Resolving gaps in traffic capture

Adding missing ports Capturing complete user sessions

Adding session identifier variables in cookies Adding other types of session identifier variables Prioritizing session identifiers

Monitoring secure web traffic

Step 1: Registering secure ports Step 2: Specifying monitored IP addresses Step 3: Providing private keys Step 4: Associating ports and keys with monitored IP addresses

Verifying configuration changes

Making your data more meaningful Focusing on selected web applications and web sites

Monitoring selected IP addresses only Excluding subnets

Assigning user roles Next steps

Configuring traffic capture

Managing Sniffers

Defining Sniffers Testing Sniffer communications

Managing Archivers

Defining Archivers Testing Archiver communications Setting database shard span and retention periods

Managing capture groups

Planning capture groups Defining capture groups Assigning Sniffers and Archivers to capture groups Testing capture group communications

Managing sessionizing policies

Understanding the default sessionizing policy Deciding when to add more sessionizing policies Understanding how sessionizing policies are applied Defining sessionizing policies Sessionizing policies—Identifying user sessions

Discovering session identifier variables in cookies Identifying session identifiers in URL paths Defining session identifiers Prioritizing session identifiers

Sessionizing policies—Associating user names with user sessions

Discovering user names Capturing user names in a single sign-on environment Identifying user names in XML Understanding missing user names Defining username rules

Sessionizing policies—Targeting sessionizing policies to URL prefixes

Discovering URL prefixes Defining URL prefixes

Sessionizing policies—Defining when a session has ended

Managing monitored ports

Discovering ports Defining monitored ports

Managing monitored IP addresses

Discovering IP addresses Defining monitored IP addresses Displaying host names instead of IP addresses Monitoring secure (HTTPS) web traffic

Managing monitored subnets

Discovering subnets Defining monitored subnets

Managing identifiers for virtual addressing schemes

Defining identifiers Capturing originating client IP addresses Capturing server IP addresses Capturing host names

Managing private keys

Managing local private keys Managing HSM private keys

Managing web services and SOAP operations

Creating web services automatically from WSDL files Defining web services and SOAP operations

Configuring traffic analysis

Managing custom fields

Predefined custom fields Setting and updating the value of custom fields Defining custom fields

Managing custom metrics

Editing custom metrics

Managing security policies for sensitive hit details

Hiding or replacing sensitive hit details Omitting sensitive hit details from the database Defining sensitive hit details

Managing security policies for sensitive content

Hiding or replacing sensitive content Omitting sensitive content from the database Defining sensitive content expressions

Managing pivots

Understanding pivot categories Enabling pivot categories and defining their membership Enabling global pivots for web sites and endpoints

Configuring advanced options Managing domain rules

Discovering aliases Defining domain rules

Storing large hit details

Defining large hit details

Managing special events

Defining global stop criteria for sessions Defining global stop criteria for sequences Defining special events

Troubleshooting improperly classified URLs

Defining URL classifiers

Managing user agent rules

Defining new user agent rules Setting the execution order for rule files

Defining additional parsed response types Defining captured request body types Modifying traffic analysis options Managing scripts

Before you begin Determining requirements

Select an appropriate API Define output variables Decide when to execute the script Decide how many uncaught failures are allowed

Creating scripts Testing scripts Defining scripts

Configuring analyzers

Introducing hit analyzers

Reviewing default hit analyzers Tips for creating effective hit analyzers Configuring hit analyzers

Introducing sequence analyzers

Configuring sequence analyzers

Introducing session analyzers

Tips for creating effective session analyzers Configuring session analyzers

Summary of options by analyzer type Configuring conditions

Defining match conditions Defining error and warning conditions Grouping multiple conditions Defining conditions

Working with metrics

Understanding standard metrics Creating custom metrics Changing the name of metric topology objects Understanding pivots for analyzer metrics Publishing hit metrics for use in the Geographical Perspective dashboard Defining service level agreement thresholds

Updating custom fields

Updating the value of custom fields Creating new custom fields Defining custom field updates

Executing scripts

Executing scripts Creating new scripts

Defining storage policies

Defining hit storage restrictions for hit analyzers Defining storage options for sequence analyzers

Setting searchability options for analyzers

Defining options for hit analyzers Defining options for session analyzers

Defining events for sequence analyzers

Understanding sequence states Defining event conditions

Defining event conditions

Recording the order of triggered events Defining sequence events

Capturing traffic outside the network

Deciding when to add browser instrumentation Introducing the instrumentation components Configuring an instrumented monitoring solution Verifying instrumentation payloads are received Viewing metrics collected by instrumentation

Configuring advanced options

Configuring internal settings

Archiver query settings Replay settings Metadata settings

Substituting static page elements

Defining static page elements

Excluding subnets from data collection

Defining subnet filters

Integrating Foglight APM with other products

Integrating with CA SiteMinder

Adding SiteMinder Server definitions in Foglight Registering Foglight as a SiteMinder agent Adding SiteMinder to a sessionizing policy

Integrating with SafeNet Hardware Security Modules

Planning a Foglight–HSM integration Registering HSM servers in Foglight Generating SafeNet HSM client certificates Associating HSM keys with monitored IP addresses

Maintaining and troubleshooting

Checking the health of Foglight APM Appliances

Investigating issues with appliance health Summary of Appliance Health views

Managing configuration changes

Reviewing change versions Understanding configuration modules and objects Exporting configuration modules and objects Restoring and importing configurations Reviewing warnings

Creating support bundles Updating appliance software Restarting the embedded Agent Manager

Appendix: Building regular expressions in Foglight

What is a regular expression? Where can I find regular expressions? Regular expression basics

Building a simple pattern Building a pattern that matches a specific character Building a pattern that matches multiple characters Using advanced quantifiers Using special characters and regular expression flags Grouping elements in a pattern Additional information

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

Summary of Appliance Health views

The following table provides links to the dashboards and views you see when investigating issues.

Table 87. Appliance Health views
Selected Tile	Quick View	Clicking Explore opens:
	Initially, the quick view displays the Summary - All Appliances view. When an appliance is selected, it shows the Appliance: SelectedAppliance view.	Appliance: SelectedAppliance dashboard
	Initially, the quick view displays the Summary - All Sniffers view. When a Sniffer is selected, it shows the Sniffer: SelectedSniffer view.	Sniffer: SelectedSniffer dashboard
	Initially, the quick view displays the Summary - All Archivers view. When an Archiver is selected, it shows the Archiver: SelectedArchiver view.	Archiver: SelectedArchiver dashboard
	Initially, the quick view displays the Summary - All Relayers view. When a Relayer is selected, it shows the Relayer: SelectedRelayer view.	Relayer: SelectedRelayer dashboard

Managing configuration changes

The Configuration Change Log incrementally records all changes to the traffic capture and traffic analysis options, including what changed and who made the change. Each changed configuration is assigned a version number. The Configuration Change Log keeps the most recent 100 versions. You can save a version permanently by exporting the configuration to a file.


	TIP: If you notice a sudden change in the metrics gathered by the appliance, you may be able to trace the cause using the Configuration Change Log. Review recent versions to see if you can link the change in data capture to a recorded configuration change.

To view and manage changes to the configuration, navigate to APM > Support > Configuration Change Log.

Figure 104. Configuration Change Log dashboard

In the Configuration Change Log dashboard, you can export and import configuration changes and review warnings. You can also view more details about a selected version and optionally roll back some or all of the configuration changes to match the selected version. For procedures, see the online help.

For more details, see the following topics:

•

Reviewing change versions

•

Understanding configuration modules and objects

•

Exporting configuration modules and objects

•

Restoring and importing configurations

•

Reviewing warnings

Reviewing change versions

To see what changed in a particular version, click its Details

icon. The Details dashboard opens, displaying details that compare the selected version to the current version.

Figure 105. Configuration Change Log details

Information view

The Information view contains identifying information about the selected version, including the version number, the name of the user who made the change, the type of change, the object that was modified, and the timestamp of the change.

Objects Defined view

The Objects Defined table describes all the configuration objects in the selected version.

Table 88. Objects Defined view
Objects Defined	Description
Object Type	Shows the type of each object, such as Hit Analyzer or Custom Field.
Object Name	Shows the display name for each of the objects.
In Current	Contains a Boolean value that indicates whether an object still exists in the most current configuration (true) or not (false).
Same As Current	Contains a Boolean value that indicates whether an object in the selected configuration is the same as the object in the most current configuration (true) or not (false).

Newer Objects in Current Configuration view

The Newer Objects in Current Configuration table lists the objects in the current version that have been added since the selected version.

Table 89. Newer Objects in Current Configuration view
Newer Objects	Description
Object Type	Shows the type of each object, such as Hit Analyzer or Custom Field.
Object Name	Shows the display name for each of the objects.

Understanding configuration modules and objects

Configurations are divided into modules and each module contains configuration objects, as described in the following table. An export saves all modules to a single configuration file.

Table 90. Configuration modules
Configuration Module	Objects Contained in the Module
Archiver	Archivers registered in the APM > Configure > Traffic Capture > Archivers dashboard.
Capture Group	Capture groups defined in the APM > Configure > Traffic Capture > Capture Groups dashboard.
Traffic Analysis	All options defined from the APM > Configure > Traffic Analysis dashboards.
Static Page Elements	All options defined in the APM > Configure Advanced Options > Static Page Elements dashboard.
Server Settings	All options defined in the APM > Configure Advanced Options > Setting dashboard.
Sniffer	Sniffers registered in the APM > Configure > Traffic Capture > Sniffers dashboard. In addition, this module includes options defined in the Private Keys, Monitored Ports, Monitored IP Addresses, SiteMinder Servers, Subnet Filters, and HSM Device dashboards.

When you import a configuration, you can select the modules you want to import. For the Traffic Analysis and Server Settings modules, you can select individual objects rather than importing the entire module. The Import Configuration Wizard guides you through the process.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating