Integrating with CA APM
You can view the collected data in various BMC Helix application and derive the following benefits:
BMC Helix application | Type of data collected or viewed | Benefits |
---|---|---|
BMC Helix Operations Management | Events ( alerts received as events) | Use a centralized event view to monitor, filter, and manage events, and perform event operations in one place. Process events to help identify actionable events quickly from a large volume of event data. For more information, see Monitoring events and reducing event noise. |
BMC Helix Operations Management | Metrics | Use alarm and variate policies to detect anomalies and eliminate false positives for more accurate results while monitoring the health of your system. For more information, see Detecting anomalies by using static and dynamic thresholds. |
BMC Helix Discovery | Topology | Collect all CIs from CA APM as is in BMC Helix Discovery. Create services from the CIs collected from CA APM in BMC Helix Discovery in a format that can be consumed by BMC Helix AIOps. For more information, see Managing your IT infrastructure. |
BMC Helix AIOps | Situations (created from events) | Improve the mean time to resolve (MTTR) based on the situation-driven workflow. Lower the mean time to detect or discover (MTTD) and the time required for investigating tickets. For more information, see Monitoring situations. |
BMC Helix AIOps | Services (created from topology) | Monitor the overall health of a service. When the service gets impacted by any factor, view the events generated because of the impact, analyze the causes of the impact, and quickly remediate those events to restore the health of the impacted service. For more information, see Monitoring services. |
As a tenant administrator, perform the following steps to configure a connection with CA APM, verify the connection, and view the collected data in various BMC Helix applications.
Supported versions
BMC Helix Intelligent Integrations supports version 10.7 SP3 of CA APM for data collection.
Task 1: To plan for the connection
- Depending on the location of the third-party product (SaaS, on-premises), choose one or more BMC Helix Intelligent Integrations deployment modes and review the corresponding port requirements. For information about various deployment modes and port requirements, see Deployment scenarios.
- Based on the deployment mode, use the BMC Helix Intelligent Integrations SaaS deployment or the BMC Helix Intelligent Integrations on-premises gateway or both. For more information about the gateway, see Deploying the BMC Helix Intelligent Integrations on-premises gateway.
- The on-premises gateway must be able to reach the third-party product on the required port (default is 8081).
In the preceding list, third-party product refers to CA APM.
Task 2: To configure the connection with CA APM
- Depending on the deployment mode, perform one of the following steps to access BMC Helix Intelligent
Integrations:- BMC Helix Intelligent Integrations SaaS – Log on to BMC Helix Portal, and click Launch on BMC Helix
Intelligent Integrations. - BMC Helix Intelligent Integrations on-premises gateway – Use the following URL to access BMC Helix
Intelligent Integrations: https://<hostName>:<portNumber>/swpui
- BMC Helix Intelligent Integrations SaaS – Log on to BMC Helix Portal, and click Launch on BMC Helix
- On the CONNECTORS tab, click
in the SOURCES panel.
Click the CA APM tile.
- Specify the following details for the source connection:
Specify a unique instance name.
- Specify the CA APM host name.
- Specify the CA HTTP or HTTPS port number depending on the connection protocol. The default port number is 8081.
- Select the HTTPS option to use an https connection to the CA APM host. Select this option when the protocol is https.
- Enter the user name and password for the CA APM host.
Enter the token.
For more information about tokens, see APM REST API.- Click Proxy and specify if you want to configure a proxy server. If yes, specify the host name and port number (default value is 8888).
- Click VALIDATE AND CREATE.
The specified connection details are validated and the corresponding source connection is created in the Source Connection list. Select the source connection that you created from the list if it is not selected already.
- Ensure that the options for the datatypes for which you want to collect data are selected.
Configure the collectors for the selected data types by clicking the respective data type in the Collectors section. Specify the parameters for the selected data type, as explained in the following table:
The ✅️ symbol indicates that this field applies to the data type.
Parameter name
Description
Data Type
CA APM Alerts
CA APM Metrics
CA APM Topology
Collection Schedule
Select one of the following options to specify the data collection frequency:
- Duration: When you select this option, data collection happens constantly. Specify the schedule in minutes, hours, or day.
Default: 5 minutes
Example:
Collection Schedule is set to 5 mins.
Current time is 00:30.
If you run the collector just after 00:30, data is collected every 5 mins, first at 00:30 and next at 00:35, and so on. Cron schedule: When you select this option, data collection happens periodically. Specify the schedule by using a cron expression.
A cron expression is a string consisting of five subexpressions (fields) that describe individual details of the schedule. These fields, separated by blank spaces, can contain any of the allowed values with various combinations of the allowed characters for that field.
Default: */5 * * * * (evaluates to 5 minutes)Format:
Minutes Hours (24-hour format) Day of Month Month Day of Week
Example:
If you specify 10 15 3 7 * , data is collected at 15:10 hours every third day in the month of July.
For more information about how this parameter affects data collection, see Data collection schedule.
✅️
✅️
✅️
Data Collection Window
Specify the historical time period (in minutes) from the current time for which the data should be collected.
Default: 5 minutes
Example:
Collection Schedule is set to 5 mins.
Data Collection Window is set to 5 mins.
Current time is 00:30.If you run the collector just after 00:30, data is collected first at 00:30 for the interval 00:25 - 00:30, and next at 00:35 for the interval 00:30 - 00:35, and so on.
For more information about how this parameter affects data collection, see Data collection window.
✅️
❌️
❌️
Data Latency
Specify the time (in minutes) by which the data time window should be shifted back on the timeline.
This parameter is useful in delayed data availability situations.
Default: 0 minutes
Example:
Collection Schedule is set to 5 mins.
Data Collection Window is set to 10 mins.
Data Latency is set to 2 mins.
Current time is 00:30.If you run the collector just after 00:30, data is collected first at 00:30 for the interval 00:18 to 00:28 and next at 00:35 for the interval 0:23 to 00:33, and so on.
For more information about how this parameter affects data collection, see Data latency.
✅️
✅️
❌️
Extract alerts for agents
Select one or more agents for which you want to collect alerts.
✅️
❌️
❌️
Host Regex
Specify a regular expression for hosts. Alerts from the hosts that match the regular expression are collected.
For example, if you specify *-pun* as the regular expression, alerts are collected from the following hosts: austin-pun, hou-pun
✅️
❌️
❌️
Severity
Select one or more severity levels from the following list:
- Caution
- Danger
- No Data
- Ok
This list of severities is updated automatically from CA APM.
✅️
❌️
❌️
Extract metrics from these hosts
Select one or more hosts from the list from which you want to collect metrics.
This list of metrics is updated automatically from CA APM.
❌️
✅️
❌️
Agents, Host Regex
Specify a regular expression for agents, hosts, or a | (pipe)-separated regular expression for extracting data from both agents and hosts. Metrics from the agents and hosts that match the regular expression are collected.
Examples:
- Only for agents: If you specify .*dotNet.*, metrics from all agents containing dotNet in their names are collected for all the hosts.
- Only for hosts: If you specify .*clm.*|.*. , metrics from all hosts containing clm in their names and all their agents are collected.
- Both agents and hosts: If you specify . *clm.*|.*dotNet.* , metrics from all hosts containing clm in their names and their agents containing dotNet in their names are collected.
Note: If you have selected a set of hosts from the Extract metrics from these hosts field and specified a regular expression in this field, metrics are collected from the hosts that are selected from the field and the hosts that match the regular expression.
❌️
✅️
❌️
Metrics Regex
Specify a regular expression for metrics. The metrics that match this regular expression are collected.
The regular expression must end in question mark (?).
For example, if you specify Available Threads.*|.*Bytes In Use? in this field, the data is collected for the Available Threads and Bytes In Use metrics.
❌️
✅️
❌️
Layers
Select one or more CA APM layers for which you want to extract data.
This list of metrics is updated automatically from CA APM.
❌️
❌️
✅️
- Duration: When you select this option, data collection happens constantly. Specify the schedule in minutes, hours, or day.
- Click CREATE COLLECTORS to create the required collector streams for the selected data types.
- Configure the distributors for the selected data types by clicking the respective data type in the Distributors section. Specify the parameters for the selected data type, as explained in the following table:
Parameter name
Description
Max Batching Size
Specify the maximum number of data items to send in a single POST request to the destination API.
The batch size depends on the destination’s ability to buffer the incoming data.Default: 250
Max Batching Delay
Specify the maximum time (in seconds) to wait before building and processing a batch.
Default: 3 seconds
Base Retry Delay
Specify the initial time (in seconds) for which to wait before retrying to build and process a batch.
The waiting time increases in the following sequence: n1, n2, n3, and so on, where n indicates the number of seconds.Default: 2 seconds
Example: Base Retry Delay is set to 2 seconds. Retry is performed after 2, 4, 8, 16, ... seconds.
Max Intra-Retry Delay
Specify the maximum limit for the base retry delay.
Default: 60 seconds
Example: Max Intra-Retry Delay is set to 60 seconds.
Base Retry Delay is set to 2 seconds. Retries are performed 2, 4, 8, 16, 32,... seconds later.Max Retry Duration
Specify the total time for retrying a delivery. For REST destinations, a delivery is a batch of data items in one POST request.
Default: 5 minutes
Example: Max Retry Duration is set to 8 hours.
Base Retry Delay is set to 2 seconds. Requests are sent for 2+4+8+16+32+64+132... until 8 hours in total duration is reached. After that, no subsequent attempts are made to retry the delivery. The assumption here is that if there is an outage or other issue with the destination tool, recovery should take less than the value of the Max Retry Duration parameter to be completed.Attributes To Be Dropped When Updating Events
Specify the event attributes that you do not want to be updated in BMC Helix Operations Management when events are updated. For example, if you do not want an event's severity, source address, source category, and subcategory to be updated in BMC Helix Operations Management, you need to specify those attributes in a comma-separated format: severity,source_address,source_category,source_subcategory.
Important: You can obtain the event attribute names in BMC Helix Operations Management, by exporting any event data in JSON, BAROC, XML, or CSV format. The exported file contains all attributes of the event data, and from there you can identify the attributes to be dropped.
- Click CREATE DISTRIBUTORS to create the required distributor streams for the selected data types.
- Click one of the following buttons:
- SAVE STREAM: Click this button if you want to edit the integration details before creating the instance. After you save the stream, the connector that you just created is listed in the SOURCES panel. Move the slider to the right to start the data stream.
- SAVE AND START STREAM: Click this button if you want to save the integration details and start receiving data immediately.
For more information about the data streams, see Starting-or-stopping-data-streams.
Task 3: To verify the connection
In CA APM, on the SOURCES panel, confirm that the data streams for the connection you created are running. Data streaming is indicated by moving colored arrows.
- A moving dark blue arrow (
) indicates that the event stream is running. Event data will be pushed according to the configured Collection Schedule interval.
- A moving red arrow (
) indicates that the metric stream is running. Metric data will be pushed according to the configured Collection Schedule interval.
- A moving light blue arrow (
) indicates that the topology stream is running. Topology data will be pushed according to the configured Collection Schedule interval.
To view data in BMC Helix applications
View data collected from CA APM in multiple BMC Helix applications.
View data collected from Prometheus in multiple BMC Helix applications.
To view events in BMC Helix Operations Management
- In CA APM, select Monitoring > Events.
- Filter the events by the CA_APM_Alert class.
Incoming events from CA APM are processed in BMC Helix Operations Management through a set of deduplication rules to determine whether the incoming event is a duplicate event or a new event. For more information, see Event-deduplication-suppression-and-closure-for-reducing-event-noise.
For more information about events, see Monitoring and managing events.
To view metrics in BMC Helix Operations Management
- In BMC Helix Operations Management, select Monitoring > Devices.
- Click the link for the required device.
- On the Monitors tab, click the required monitor.
The Performance Overview tab shows the metrics graph.
For information about metrics, see Viewing collected data.
BMC Helix Intelligent Integrations identifies all the CA APM KPI metrics. All the KPI metrics are prefixed with KPI in BMC Helix Operations Management. You can use these metrics for baselining.
To view topology in BMC Helix Discovery
- In BMC Helix Discovery, select Explore > Data.
- In the search box at the top-right corner, search for the CA APM host name.
- Click External Elements.
- Click the entity name to view its topology.
The following figures show the topology for the dotNetPaymentBackend service in the CA APM UI and in the BMC Helix Discovery UI:
Viewing Situations in BMC Helix AIOps
Before you view situations in BMC Helix AIOps, ensure that the following prerequisites are met:
- CIs are present in BMC Helix Discovery or BMC Helix AIOps for the events that are being collected from the Splunk Enterprise report.
- Create a Business Service model in one of the following applications:
BMC Helix Discovery. For more information, see Managing models.
BMC Helix AIOps. For more information, see Creating service models.
- Perform one of the following tasks:
To view ML-based situations, the AIOps Situations feature is enabled in BMC Helix AIOps. For more information, see Enabling the AIOps features.
To view policy-based situations, the correlation policy is created in BMC Helix Operations Management. For more information, see Creating and enabling event policies.
To view Situations
- In BMC Helix AIOps, go to the Situations page.
This page shows the Situations created from the events that are ingested into BMC Helix Operations Management. - Click the required Situation to view the messages contained in the Situation and other details such as priority and severity of the message.
For information about Situations, see Monitoring situations.
Viewing services in BMC Helix AIOps
Before you view a service in BMC Helix AIOps, create a service model (for example, BackEnd_Model) for the dotNetPaymentBackend topology collected in BMC Helix Discovery. For instructions, see Managing models.
To view services in BMC Helix AIOps
- In BMC Helix AIOps, go to the Services page.
This page shows the business service for the BackEnd_Model business service model.
- To view the impact on the service, hover over the service.
The impact score in percentage and Situations, events, incidents, or configuration items (CIs) associated with a service are displayed. - Click the service to view the health summary, causal analysis, health insights, and other key metrics of interest.
For more information about services, see Monitoring services.
Handling large data from CA APM
Use the hostGroupingCount parameter to handle large data coming from CA APM and avoid errors such as the data collection API not responding properly. Divide CA APM hosts into groups by using this parameter. The number of hosts in each group is equal to the value that you specify for this parameter.
The CA APM connector fetches data for one group of hosts first and then for another group until all the groups are processed.
For example, if there are 10 hosts in CA APM and you set this parameter value to 5, the connector fetches data for the first group of 5 hosts and then for the next group of 5 hosts.
To edit the hostGroupingCount parameter:
- Click Configure Mediator
adjacent to CA APM .
- Expand the CA APM section.
- Enable the Edit JSON option.
You can see the JSON format of CA APM configuration parameters. - Edit the value of the hostGroupingCount parameter as required.
The default value for this parameter is 5, the minimum value is 1, and the maximum value is 100,000. - Click VALIDATE to validate the settings.
- Click SAVE & CLOSE.
Marking devices for deletion in BMC Helix Operations Management
If the devices in BMC Helix Operations Management are not collecting any metrics data for a particular time period, you can mark them for deletion by using the shouldSupportTopologyLifecycle and itemExpiryDuration parameters.
For example, if you want to mark devices for deletion that do collect any metrics data in 5 hours in BMC Helix Operations Management, set the shouldSupportTopologyLifecycle parameter to true and set the value of itemExpiryDuration parameter to 5 hours.
To mark the devices for deletion:
- Click Configure Mediator
adjacent to CA APM.
- Expand the CA APM METRICS section.
- Click COLLECTOR CONFIGURATION.
- Enable the Edit JSON option to view the collection configuration parameters in JSON format.
- Set the value of the shouldSupportTopologyLifecycle parameter to true and then click SAVE.
By default, the value is set to false. - Click DISTRIBUTER CONFIGURATION.
- Enable the Edit JSON option to view the distributer configuration parameters in JSON format.
Edit the itemExpiryDuration parameter as shown in the following example:
"itemExpiryDuration":{
"unit": "HOURS"
"value": 5
}- The valid values for unit are SECONDS, MINUTES, HOURS, and DAYS.
- The default value for itemExpiryDuration is 30 days and minimum value is 1 hour.
- If itemExpiryDuration is set to less than 1 hour, BMC Helix Intelligent Integration considers the value to be 1 hour.
- Click SAVE to save the settings.
- Click SAVE & CLOSE.
Mapping between CA APM and BMC Helix Operations Management
The following table shows the mapping between CA APM and BMC Helix Operations Management:
Event attribute | CA APM | BMC Helix Operations Management |
---|---|---|
Event severity | Ok | Ok |
Danger | Critical | |
Caution | Warning | |
No Data | Unknown |