-
Notifications
You must be signed in to change notification settings - Fork 48
Job File Examples
Reference | Explanation |
---|---|
Example 1 - Single Application | Simplest example with one APM Application |
Example 2 - Multiple Applications, Single Controller | Two APM Applications |
Example 3 - Multiple Applications, Regex, Single Controller | All APM Applications with regex |
Example 4 - Multiple Application, Multiple Controllers | All APM Applications with regex, multiple Controllers |
Example 5 - Filtering Which Snapshots to Get | Shows how to use SnapshotSelectionCriteria |
Example 6 - All Application Types | All Application types |
Example 7 - Comparing 2 APM Applications | Comparing 2 APM Application Configurations |
Example 8 - Getting License Information and Agent License Usage Usage | Getting License Information and Agent License Usage Usage |
Example 9 - Minimum Necessary for Health Check | Performing Health Check |
ECommerce APM Application from demo1 Controller, taking every type of data for 1 hour starting at beginning of past hour and building every kind of report:
{
"Target":
[
{
"Controller": "http://demo1.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": "ECommerce",
"NameRegex": false,
"Type": "APM"
}
],
"Input": {
"TimeFrame": {
"MarkDate": "TODAY",
"MarkTime": "PREVIOUS_HOUR",
"Duration": "1:00:00"
},
"UsersGroupsRolesPermissions": true,
"Dashboards": 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,
"EntityDashboards": true,
"EntityDashboardSelectionCriteria": {
"Tiers": [],
"TierTypes": [ "All" ],
"BusinessTransactions": [],
"BusinessTransactionTypes": [ "All" ],
"Nodes": [],
"NodeTypes": [ "All" ],
"Backends": [],
"BackendTypes": [ "All" ]
},
"Snapshots": true,
"SnapshotSelectionCriteria": {
"Tiers": [],
"TierTypes": [ "All" ],
"BusinessTransactions": [],
"BusinessTransactionTypes": [ "All" ],
"RequestIDs": [],
"UserExperience": {
"Normal": true,
"Slow": true,
"VerySlow": true,
"Stall": true,
"Error": true
},
"SnapshotType": {
"Full": true,
"Partial": true,
"None": true
}
}
},
"Output": {
"UsersGroupsRolesPermissions": true,
"Dashboards": true,
"Events": true,
"Configuration": true,
"DetectedEntities": true,
"EntityMetrics": true,
"EntityMetricGraphs": true,
"MetricsList": true,
"Flowmaps": true,
"EntityDashboards": true,
"EntityDetails": true,
"Snapshots": true,
"IndividualSnapshots": false,
"FlameGraphs": true,
"ApplicationSummary": true
}
}
ECommerce and ECommerce-Fulfillment APM Applications from demo1 Controller, taking every type of data out and building every kind of report:
{
"Target":
[
{
"Controller": "http://demo1.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": "ECommerce",
"NameRegex": false,
"Type": "APM"
},
{
"Controller": "http://demo1.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": "ECommerce-Fulfillment",
"NameRegex": false,
"Type": "APM"
}
],
"Input": {
"TimeFrame": {
"MarkDate": "TODAY",
"MarkTime": "PREVIOUS_HOUR",
"Duration": "1:00:00"
},
"UsersGroupsRolesPermissions": true,
"Dashboards": 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,
"EntityDashboards": true,
"EntityDashboardSelectionCriteria": {
"Tiers": [],
"TierTypes": [ "All" ],
"BusinessTransactions": [],
"BusinessTransactionTypes": [ "All" ],
"Nodes": [],
"NodeTypes": [ "All" ],
"Backends": [],
"BackendTypes": [ "All" ]
},
"Snapshots": true,
"SnapshotSelectionCriteria": {
"Tiers": [],
"TierTypes": [ "All" ],
"BusinessTransactions": [],
"BusinessTransactionTypes": [ "All" ],
"RequestIDs": [],
"UserExperience": {
"Normal": true,
"Slow": true,
"VerySlow": true,
"Stall": true,
"Error": true
},
"SnapshotType": {
"Full": true,
"Partial": true,
"None": true
}
}
},
"Output": {
"UsersGroupsRolesPermissions": true,
"Dashboards": true,
"Events": true,
"Configuration": true,
"DetectedEntities": true,
"EntityMetrics": true,
"EntityMetricGraphs": true,
"MetricsList": true,
"Flowmaps": true,
"EntityDashboards": true,
"EntityDetails": true,
"Snapshots": true,
"IndividualSnapshots": false,
"FlameGraphs": true,
"ApplicationSummary": true
}
}
All APM Applications from demo1 Controller, taking every type of data out and building every kind of report:
{
"Target":
[
{
"Controller": "http://demo1.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": ".*",
"NameRegex": true,
"Type": "APM"
}
],
"Input": {
"TimeFrame": {
"MarkDate": "TODAY",
"MarkTime": "PREVIOUS_HOUR",
"Duration": "1:00:00"
},
"UsersGroupsRolesPermissions": true,
"Dashboards": 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,
"EntityDashboards": true,
"EntityDashboardSelectionCriteria": {
"Tiers": [],
"TierTypes": [ "All" ],
"BusinessTransactions": [],
"BusinessTransactionTypes": [ "All" ],
"Nodes": [],
"NodeTypes": [ "All" ],
"Backends": [],
"BackendTypes": [ "All" ]
},
"Snapshots": true,
"SnapshotSelectionCriteria": {
"Tiers": [],
"TierTypes": [ "All" ],
"BusinessTransactions": [],
"BusinessTransactionTypes": [ "All" ],
"RequestIDs": [],
"UserExperience": {
"Normal": true,
"Slow": true,
"VerySlow": true,
"Stall": true,
"Error": true
},
"SnapshotType": {
"Full": true,
"Partial": true,
"None": true
}
}
},
"Output": {
"UsersGroupsRolesPermissions": true,
"Dashboards": true,
"Events": true,
"Configuration": true,
"DetectedEntities": true,
"EntityMetrics": true,
"EntityMetricGraphs": true,
"MetricsList": true,
"Flowmaps": true,
"EntityDashboards": true,
"EntityDetails": true,
"Snapshots": true,
"IndividualSnapshots": false,
"FlameGraphs": true,
"ApplicationSummary": true
}
}
All Applications from demo1 and demo2 Controllers, taking every type of data out and building every kind of report:
{
"Target":
[
{
"Controller": "http://demo1.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": "*",
"NameRegex": true,
"Type": "APM"
},
{
"Controller": "http://demo1.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": ".*",
"NameRegex": true,
"Type": "APM"
}
],
"Input": {
"TimeFrame": {
"MarkDate": "TODAY",
"MarkTime": "PREVIOUS_HOUR",
"Duration": "1:00:00"
},
"UsersGroupsRolesPermissions": true,
"Dashboards": 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,
"EntityDashboards": true,
"EntityDashboardSelectionCriteria": {
"Tiers": [],
"TierTypes": [ "All" ],
"BusinessTransactions": [],
"BusinessTransactionTypes": [ "All" ],
"Nodes": [],
"NodeTypes": [ "All" ],
"Backends": [],
"BackendTypes": [ "All" ]
},
"Snapshots": true,
"SnapshotSelectionCriteria": {
"Tiers": [],
"TierTypes": [ "All" ],
"BusinessTransactions": [],
"BusinessTransactionTypes": [ "All" ],
"RequestIDs": [],
"UserExperience": {
"Normal": true,
"Slow": true,
"VerySlow": true,
"Stall": true,
"Error": true
},
"SnapshotType": {
"Full": true,
"Partial": true,
"None": true
}
}
},
"Output": {
"UsersGroupsRolesPermissions": true,
"Dashboards": true,
"Events": true,
"Configuration": true,
"DetectedEntities": true,
"EntityMetrics": true,
"EntityMetricGraphs": true,
"MetricsList": true,
"Flowmaps": true,
"EntityDashboards": true,
"EntityDetails": true,
"Snapshots": true,
"IndividualSnapshots": false,
"FlameGraphs": true,
"ApplicationSummary": true
}
}
Use the following example to retrieve only Snapshots that match the following criteria, and build Entities, Snapshots, Call Graphs, Flame Graphs and Entity Details reports.
- Come from "Web" tier
- Comes from .NET Agent tier type
- Comes from "/api/data", "Login-AuthenticationEngine", "Web-List-.*", "Async-Svc.SendEmailActivityService" Business Transactions, including regular expression matches
- Comes from ASP.NET and WCF Business Transaction types
- Are any user experience except Normal
- Are only Full call graphs
{
"Target":
[
{
"Controller": "https://account.saas.appdynamics.com",
"UserName": "username@account",
"UserPassword": "",
"Application": "ABCDEFG",
"NameRegex": false,
"Type": "APM"
}
],
"Input": {
"TimeFrame": {
"MarkDate": "TODAY",
"MarkTime": "PREVIOUS_HOUR",
"Duration": "1:00:00"
},
"DetectedEntities": true,
"Snapshots": true,
"SnapshotSelectionCriteria": {
"Tiers" : [ "Web" ],
"TierTypes": [ "DOT_NET_APP_AGENT" ],
"BusinessTransactions" : [
"/api/data",
"Login-AuthenticationEngine",
"Web-List-.*",
"Async-Svc.SendEmailActivityService" ],
"BusinessTransactionTypes": [ "ASP_DOTNET", "WCF" ],
"RequestIDs": [],
"UserExperience": {
"Normal": false,
"Slow": true,
"VerySlow": true,
"Stall": true,
"Error": true
},
"SnapshotType": {
"Full": true,
"Partial": false,
"None": false
}
}
},
"Output": {
"DetectedEntities": true,
"EntityDetails": true,
"Snapshots": true,
"FlameGraphs": true
}
}
Extracting all Application Types, not just APM:
{
"Target":
[
{
"Controller": "http://demo1.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": "*",
"NameRegex": true,
"Type": "APM"
},
{
"Controller": "http://demo1.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": ".*",
"NameRegex": true,
"Type": "WEB"
},
{
"Controller": "http://demo1.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": ".*",
"NameRegex": true,
"Type": "MOBILE"
},
{
"Controller": "http://demo1.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": "The name of BIQ Application does not matter - there is only one in every Controller",
"NameRegex": false,
"Type": "BIQ"
},
{
"Controller": "http://demo1.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": "The name of SIM Application does not matter - there is only one in every Controller",
"NameRegex": false,
"Type": "SIM"
},
{
"Controller": "http://demo1.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": ".*",
"NameRegex": true,
"Type": "DB"
}
],
"Input": {
"TimeFrame": {
"MarkDate": "TODAY",
"MarkTime": "PREVIOUS_HOUR",
"Duration": "1:00:00"
},
"UsersGroupsRolesPermissions": true,
"Dashboards": true,
"Events": true,
"EventsSelectionCriteria": [ "All" ],
"Configuration": true,
"ConfigurationComparisonReferenceAPM": { "Controller": "", "Application": "" },
"ConfigurationComparisonReferenceWEB": { "Controller": "", "Application": "" },
"ConfigurationComparisonReferenceMOBILE": { "Controller": "", "Application": "" },
"ConfigurationComparisonReferenceDB": { "Controller": "", "Application": "" },
"DetectedEntities": 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" ]
},
"Snapshots": true,
"SnapshotSelectionCriteria": {
"Tiers": [],
"TierTypes": [ "All" ],
"BusinessTransactions": [],
"BusinessTransactionTypes": [ "All" ],
"RequestIDs": [],
"UserExperience": {
"Normal": true,
"Slow": true,
"VerySlow": true,
"Stall": true,
"Error": true
},
"SnapshotType": {
"Full": true,
"Partial": true,
"None": true
}
}
},
"Output": {
"UsersGroupsRolesPermissions": true,
"Dashboards": true,
"Events": true,
"Configuration": true,
"DetectedEntities": true,
"EntityMetrics": true,
"EntityMetricGraphs": true,
"MetricsList": true,
"Flowmaps": true,
"EntityDashboards": true,
"EntityDetails": true,
"Snapshots": true,
"IndividualSnapshots": false,
"FlameGraphs": true,
"ApplicationSummary": true
}
}
ECommerce APM and EUM Applications from demo1 and demo2 Controllers, producing Configuration Comparison report comparing demo1 to demo2:
{
"Target":
[
{
"Controller": "http://demo1.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": "ECommerce",
"NameRegex": false,
"Type": "APM"
},
{
"Controller": "http://demo2.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": "ECommerce-Fulfillment",
"NameRegex": false,
"Type": "APM"
},
{
"Controller": "http://demo1.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": "ECommerce-EUM",
"NameRegex": false,
"Type": "WEB"
},
{
"Controller": "http://demo2.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": "ECommerce-Fulfillment-EUM",
"NameRegex": false,
"Type": "WEB"
}
],
"Input": {
"TimeFrame": {
"MarkDate": "TODAY",
"MarkTime": "PREVIOUS_HOUR",
"Duration": "1:00:00"
},
"Configuration": true,
"ConfigurationComparisonReferenceAPM": { "Controller": "http://demo1.appdynamics.com", "Application": "ECommerce" },
"ConfigurationComparisonReferenceWEB": { "Controller": "http://demo1.appdynamics.com", "Application": "ECommerce-EUM" },
"ConfigurationComparisonReferenceMOBILE": { "Controller": "", "Application": "" },
"ConfigurationComparisonReferenceDB": { "Controller": "", "Application": "" },
"DetectedEntities": true
},
"Output": {
"Configuration": true,
"DetectedEntities": true
}
}
ECommerce APM Applications from demo1 and demo2 Controllers, producing full controller license consumption and per-APM agent breakdowns for 1 last week
{
"Target":
[
{
"Controller": "http://demo1.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": "ECommerce",
"NameRegex": false,
"Type": "APM"
},
{
"Controller": "http://demo2.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": "ECommerce-Fulfillment",
"NameRegex": false,
"Type": "APM"
}
],
"Input": {
"TimeFrame": {
"MarkDate": "MONDAY",
"MarkTime": "00:00:00",
"Duration": "7.0:00:00"
},
"Licenses": true,
"DetectedEntities": true,
"Metrics": true,
"MetricsSelectionCriteria": {
"MetricSets": [ "AgentStats" ],
"IncludeHourAndMinuteDetail": true
},
},
"Output": {
"DetectedEntities": true,
"EntityMetrics": true,
"Licenses": true
}
}
ECommerce APM Application from demo1 Controller, taking only the items necessary to perform Health Check report.
{
"Input":
{
"TimeRange":
{
"From": "2020-04-15T17:00:00",
"To": "2020-04-15T18:00:00"
},
"Configuration": true,
"Metrics": true,
"MetricsSelectionCriteria": {
"MetricSets":
[
"TransactionApplication",
"TransactionTier",
"TransactionNode",
"TransactionBackend",
"TransactionBT",
"TransactionSEP",
"TransactionError"
],
"IncludeHourAndMinuteDetail": true
},
"DetectedEntities": true
},
"Output":
{
"HealthCheck": true,
"DetectedEntities": true,
"Configuration": true
},
"Target":
[
{
"Controller": "http://demo1.appdynamics.com/",
"UserName": "username@customer1",
"UserPassword": "",
"Application": "ECommerce",
"NameRegex": false,
"Type": "APM"
}
]
}
- Home
- Getting Started Walkthrough
- Run
-
Excel Reports
- Detected APM Entities
- Detected SIM Entities
- Detected DB Entities
- Detected WEB Entities
- Detected MOBILE Entities
- Detected BIQ Entities
- Entity Metrics
- Entity Metric Graphs
- Registered APM Metrics
- Entity Flowmaps
- Configuration
- Events and Health Rule Violations
- Entity Details
- Snapshots
- Snapshot Method Calls
- Individual Snapshot
- Users and Permissions
- Dashboards
- Health Check
- PowerBI Reports
- Tableau Reports
- Browser Reports