Job File

Job File Location

To give DEXTER instructions on what to report, you create a job parameter file in simple JSON format.

DEXTER comes with DefaultJob.json job file in the folder with the binaries. Make a copy and edit that to produce job file suitable for your needs.

You can also use visual creator tool called DEXTER-UI to create job files.

Here are some Job File Examples for reference.

You can also watch this training video:

Job File Sections

AppDynamics DEXTER job input file contains 3 sections:

Section	Element	Purpose
Target		What Controller(s) and Applications(s) to query
	Controller
	UserName	Local or Token
	UserPassword	Local or Token
	Application
	NameRegex
	Type
Input		What to get, including time range and what to select, and what to convert to data warehouse CSVs
	TimeFrame	MarkDate, MarkTime and Duration to specify explicit or relative range of time
	TimeRange	From and To to specify explicit range of time
	UsersGroupsRolesPermissions
	Dashboards
	Licenses
	Events
	EventSelectionCriteria	Works with Events
	Configuration
	ConfigurationComparisonReferenceAPM	Works with Configuration
	ConfigurationComparisonReferenceWEB	Works with Configuration
	ConfigurationComparisonReferenceMOBILE	Works with Configuration
	ConfigurationComparisonReferenceDB	Works with Configuration
	DetectedEntities
	Metrics
	MetricsSelectionCriteria	Works with MetricsSets and IncludeHourAndMinuteDetail
	MetricsList
	Flowmaps
	EntityDashboards
	EntityDashboardSelectionCriteria	Works with EntityDashboards Tiers Tier Types Business Transactions Business Transaction Types Nodes Node Types Backends Backend Types
	Snapshots
	SnapshotSelectionCriteria	Works with Snapshots Tiers Tier Types Business Transactions Business Transaction Types User Experience Snapshot Type
Output		What reports to produce using input data
	UsersGroupsRolesPermissions
	Dashboards
	Licenses
	Events
	Configuration
	DetectedEntities
	EntityMetrics
	EntityMetricGraphs
	MetricsList
	Flowmaps
	EntityDashboards
	EntityDetails
	Snapshots
	IndividualSnapshots
	FlameGraphs
	HealthCheck
	ApplicationSummary

Target Section

Target parameter is a JSON array of custom JSON object pointing at Controller and specifying types and names of Applications to process.

Here is an example pointing at 2 Controllers to extract all APM Applications:

    "Target": [
        {
            "Controller": "http://demo1.appdynamics.com",
            "UserName": "username@customer1",
            "UserPassword": "",
            "Application": ".*",
            "NameRegex": true,
            "Type": "APM"
        },
        {
            "Controller": "http://demo2.appdynamics.com",
            "UserName": "username@customer1",
            "UserPassword": "",
            "Application": ".*",
            "NameRegex": true,
            "Type": "APM"
        }
    ]

Here is an example extracting only SIM Application information:

    "Target": [
        {
            "Controller": "http://demo1.appdynamics.com",
            "UserName": "username@customer1",
            "UserPassword": "",
            "Application": "DOES NOT MATTER",
            "NameRegex": false,
            "Type": "SIM"
        }
    ]

Here is an example extracting only DB Collector for "MyDatabaseCollector" collector:

    "Target": [
        {
            "Controller": "http://demo1.appdynamics.com",
            "UserName": "username@customer1",
            "UserPassword": "",
            "Application": "MyDatabaseCollector",
            "NameRegex": false,
            "Type": "DB"
        }
    ]

Controller (String)

URL of the controller, like https://yourcontroller.saas.appdynamics.com.

If your controller is using port number, append it after : like that: http://yourcontroller.yourdomain.com:8090.

Do not put /controller after the host portion https://yourcontroller.saas.appdynamics.com ~~/controller~~.

UserName (String)

Local User

Username of of the user to use to connect to Controller in <username>@<tenant> format.

Only AppDynamics authentication is supported. LDAP or SAML credentials can not be used.

appddexter@customer1 for user named appddexter and for single-tenant on-premises Controller.

appddexter@saastenant for user named appddexter in SaaS Controller saastenant.saas.appdynamics.com.

Client API Token

Client API tokens (https://docs.appdynamics.comdisplay/latest/API+Clients) are supported.

You must issue a token first through either API or UI.

To use token, set UserName to BEARER value (all UPPERCASE).

UserPassword (String)

Local User

Password of the user to connect to Controller

Leave blank to be prompted for password when extraction begins.

Client API Token

Specify access token here.

Application (String)

Application or Applications to query in the Controller

If NameRegex is false, interpreted as text.

If NameRegex is true, interpreted as Regular Expression.

MyAwesomeProduction == Matches just that MyAwesomeProduction application
ECommerce|Movie.* == Matches ECommerce, ECommerce-Fulfillment and Movie Tickets Online Applications
SOMETHING-NAM-S(G|B)69*|SOMETHING-NAM-SW == Matches SOMETHING-NAM-SW, SOMETHING-NAM-SB690 and SOMETHING-NAM-SG690 Applications
.* or * == Matches all applications in Controller

NameRegex (Boolean)

If true, the value in Application should be interpreted as Regular Expression.

If false, the value in Application is treated as literal string.

Type (String)

Specifies type of Application. Can be one of these:

APM
SIM
WEB
MOBILE
DB
BIQ

If empty, "APM" is assumed.

If type is "SIM" or "BIQ", values in ApplicationName and NameRegex are ignored.

Input Section

Input section is a JSON object specifying what to extract (Logical Model - Entities, Configuration rules, Metrics, Events, Snapshots, Flame Graphs) and what time range to operate on:

    "Input": {
        "TimeFrame": {
            "MarkDate": "TODAY",
            "MarkTime": "PREVIOUS_HOUR",
            "Duration": "1:00:00"
        },
        "UsersGroupsRolesPermissions": true,
        "Dashboards": true,
        "Licenses": true,
        "Events": true,
        "EventsSelectionCriteria": [ "All" ],
        "Configuration": true,
        "ConfigurationComparisonReferenceAPM": { "Controller": "", "Application": "" },
        "ConfigurationComparisonReferenceWEB": { "Controller": "", "Application": "" },
        "ConfigurationComparisonReferenceMOBILE": { "Controller": "", "Application": "" },
        "ConfigurationComparisonReferenceDB": { "Controller": "", "Application": "" },
        "DetectedEntities": true,
        "Metrics": true,
        "MetricsSelectionCriteria": {
            "MetricSets": [ "TransactionApplication", "TransactionTier", "TransactionNode", "TransactionBackend", "TransactionBT", "TransactionSEP", "TransactionError", "TransactionIP", "AgentStats", "OSHardware", "CLRStats", "IISStats", "IISReqCounts", "IISReqPerf", "JVMStats", "JMXDBConnStats", "JMXWebContainerStats", "BusinessTransactionPercentiles", 
            "BIQMetric", "BIQBizJourney",
            "DBKPI", "DBServerStats", "DBIO", "DBEngineStats",
            "WEBTransactionApplication", "WEBTransactionPage", "WEBTransactionAJAX", "WEBTransactionVirtualPage",
            "MOBILETransactionApplication", "MOBILETransactionNetworkRequest",
            "SIMHardware" ],
            "IncludeHourAndMinuteDetail": true
        },
        "MetricsList": true,
        "Flowmaps": true,
        "Snapshots": true,
        "EntityDashboards": true,
        "EntityDashboardSelectionCriteria": {
            "Tiers": [],
            "TierTypes": [ " All" ],
            "BusinessTransactions": [],
            "BusinessTransactionTypes": [ " All" ],
            "Nodes": [],
            "NodeTypes": [ " All" ],
            "Backends": [],
            "BackendTypes": [ " All" ]
        },
        "SnapshotSelectionCriteria": {
            "Tiers": [],
            "TierTypes": [ " All" ],
            "BusinessTransactions": [],
            "BusinessTransactionTypes": [ " All" ],
            "UserExperience": {
                "Normal": true, 
                "Slow": true, 
                "VerySlow": true, 
                "Stall": true, 
                "Error": true 
            },
            "SnapshotType": { 
                "Full": true, 
                "Partial": true, 
                "None": true
            }
        }
    }

TimeFrame

This is a new time range specifier supporting explicit and relative ranges.

When combined, MarkDate and MarkTime provide a point in time from which to count, and use Duration to specify the length of time period.

Duration can be either positive (start at the specified time and go forward) or negative (start at the specified time and count backwards).

MarkDate and MarkTime can be local or GMT, and support relative offset tokens, allowing queries like "Last 1 hour", "15 minutes in Previous hour" or "1 hour last Monday".

MarkDate

Specifies the Date component of DateTime indicating from which point to begin measuring.

Supports any standard .NET DateTime string https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings for date format as well as some relative tokens:

Date Value	Meaning of Setting
2020-05-05	May 5, local time
2020-05-05Z	May 5, GMT
TODAY	The current day, local time
TODAY_Z	The current day, GMT
YESTERDAY	Day before current day (today - 1 days)
YESTERDAY_Z	Day before current day, GMT
DAY_BEFORE_YESTERDAY	Day before yesterday (today - 2 days)
DAY_BEFORE_YESTERDAY_Z	Day before yesterday, GMT
SAME_DAY_LAST_WEEK	Week ago
SAME_DAY_LAST_WEEK_Z	Week ago, GMT
MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY	Specific day of the week, going back from today. If today is Wednesday, MONDAY will be this week's Monday (today - 2 days). If today is Wednesday, THURSDAY will be last week's Thursday (today - 6 days)
MONDAY_Z, TUESDAY_Z, WEDNESDAY_Z, THURSDAY_Z, FRIDAY_Z, SATURDAY_Z, SUNDAY_Z	Same as above, GMT

MarkTime

Specifies the Time component of DateTime indicating from which point to begin measuring.

Supports any standard .NET DateTime string https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings for time format as well as some relative tokens:

Time Value	Meaning of Setting
14:00:00	2PM, local time
14:00:00Z	2PM, GMT
00:00:00	Start of the day midnight, local time
00:00:00Z	Start of the day midnight, local time
07:15:00-04:00	7:15 AM Eastern Time (-4 hour offset)
NOW	Current time, rounded to the current minute, local time. If NOW is 15:32:35, NOW is 15:32:00
NOW_Z	Current time, rounded to the current minute, GMT
CURRENT_HOUR	Beginning of the current hour, local time. If NOW is 15:32:00, CURRENT_HOUR is 15:00:00
CURRENT_HOUR_Z	Beginning of the current hour, GMT
PREVIOUS_HOUR	Beginning of the previous hour, GMT. If NOW is 15:32:00, CURRENT_HOUR is 14:00:00
PREVIOUS_HOUR_Z	Beginning of the previous hour, GMT
DAY_OF_MONTH_#	Specific day of month. # is between 1 and 31. If month has less days, high number means the actual day
DAY_OF_MONTH_#_Z	Specific day of month, GMT

Duration

Specifies the Duration of time period before or after the DateTime indicating from which point to begin measuring.

Can be positive or negative and can be specified in either .NET TimeSpan or ISO 8601 Duration form.

Value of Duration must be at least 60 seconds long.

Duration in .NET TimeSpan Form

Duration supports standard .NET TimeSpan specifier https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-timespan-format-strings?view=netcore-3.1#the-constant-c-format-specifier:

[-][d.]hh:mm:ss[.fffffff]

Elements in square brackets ([ and ]) are optional. The period (.) and colon (:) are literal symbols. The following table describes the remaining elements.

Element	Description
`-`	An optional negative sign, which indicates a negative time interval.
`d`	The optional number of days, with no leading zeros.
`hh`	The number of hours, which ranges from "00" to "23".
`mm`	The number of minutes, which ranges from "00" to "59".
`ss`	The number of seconds, which ranges from "0" to "59".

Duration Value	Meaning of Setting
0:15 or 0:15:00	15 minutes
-0:15 or -0:15:00	Negative 15 minutes
1:00 or 1:00:00	1 hour
1:15 or 1:15:00	1 hour 15 minutes
1.01:15 or 1.01:15:00	1 day, 1 hour 15 minutes
1.01:15:15	1 day, 1 hour, 15 minutes and 15 seconds

Duration in ISO 8601 Duration

Supports positive or negative standard ISO 8601 Duration specifiers https://en.wikipedia.org/wiki/ISO_8601:

P[n]Y[n]M[n]DT[n]H[n]M[n]S

P is the duration designator (for period) placed at the start of the duration representation.
Y is the year designator that follows the value for the number of years.
M is the month designator that follows the value for the number of months.
W is the week designator that follows the value for the number of weeks.
D is the day designator that follows the value for the number of days.
T is the time designator that precedes the time components of the representation.
H is the hour designator that follows the value for the number of hours.
M is the minute designator that follows the value for the number of minutes.
S is the second designator that follows the value for the number of seconds.

Duration Value	Meaning of Setting
PT15M	15 minutes
-PT15M	Negative 15 minutes
PT1H or PT60M	1 hour
PT1H15M or PT75M	1 hour 15 minutes
P1DT1H15M or PT1515M	1 day, 1 hour 15 minutes
P1DT1H15M15S	1 day, 1 hour, 15 minutes and 15 seconds

TimeFrame Examples

Explicit Time Range - 1 Hour

1 hour time range starting at specified time.

        "TimeFrame": {
            "MarkDate": "2020-05-05",
            "MarkTime": "14:00:00",
            "Duration": "1:00:00"
        },

This is equivalent to:

        "TimeFrame": {
            "MarkDate": "2020-05-05",
            "MarkTime": "14:00:00",
            "Duration": "PT1H"
        },

Explicit Time Range - 24 hours

1 hour time range ending at specified time.

        "TimeFrame": {
            "MarkDate": "2020-05-05",
            "MarkTime": "00:00:00",
            "Duration": "-1.00:00:00"
        },

This is equivalent to:

        "TimeFrame": {
            "MarkDate": "2020-05-05",
            "MarkTime": "00:00:00",
            "Duration": "-P1D"
        },

Explicit Time Range - 1 Hour, GMT

1 hour time range starting at specified time in GMT.

        "TimeFrame": {
            "MarkDate": "2020-05-05Z",
            "MarkTime": "14:00:00Z",
            "Duration": "1:00:00"
        },

Last 1 Full Hour Today

Last 15 minutes.

If NOW is 15:32, the time range that will be extracted is 15:17-15:32.

        "TimeFrame": {
            "MarkDate": "TODAY",
            "MarkTime": "NOW",
            "Duration": "-0:15:00"
        },

Last 1 Full Hour Today

Last full hour.

If NOW is 15:32, the time range that will be extracted is 14:00-15:00.

        "TimeFrame": {
            "MarkDate": "TODAY",
            "MarkTime": "PREVIOUS_HOUR",
            "Duration": "1:00:00"
        },

This can also be specified this way:

        "TimeFrame": {
            "MarkDate": "TODAY",
            "MarkTime": "CURRENT_HOUR",
            "Duration": "-1:00:00"
        },

Last Monday, Business Hours, Local Time

Go to the last Monday and pull 9-5 duration:

        "TimeFrame": {
            "MarkDate": "MONDAY",
            "MarkTime": "09:00:00",
            "Duration": "8:00:00"
        },

Last Monday, Business Hours, GMT

Go to the last Monday and pull 9-5 duration:

        "TimeFrame": {
            "MarkDate": "MONDAY_Z",
            "MarkTime": "09:00:00Z",
            "Duration": "8:00:00"
        },

TimeRange

Usage of TimeRange specifier is discouraged in favor of using TimeFrame specifier.

If TimeFrame is not provided, this setting is used as fallback.

From and To

Specifies beginning and end of the time range to retrieve data for.

The values in From and To must conform to any standard .NET DateTime string https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings

Both local or GMT times are supported. For example:

DateTime Value	Meaning of Setting
2020-09-19T07:00:00	September 19, 7:00 AM local time
2020-09-19T07:00:00-04:00	September 19, 7:00 AM Eastern Time (-4 hour offset)
2020-09-19T14:00:00Z	September 19, 14:00 PM GMT (same as 7am Pacific)

TimeRange Examples

Using local time:

        "TimeRange": {
            "From": "2020-04-22T16:00:00",
            "To": "2020-04-22T17:00:00"
        },

Using UTC time:

        "TimeRange": {
            "From": "2020-04-22T16:00:00Z",
            "To": "2020-04-22T17:00:00Z"
        },

UsersGroupsRolesPermissions (Boolean)

Specifies whether to extract and index Users, Groups, Roles and Permissions for the Controller.

Dashboards (Boolean)

Specifies whether to extract and index Dashboards, Widgets and Time Series used by Widgets for the Controller.

Licenses (Boolean)

Specifies whether to extract and index informaiton about global account and license rule configuration and consumption for Controller.

Events (Boolean)

Specifies whether to extract and index Events and Health Rule Violations for All Applications, Controller Notifications and Controller Audit Events.

EventsSelectionCriteria (Array of Strings)

Selects which event types to extract.

Empty array [] means no events will be extracted.

Value of [ "All" ] means all known event types will be extracted. All other members of array will be ignored.

Event Types are defined in EVENT_TYPES

For example, to extract just a few event types, specify this array:

    "EventsSelectionCriteria": [
      "APPLICATION_CONFIG_CHANGE",
      "APPLICATION_ERROR",
      "APP_SERVER_RESTART",
      "POLICY_OPEN_WARNING"
    ]

Health Rule violations, Controller Audit and Controller Notifications events are always be extracted.

Configuration (Boolean)

Specifies whether to extract and index configuration (BT rules, Backend rules, Data Collectors for APM, Web Page Rules for Web, and so on).

ConfigurationComparisonReferenceAPM\Controller and ConfigurationComparisonReferenceAPM\Application (String)

Specifies which APM Application to use as reference during configuration comparison. This Application must also be specified as a valid Target.

If Controller and Application are blank, then configuration comparison is performed against a blank template application.

ConfigurationComparisonReferenceWEB\Controller and ConfigurationComparisonReferenceWEB\Application (String)

Specifies which WEB Application to use as reference during configuration comparison. This Application must also be specified as a valid Target.

If Controller and Application are blank, then configuration comparison is performed against a blank template application.

ConfigurationComparisonReferenceMOBILE\Controller and ConfigurationComparisonReferenceMOBILE\Application (String)

Specifies which MOBILE Application to use as reference during configuration comparison. This Application must also specified as a valid Target.

If Controller and Application are blank, then configuration comparison is performed against a blank template application.

ConfigurationComparisonReferenceDB\Controller and ConfigurationComparisonReferenceDB\Application (String)

Specifies which DB Application to use as reference during configuration comparison. This Application must also be specified as a valid Target.

If Controller and Application are blank, then configuration comparison is performed against a blank template application.

DetectedEntities (Boolean)

Specifies whether to extract and index list of detected entities (Business Transactions, Tiers, Nodes for APM, Web pages for EUM and so on).

Metrics (Boolean)

Specified whether to extract and index summary and detail metrics for all APM Entities, which are used in Entity Metrics, Entity Metric Graphs and Entity Details report

Used in conjunction with MetricsSelectionCriteria.

MetricsSelectionCriteria

Provides filtering abilities for the metric extraction.

MetricSets (Array of Strings)

Selects which sets of metrics export for APM Entities.

Empty array [] means no metrics will be extracted.

Metric sets are defined in EntityMetricsExtractMapping.csv, column "MetricSet". See Metric Sets for details on how to add your own metrics and customize graphs.

IncludeHourAndMinuteDetail (Boolean)

Specifies whether to extract granular metric detail.

MetricsList (Boolean)

Specifies whether to extract and index list of registered and reporting metrics for APM Applications.

Flowmaps (Boolean)

Specifies whether to extract and index flow maps for APM Entities (Application, Tier, Node, Business Transaction and Backend).

EntityDashboards (Boolean)

Specifies whether to take screenshots of the main screen for APM Entities (Application, Tier, Node, Business Transaction and Backend).

EntityDashboardSelectionCriteria

Provides filtering abilities for the taking screenshots of dashboards.

EntityDashboardSelectionCriteria\Tiers (Array of Strings)

Filters screenshot taking to only ones these Tiers.

Regular expressions are supported.

EntityDashboardSelectionCriteria\TierTypes (Array of Strings)

Selects which Tier types to include for screnshots.

Empty array [] means no Tiers will be processed.

Value of [ "All" ] means all types of Tiers will be processed. All other members of array will be ignored.

Valid values:

All
APP_AGENT
DOT_NET_APP_AGENT
NATIVE_APP_AGENT
NATIVE_DYNAMIC
NATIVE_SDK
NATIVE_WEB_SERVER
NODEJS_APP_AGENT
PHP_APP_AGENT
PYTHON_APP_AGENT
RUBY_APP_AGENT

For example, to extract just a few types of Tiers, specify this array:

    "TierTypes": [
      "APP_AGENT",
      "NODEJS_APP_AGENT"
    ]

EntityDashboardSelectionCriteria\BusinessTransactions (Array of Strings)

Filters screenshot taking to only ones these Business Transactions.

Regular expressions are supported.

[] - Empty array means all Business Transactions will be matched
["Web-Main"] - specifies that only "Web-Main" Business Transaction will match
["Web-.*"] – specified that any Business Transactions that match specified Regex will match
["Web.*", "SomeService", "XYX.*"] – array of settings mixing exact match and Regex match

EntityDashboardSelectionCriteria\BusinessTransactionTypes (Array of Strings)

Selects which Business Transaction types to include for screnshots.

Empty array [] means no Business Transactions will be processed.

Value of [ "All" ] means all types of Business Transactions will be processed. All other members of array will be ignored.

Valid values:

All
SERVLET
HTTP
WEB_SERVICE
POJO
JMS
EJB
SPRING_BEAN
STRUTS_ACTION
ASP_DOTNET
ASP_DOTNET_WEB_SERVICE
DOTNET_REMOTING
WCF
DOTNET_JMS
POCO
PHP_WEB
PHP_MVC
PHP_DRUPAL
PHP_WORDPRESS
PHP_CLI
PHP_WEB_SERVICE
NODEJS_WEB
NATIVE
WEB
PYTHON_WEB
RUBY_WEB
RUBY_RAILS
BINARY_REMOTING

For example, to extract just a few types of Business Transactions, specify this array:

    "BusinessTransactionTypes": [
      "SERVLET",
      "ASP_DOTNET"
    ]

EntityDashboardSelectionCriteria\Nodes (Array of Strings)

Filters screenshot taking to only ones these Nodes.

Regular expressions are supported.

EntityDashboardSelectionCriteria\NodeTypes (Array of Strings)

Selects which Node types to include for screnshots.

Empty array [] means no Nodes will be processed.

Value of [ "All" ] means all types of Nodes will be processed. All other members of array will be ignored.

Valid values:

All
APP_AGENT
DOT_NET_APP_AGENT
NATIVE_APP_AGENT
NATIVE_DYNAMIC
NATIVE_SDK
NATIVE_WEB_SERVER
NODEJS_APP_AGENT
PHP_APP_AGENT
PYTHON_APP_AGENT
RUBY_APP_AGENT

For example, to extract just a few types of Nodes, specify this array:

    "NodeTypes": [
      "APP_AGENT",
      "NODEJS_APP_AGENT"
    ]

EntityDashboardSelectionCriteria\Backends (Array of Strings)

Filters screenshot taking to only ones these Backends.

Regular expressions are supported.

EntityDashboardSelectionCriteria\BackendTypes (Array of Strings)

Selects which Backend types to include for screnshots.

Empty array [] means no Backends will be processed.

Value of [ "All" ] means all types of Backends will be processed. All other members of array will be ignored.

Valid values:

All
SOCKET
HTTP
CUSTOM
CUSTOM_ASYNC
FILE_SERVER
MAIL_SERVER
WEB_SERVICE
ERP
CACHE
WEBSPHERE_MQ
MAINFRAME
TIBCO_ASYNC
TIBCO
ESB
SAP
AVRO
THRIFT
CASSANDRA
MQ
JMS
WEBSOCKET
JDBC
RMI
LDAP
CORBA
RABBITMQ
ADODOTNET
DOTNETDirectoryServices
DOTNETRemoting
DOTNETMessaging
WCF
MSMQ
DB
NETWORK

For example, to extract just a few types of Backends, specify this array:

    "BackendTypes": [
      "HTTP",
      "WEB_SERVICE"
    ]

Snapshots (Boolean)

Specifies whether to retrieve Snapshots for APM aplications.

Used in conjunction with all settings in SnapshotSelectionCriteria.

SnapshotSelectionCriteria

Provides filtering abilities for the snapshot extraction.

SnapshotSelectionCriteria\Tiers (Array of Strings)

Filters Snapshots to be extracted to only ones originating from these Tiers.

Regular expressions are supported.

[] - Empty array means all Tiers will be matched
["ECommerce"] - specifies that ECommerce Tier will match
["ECommerce.*"] - specifies that any Tiers that match specified Regex will match, such as ECommerce and ECommerce-Inventory
["Web", "App", "Middle.*"] – array of settings mixing exact match and Regex match, such as Web, App and Middleware

SnapshotSelectionCriteria\TierTypes (Array of Strings)

Selects which Tier types to include for snapshot extraction.

Empty array [] means no Tiers will be processed.

Value of [ "All" ] means all types of Tiers will be processed. All other members of array will be ignored.

Valid values:

All
APP_AGENT
DOT_NET_APP_AGENT
NATIVE_APP_AGENT
NATIVE_DYNAMIC
NATIVE_SDK
NATIVE_WEB_SERVER
NODEJS_APP_AGENT
PHP_APP_AGENT
PYTHON_APP_AGENT
RUBY_APP_AGENT

For example, to extract just a few types of Tiers, specify this array:

    "TierTypes": [
      "APP_AGENT",
      "NODEJS_APP_AGENT"
    ]

SnapshotSelectionCriteria\BusinessTransactions (Array of Strings)

Filters Snapshots to be extracted to only ones originating from these Business Transactions.

Regular expressions are supported.

[] - Empty array means all Business Transactions will be matched
["Web-Main"] - specifies that only "Web-Main" Business Transaction will match
["Web-.*"] – specified that any Business Transactions that match specified Regex will match
["Web.*", "SomeService", "XYX.*"] – array of settings mixing exact match and Regex match

SnapshotSelectionCriteria\BusinessTransactionTypes (Array of Strings)

Selects which Business Transaction types to include for snapshot extraction.

Empty array [] means no Business Transactions will be processed.

Value of [ "All" ] means all types of Business Transactions will be processed. All other members of array will be ignored.

Valid values:

All
SERVLET
HTTP
WEB_SERVICE
POJO
JMS
EJB
SPRING_BEAN
STRUTS_ACTION
ASP_DOTNET
ASP_DOTNET_WEB_SERVICE
DOTNET_REMOTING
WCF
DOTNET_JMS
POCO
PHP_WEB
PHP_MVC
PHP_DRUPAL
PHP_WORDPRESS
PHP_CLI
PHP_WEB_SERVICE
NODEJS_WEB
NATIVE
WEB
PYTHON_WEB
RUBY_WEB
RUBY_RAILS
BINARY_REMOTING

For example, to extract just a few types of Business Transactions, specify this array:

    "BusinessTransactionTypes": [
      "SERVLET",
      "ASP_DOTNET"
    ]

SnapshotSelectionCriteria\RequestIDs (Array of Strings)

Selects which Business Transaction snapshots identified by the RequestID GUID to extract.

Empty array [] means all Business Transactions will be processed.

SnapshotSelectionCriteria\UserExperience[Setting] (Boolean)

Contains settings for filtering by Snapshot User Experience:

Normal
Slow
VerySlow
Stall
Error

SnapshotSelectionCriteria\SnapshotType[Setting] (Boolean)

Contains settings for filtering by Snapshot Type:

Full
Partial
None

Output Section

Output section is a JSON object specifying what reports to render (logical model, Configuration rules, Metrics, Events, Snapshots, Flame Graphs).

    "Output": {
        "UsersGroupsRolesPermissions": true,
        "Dashboards": true,
        "Licenses": false,
        "Events": true,
        "Configuration": true,
        "DetectedEntities": true,
        "EntityMetrics": true,
        "EntityMetricGraphs": true,
        "MetricsList": true,
        "Flowmaps": true,
        "EntityDashboards": true,
        "EntityDetails": true,
        "Snapshots": true,
        "FlameGraphs": true,
        "HealthCheck": false,
        "ApplicationSummary": false
    }

UsersGroupsRolesPermissions (Boolean)

Specifies whether to render Users and Permissions report for Users, Groups, Roles and Permissions in Controller

Dashboards (Boolean)

Specifies whether to render Dashboards Report report for Controller Dashboards, Widgets and Time Series used by Widgets.

Licenses (Boolean)

Specifies whether to render Licenses Report report for global account and license rule configuration and consumption for Controller.

Events (Boolean)

Specifies whether to render Events and Health Rule Violations report.

Configuration (Boolean)

Specifies whether to render Configuration report.

DetectedEntities (Boolean)

Specifies whether to render:

Detected APM Entities report for APM applications
Detected SIM Entities report for SIM applications
Detected DB Entities report for DB Collectors
Detected WEB Entities report for WEB applications
Detected MOBILE Entities report for MOBILE applications
Detected BIQ Entities report for BIQ applications

EntityMetrics (Boolean)

Specifies whether to render Entity Metrics report.

EntityMetricGraphs (Boolean)

Specifies whether to render Entity Metrics Graphs report.

MetricsList (Boolean)

Specifies whether to render Registered APM Metrics report for APM Applications.

Flowmaps (Boolean)

Specifies whether to render Entity Flowmaps report.

EntityDashboards (Boolean)

Specifies whether to render Entity Dashboards report.

EntityDetails (Boolean)

Specifies whether to render Entity Details report for Entities that have some metric or snapshot activity.

Snapshots (Boolean)

Specifies whether to render Snapshots and Snapshots Method Calls reports.

IndividualSnapshots (Boolean)

Specifies whether to render Individual Snapshot report.

Works on the SnapshotSelectionCriteria\RequestIDs or on list of requests specified in --request-ids and --report-folder command line.

FlameGraphs (Boolean)

Specifies whether to render Flame Graphs and Flame Charts reports for APM Applications, Tiers, Nodes and Business Transactions.

HealthCheck (Boolean)

Specifies whether to render Health Check reports for Platform health and APM Applications.

ApplicationSummary (Boolean)

Specifies whether to render Application Summary report for APM Applications.