Configuring Instana Observer jobs
Using the Instana Observer job, you can retrieve Instana topology information.
Important: The Instana Observer supports the following Instana version: SAAS build 286.
Before you begin
Note: The Instana Observer only supports running an instance within the Cluster hosting AIOps and cannot be deployed remotely behind a firewall.
Ensure that you have installed and enabled the Instana Observer as described here.
Ensure that you have following information to hand:
- Endpoint
- API Token
- Filters to define subsets of Instana data
Important when migrating from the Instana Connector
When integrating with Instana, the Instana Observer provides an efficient alternative to the Instana Collector. You can use either the oberver or the collector to collect topology information, but not both.
If you have an existing integration with Instana via the Instana Connector and want to switch to using the observer instead, disable the previous integration and delete previously retrieved data before defining and running the Instana Observer. This will prevent the creation of duplicate resources.
Note: After migrating, the Instana Observer collects topology data, while the Instana Collector continues to collect event and metric data.
See Migrating from the Instana Connector to the Observer for the steps to migrate from the Instana Connector to the Observer.
About this task
The list of Instana technologies retrieved by the observer is determined dynamically and is based on the actual resources available in the Instana instance from which the observer is retrieving data.
Instana job: By default, Load jobs are one-off, transient jobs that do a full upload of all requested topology data as soon as they are triggered. You can also run these jobs (again) manually from the Observer UI, or schedule them to run at set times when configuring them. Run this job whenever you want to refresh the Instana topology data.
Procedure
Define or edit the following parameters, then click Run job to save and run the job.
Encryption requirement: See the Configuring observer jobs security topic for more information.
| Parameter | Action | Details |
|---|---|---|
| Unique ID | Enter a unique name for the job | Required |
| Base URL | Specify the Instana tenant unit URL | Required |
| Instana API token | Specify the Instana API token. Note that the API Token can be obtained from the Instana web UI. | Required |
| Page size configuration to query the Instana API | Set the page size for Instana APIs that support pagination. The default is 5000. |
Required |
| Size of time window in seconds to query the Instana API | Set the window size for Instana APIs that support time windows. The default is 86400 (seconds), which is 1 day. |
Required |
| Trust all certificates by bypassing certificate verification | Specify whether to connect to the target environment without certificate verification. The default is true. |
Required |
| Import Instana applications | Specify whether Instana application perspectives should be imported as waiopsApplication groups. The default is true. |
Optional |
| White list regular expression pattern | Provide the white list pattern used to filter applications | Optional |
| CSV list of regular expressions for infrastructure data properties to filter out | Enter the regular expressions to filter out properties. The defaults are .*conditions.*,.*containers.data.*,.*metrics.*,.*lastProbeTime.*,.*lastHeartbeatTime.*,.*requirements.*,.*containerState.*,.*itemIds.*,.*annotations.*,env,clusterUuid,dependencies,directDependencies,filesystems,jvm.*,initContainers.data.cri-o://.*,table_info.shared.*,volumes_.*,creationTimestamp |
Optional |
| Exclude empty applications and services | Specify whether applications and services with no members should be excluded. The default is true. |
Optional |
| Connection timeout (milliseconds) | Set the connection timeout in milliseconds. | Optional. The default is 5000ms. |
| Read timeout (milliseconds) | Set the read timeout in milliseconds. | Optional. The default is 5000ms. |
| Proxy Host | Specify the proxy host to connect to. | Optional |
| Proxy Port | Specify the proxy port. The default is 8080. |
Optional |
| Proxy Username | Specify the proxy user name to connect as. Set for basic auth proxy. | Optional |
| Target system certificate | Specify the certificate to load into the trustStore. Note that the file must be located in the /opt/ibm/netcool/asm/security directory. |
Optional |
| Proxy Password | Specify the password for the proxy user (if Proxy Username has been specified). |
Optional |
| SSL certificate validation | Select whether to use SSL validation. The default is false, which uses HTTPS without host verification. |
Optional |
| HTTPS trustStore file name | Specify the HTTPS trustStore file name. | Optional. Note that if no certificate is being used, a valid truststore file must be provided. |
| Proxy Secure | Specify whether to connect to the proxy in secure mode. The default is false. Set to true for HTTPS proxy. |
Optional |
| TrustStore file password | Enter the password needed to decrypt the HTTPS trustStore file. You must supply the password_ssl_truststore_file in encrypted form. See the Configuring observer jobs security topic for more information. | Optional |
| Access scope | Enter text to provide a scope for the resources. Access scope can help map alerts to resources when resources in different scopes share the same parameters, such as matchTokens. | Optional. Tip: You can define access scope for locations, project names, namespaces, etc. |
| Generate debug support file | Set this parameter to 'True' in order to capture the output of the next scheduled job run as a file. This file will be stored with an observer's log files and can be used to debug observer issues, for example at the request of your designated support team, or while using a test environment. For one-off jobs (that is, Load jobs), this parameter reverts to 'False' after the next completed run. To examine the output produced, you can load the generated debug file using the File Observer. | Optional |
| Observer job description | Enter additional information to describe the job | Optional |
| Job schedule | Specify when the job runs | Optional. Load jobs only. |