Requirements
- Dynatrace version 1.280+
- ActiveGate version 1.280+
- ActiveGate with the Extensions 2.0 module enabled.
- Control-M instance with the automation API enabled.
- User with access permissions to the automation API.
Dynatrace configuration
Under Extension on the left menu, select Control-M Jobs.
Add a monitoring configuration. This is an ActiveGate extension and runs on an ActiveGate of an ActiveGate group of your choice. The configuration parameters are the following:
- URL: The address for the Control-M automation API to query.
- Username: Username used for authentication against the Control-M automation API.
- Password: Password for the above user.
- Filter job by name: List of rules used to filter the jobs whose specific status and execution logs will be reported. As long as the job verifies one of the rules, its status and execution log will be reported to Dynatrace. Use this feature to exclude irrelevant jobs or to include important ones only. The excluded jobs will still be taken into account for the aggregated metrics.
- Filter job by folder name: Same as above, but using its folder’s name instead, in case there are complete folders that can be ignored or included. A job will be monitored if it verifies at least one of the rules, independently of if it’s a job’s name or folder’s name rule.
- Send error events: If this flag is on, Dynatrace will generate an error event (and its subsequent problem) in Dynatrace if a job has a failed execution status, regardless of if the job is filtered in or out. The generated problem will be attached to the environment. This is to be improved in the future.
- Debug: Produces more verbose logs. Enable only when troubleshooting or support makes that recommendation.
Lastly, select which feature sets (metric groups) you would like this configuration to collect. You can choose to monitor the summary of how many jobs are in each state and/or the individual job status.
Alerting
If the configuration parameter for Send error events is enabled, the extension will send an error event whenever any job is in a Ended Not OK status, just like the EF1.0 version did. However, as of today, we cannot attach the event to the custom device in EF2.0, so it will instead be attached to the environment. This is to be improved in the future.
As an alternative, it is possible to create a metric event based on the controlm.job.status metric for whenever a job is in an unwanted state, where it is also possible to attach said event to any of the generic types created by the extension.