Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
Configure
OpsCx for CA APM is preconfigured to use the files and folders from the installation instructions above. If you choose a different destination, make sure to update the paths in the configuration file.
To configure the connector, find the caapm-integration.conf file and open it in a text editor.
Conventions Used in the Installation, Configuration, and Other Procedures
The following placeholder is used in the instructions throughout this document. When performing the steps, specify the actual value in place of the placeholder.
Placeholder | Meaning | (Default) Values, Examples, Notes |
---|---|---|
<OvDataDir> | Data installation directory of Operations Agent that is jointly used by Operations Connector and OpsCx for CA APM. |
Default value (Windows):
The C:\ProgramData directory is hidden by default. Default value (Linux):
|
General configuration settings
To be able to connect to the CA APM and to establish a receiving server on the OpsCx system, you need to set the basic options in the configuration files.
Options | Description |
---|---|
log-file |
Main log file location. On each day, the plug-in creates a new file and the “%d” in the name is replaced with the date. Default value:
|
log-level | 0 = DISABLED 1 = CONFIG, ERROR 2 = CONFIG, ERROR, WARNING, INFO 3 = CONFIG, ERROR, WARNING, INFO, TRACE |
base-url |
Location of the CA APM Enterprise Manager and port for API Calls. Default value: http://<caapm-host-name>:8081 |
username | CA APM username. |
password | CA APM password. |
proxy-host | Proxy location (leave empty if not using proxy) |
proxy-port | Proxy port (leave empty if not using proxy) |
proxy-username | Proxy username (leave empty if not using proxy) |
proxy-password | Proxy password (leave empty if not using proxy) |
client-requests-file |
Location of the .xml file with the API requests. Default value:
|
Data collection Settings
Set the following options:
Topology collector nodes
Set the below options for these topology collector nodes: emtopologycollector, systemtopologycollector, transactiontopologycollector, j2eeapplicationtopologycollector, frontendtopologycollector
Options | Description | Default Value |
---|---|---|
interval | Time interval for data collection query in seconds |
604800
|
max-interval-window | Max interval for which the plugin will store persistency data in seconds | 900 |
single-run | Run only once or in cycle (true/false) | false |
Metric collector nodes
Set the below options for all the metric collector nodes.
Options | Description | Default Value |
---|---|---|
interval | Time interval for data collection query in seconds |
604800
|
max-interval-window | Max interval for which the plugin will store persistency data in seconds | 900 |
single-run | Run only once or in cycle (true/false) | false |
agent-regex | Regular Expression for agent name | See Metric Filters |
metric-regex | Regular Expression for metric names | See Metric Filters |
Advanced Metrics Collection Configuration
For different metric queries, multiple metric collectors can be created. To add a new metric query, perform the following steps:
- Copy “metriccollector” (line 158-176 in .conf file) and paste it after the existing ones.
- Change its name with a non-existing one. For example, “metriccollector2”
-
Add a line for the new collector in the pipe section at the end of the file.
metriccollector -> metricsourcesplitter
metriccollector1 -> metricsourcesplitter
...
metriccollectorN -> metricsourcesplitter
By using metric filtering, you can optimize the amount of data which is collected from the CA APM Enterprise Manager. CA APM supports regular expression filters for metric queries. There are two filters:
- Agent-regex filters the query by the name of the agents that report them to the CA APM Enterprise Manager. Agent names are user configurable, and vary in different environments therefore there is no default set of regular expression for it. For more information about writing CA APM regular expression filters, see CA APM documentation.
- Metric-regex filters the query using the names of the metrics.
OpsCx for CA APM comes with sample filters, which mirror the metric groupings.
The default configuration has three metric collectors with predefined metric filters:
Application Metric Collector: metriccollector
Metrics included | Metric RegExp | Agent RegExp |
---|---|---|
Average Response Time | By Frontend\|.*? | .*Custom Business Application Agent.*? |
Concurrent Invocations | ||
Errors Per Interval | ||
Responses Per Interval | ||
Stall Count |
System Metric Collector: metriccolector1
Metrics included | Metric RegExp | Agent RegExp |
---|---|---|
Utilization metrics | (.*CPU:Utilization.*?|.*CPU.*Utilization % \(aggregate\).*?|.*File System:.*?|.*Sockets:Output Bandwidth.*?|.*Sockets:Input Bandwidth.*?|.*UDP.*?|.*GC Heap.*?|.*GC Monitor.*?) | (?!Custom Metric Host \(Virtual\)).*? |
File System metrics | ||
GC metrics | ||
Socket metrics | ||
UDP metrics |
Transaction Metric Collector: metriccolector2
By default, it collects transaction data reported from the CA agents themselves.
Metrics included | Metric RegExp | Agent RegExp |
---|---|---|
Transaction metrics reported by the CA Agents | .*By Business Service.*? |
.*Custom Business Application Agent.*?
|
If your environment has configured TIM device, replace the above expressions for metriccollector1 with the following values:
Metrics included | Metric RegExp | Agent RegExp |
---|---|---|
Transaction metrics reported by TIM | .*\|Business Transactions\|.*? |
Custom Metric Host \(Virtual\).*? |
For additional sets of filters, see the Metric Collection Filters topic.
For more information on how to create custom filters, see the CA APM documentation.
Alert collector nodes
Set the below options for these alert collector nodes: alertcollector, triagealertcollector
Options | Description | Default Value |
---|---|---|
interval | Time interval for data collection query in seconds |
80
|
max-interval-window | Max interval for which the plugin will store persistency data in seconds | 900 |
single-run | Run only once or in cycle (true/false) | false |
Data transformation Settings
Set the following options:
Data Transformation
Data Transformation is handled by “processor” nodes and more specifically by the message transformer processor.
Options | Description | Default Value |
---|---|---|
bsmc-server-name | FQDN of the Operations Connector host |
-- |
Data Transfer Settings
Data transfer to the Operations Connector is handled by “sink” nodes.
Set the below options for these data transfer nodes: topologywslistener, metricwslistener, alertwslistener
Options | Description | Node | Default Value |
---|---|---|---|
uri | Operations Connector policy location | topologywslistener | bsmc/rest/topology/caapm |
metricwslistener | bsmc/rest/metrics/caapm | ||
alertwslistener | bsmc/rest/events/caapm | ||
server-name | Operations Connector server name | -- | localhost |
port | Operations Connector server port | -- | 30005 |
use-persistency | Use persistency mechanism or not. | -- | true |
persistency-dir | Persistency directory | -- | ${OvDataDir}\tmp\HPBsmIntCAWily
|
auth-username | User name for authentication against the remote web service endpoint. If use-store is set to true, the string specified in this parameter will be used as key for fetching the user name from the credential store. | exampleauthusr | auth-username |
auth-password | Password for authentication. If use-store is set to true, the string specified in this parameter will be used as key for fetching the password from the credential store. | exampleauthpass | auth-password |
Configuring the Operations Connector Policies
The CA APM GenInt connector plug-in is preconfigured with Operations Connector policies for Events, Topology and Metrics. Log in to the Operations Connector interface and import them from the Policies folder in the installation package.
- Review the policy to ensure its settings are proper for your OpsCx for CA APM configuration.
- Activate the imported policy from the Operations Connector web interface.
Due to the granularity of the data sent to the Operations Connector, the policies can be customized.
Do not change the following attributes, or the policy may stop working:
Options | Default Value |
---|---|
Path |
caapm |
XML Event Tag | BSMCEvent |
Managing the Integration Services
OpsCx for CA APM enables you to manage its event, topology, and metric integration services.
Starting and Stopping the Integration Services
To start or stop the integration services, perform these steps:
- Open a Command Prompt window (command shell).
- Run the following command to start the integration services:
Windows:
ovc –start caapmint
Linux:
/opt/OV/bin/ovc –start caapmint
-
Run the following command to stop the integration services:
-
Windows:
ovc –stop caapmint
-
Linux:
/opt/OV/bin/ovc –stop caapmint
Related topics
-
We welcome your comments!
To open the configured email client on this computer, open an email window.
Otherwise, copy the information below to a web mail client, and send this email to ovdoc-asm@hpe.com.
Help Topic ID:
Product:
Topic Title:
Feedback: