Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


Table of Content Zone

Enhancements and Updates

ADQL and Widgets Enhancements (DRAFT)

  • User experience of running ADQL queries has been improved:
    • ADQL UI now has the Save button. Use the button to save new searches.
    • The following fields are added to the ADQL UI for mobile_snapshots: Platform,Request Content Length,Response Content Length, Country, Region, Background.
    • The Analytics Search page shows advanced statistics, such as standard deviation, median, minimum, and maximum, for numeric fields. Click the field to view associated statistics.
  • The following clauses are added to ADQL: HAVING and SINCE ..UNTIL.
  • The analytics functions, such as avg, max, and min, now support the datetime format.
  • Business iQ now supports exporting data to a file in CSV format for external use. Use the Search page to do so.
  • Type conversion for MIDC and HTTP Data Collectors are supported in Transaction Analytics. The MIDC and HTTP Data Collectors allow you to convert transaction analytics data into suitable data types. The supported data types are String, Boolean, and Number.
  • ADQL now supports the TotalResults() function. It returns the total count of events. TotalResults() does not accept a field.
  • The IS NOT NULL operator is now supported in Basic mode (Drag and Drop Search), including Funnel filters. The operator returns all the events with values either true or false.
  • The numeric widget now has a comparison indicator. Use the Compare to and Trailing By options in the Widget Properties to indicate an offset. The Compare to option by default is set to None. Select Prev.period from the Compare to drop-down and specify the relative time in minutes, hours, or days using the Trailing By option. The current aggregate value is compared against the period you specify and the difference is displayed on the widget.
  • All the widgets now support user input for percentile aggregations. The supported values are integers between 1 and 99 inclusive. In Basic mode, drag a numeric field to the canvas, and use the drop-down next to the field name to specify a value for percentile aggregation.
  • The logarithmic scale is now supported in Analytics widgets for the Time Series charts. Use the Logarithmic Y Axis checkbox in the Widget Properties to apply the logarithmic scale to a selected field.
  • Ability to hide legends is now supported in widgets. In the Widget Properties, select None from the Legend drop-down to hide legends.
  • Analytics Widget Properties now have an option to make the widget's background transparent.
  • Agent ID and Client GUID are exposed in the Data tab and can be used to build custom widgets.
  • Close Widget Builder option is provided to support canceling widget editing. With this option, unwanted changes to a widget can be dropped while editing, and revert to the previous version by closing the widget.
  • The extra whitespace on the histogram has been removed. The histogram now looks condensed on the dashboard.
  • The metrics created using the Numeric widget now displays the exact value returned by the search. In Widget Properties, select Exact from the Format drop-down to view the exact number. Other options available are Automatic, Thousands(k), and Millions(m). The default is Millions(m).
  • You can now edit the properties of multiple widgets. See Create and Manage Custom Dashboards and Templates.

Business Journeys

  • Business Journeys authoring has been enhanced with the following features:
    • Business Outcomes has been renamed as Business Journeys.
    • A Search button has been added to the Business Journey page. Analytics Search button provides one-click access to the underlying events. Selecting an enabled Business Journey and clicking Analytics Search takes you directly to the Searches page in Basic mode. Analytics Search button is unavailable for definitions in Draft and Valid Draft states.
    • Float type is supported for filtering Business Journey events.
    • Custom event types are supported.
    • Custom event data can be used to create Business Journeys.
    • All the fields that are part of filters and optional filters are automatically collected.
    • When defining Business Journeys, you can now delete the same field from one milestone and add it to a different milestone in the same Save action.
    • At the Business Journey level, a field named completed has been added to track the status of the workflow using the boolean values. True represents a completed Business Journey, whereas False indicates that the journey is in progress or is incomplete. Use the Search widget or an ADQL query for the desired Business Journey with the query string completed to view the status of the associated events.
    • As you create milestones, a flow map detailing the business workflow is now displayed in the Business Journey page. Additionally, selecting a Business Journey opens it in a new window with the flow map enabled. This behavior is controlled by the property in the Controller Settings.

Business Metrics

  • Enabling and disabling Business metrics are supported. Use the Enable and Disable button on the toolbar to do so.
  • Double-clicking a Business metric opens it in the Metric Browser.
  • Business Metrics list is now searchable.
  • Event Type column is added to the Metrics page.
  • Metric on ratios is supported.

Experience Level Management (XLM)

  • Visibility into XLM data is improved in the following ways:
    • You can now create XLM dashboards and reports in the time zone of your choice.
    • You can now export reports. Reports are exported in CSVformatCSV format, and contain however many reporting periods you choose.
  • You can now migrate XLM configurations from one environment to another. One common use case is when you first deploy a configuration in a staging or test environment and then need to migrate it to production.

    • This is done by making two API calls.

    1. Export XLM configuration(s) from one environment.

      • GET /controller/analytics/xlm/configuration

      • Optionally, supply a configuration ID, or a comma-delimited list of configuration IDs, as a query parameter. If this parameter is omitted, the API returns a bulk export of all XLM configurations.

    2. Import a single XLM configuration into another environment.

      • POST /controller/analytics/xlm/configuration

Log Analytics

  • You can now specify files to exclude from ingestion, by defining a glob pattern of file paths toblacklistto blacklist.
    • Here is a common two-step use case:
      1. Define a glob pattern to include all the files that you want to ingest
      2. Define an additional glob pattern to exclude (blacklist) files that satisfy the first glob pattern, but that you do not want to ingest 

Upgrade Notes

Upgrading the Analytics Agent

If you are running the Analytics Agent as a standalone binary, see this topic: Upgrade Analytics Agent.

If you are running the Analytics Agent through the Standalone Machine Agent, See Upgrade the Standalone Machine Agent for instructions. 

If you have been collecting log analytics data:

  1. Preserve the old watermark file so that you can copy it to the corresponding location in the new <analytics-agent-home> directory structure.
  2. Preserve your pre-existing job files so that you can copy them to the corresponding location in the new <analytics-agent-home> directory structure.

Field Names for Data Collectors

In versions prior to 4.3, Analytics used the actual HTTP parameter name to display the fields collected by Data Collectors. Beginning in 4.3, Analytics is using the configured display name for such fields.

When you upgrade to agents versions 4.3 or above, new HTTP parameter data will appear under the display name. If you had previously configured the display name to be different from the actual parameter name, your historical data and new data collected by the 4.3 or 4.4 agents for a single HTTP parameter will be split between the two field names.

Enabling Transaction Analytics

Beginning with 4.3 agents, you should enable Transaction Analytics exclusively using the Analytics Configuration UI. The Analytics Configuration UI allows for enabling Analytics at the Application level. You should no longer use the deprecated analytics-dynamic-service-enabled node property. 

If you change the analytics-dynamic-service-enabled node property through the Agent Configuration UI (updating the analytics-dynamic-service-enabled node property directly) it will have no effect on version 4.3 or higher Java Agents.
Related Background

Version 4.2 and earlier app server agents use the analytics-dynamic-service-enabled node property to enable Transaction Analytics. Using the node property directly allowed for disabling and enabling the Analytics Dynamic Service at the application, tier, and node levels. The Analytics Configuration UI allows for setting this property only at the Application level. Therefore, Java Agents 4.3 and higher are not able to disable or enable the Analytics Dynamic Service at the tier and node levels.

Although the Analytics Dynamic Service configurations can be directly changed through the application import and the Analytics Dynamic Service import REST API, manipulating the Analytics Dynamic Service configurations through either of those mechanisms only updates the Analytics Dynamic Service configurations and not the corresponding analytics-dynamic-service-enabled property. Therefore, if you use one of these import mechanisms to enable or disable the Analytics Dynamic Service and you have a mixture of old (pre 4.3) and new (4.3 and higher) agents, you must manually set the associated analytics-dynamic-service-enabled property to match the Analytics Dynamic Service configuration value. The analytics-dynamic-service-enabled node property can also be set as part of the Application Import and has its own Import REST API (accessed at POST /setAgentProperty). See "Import Application Analytics Dynamic Service Configuration" at Configuration Import and Export API.

Resolved Issues

ANALYTICS-4119Some unique identifiers of Funnel Widget are not exposed in the Event table in the Analytics Data tab
ANALYTICS-4534UI sometimes incorrectly shows "unhealthy" as status for Analytics Agent


Users assigned Analytics Administrator permissions through a Group cannot see searches saved by other users
ANALYTICS-4806Analytics Agent stops ingesting logs when log file rolls over
ANALYTICS-7554Duration settings for XLM synthetic sessions are in seconds, but should be in milliseconds

Known Issues

  • Metrics created from aggregations on eventTimestamp do not work as expected.
  • To deploy the Analytics Agent on Linux using the Universal Agent, you must use machine-agent mode.
  • (Windows : only) You can not delete a log file with the "del" command while the Analytics Agent is collecting log data from the file.
  • For Analytics Searches: 
    • In Basic mode, regular expressions and the NOT logical operator are not supported for free text search. 
    • In Basic mode, quotes and commas have no special meaning.
    • Saved Searches from 4.1 can be imported multiple times if you click 'Import from 4.1' button multiple times.
  • Due to timing issues, full information on business transactions might not appear immediately after running a Transaction Analytics search.
  • If you have deployed EUM such that you are using an on-premises Events Service for transaction and log analytics data, and the SaaS Events Service for your EUM data, you can not query the browser or mobile request data using the Analytics API.