Control-M Jobs v2
- Product information
- Release notes
Overview
Control-M enables you to automate the scheduling and processing of your business workflows across various platforms and applications.
Monitor, understand and troubleshoot these business-critical assets with the Control-M extension.
Get started
Requirements
- Dynatrace version 1.289+
- ActiveGate version 1.289+
- 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.
- Server: If this parameter is set, the API call will receive a server filter, effectively retrieving only jobs that belong to the specified server.
- 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.
- 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. This event will be attached to the job entity.
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.
Extension content
Feature sets
Below is a complete list of the feature sets provided in this version. To ensure a good fit for your needs, individual feature sets can be activated and deactivated by your administrator during configuration.
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Job status | controlm.job.status | Metric that indicates the current status of each job. A value of 100 equals a job that ended correctly, a value of 0 indicates a job that ended incorrectly, was not found in AJF or has an unknown state. A value of 50 indicates a job in the middle of execution. A value of 25 indicates a job that is waiting. | Percent |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Jobs waiting for condition | controlm.job_counters.wait_condition | Number of jobs with state "Waiting For Condition" | Count |
| Jobs ended ok | controlm.job_counters.ended_ok | Number of jobs with state "Ended OK" | Count |
| Jobs being executed | controlm.job_counters.executing | Number of jobs with state "Executing" | Count |
| Jobs waiting for resource | controlm.job_counters.wait_resource | Number of jobs with state "Waiting For Resource" | Count |
| Jobs waiting for user | controlm.job_counters.wait_user | Number of jobs with state "Wait User" | Count |
| Jobs waiting for host | controlm.job_counters.wait_host | Number of jobs with state "Waiting For Host" | Count |
| Jobs ended not ok | controlm.job_counters.ended_not_ok | Number of jobs with state "Ended Not OK" | Count |
| Jobs with unknown state | controlm.job_counters.unknown | Number of jobs with an unknown state | Count |
| Jobs not in AJF | controlm.job_counters.not_in_ajf | Number of jobs with state "Not In AJF(Active Job File)" | Count |
Full version history
Full version history
New features:
- Log capture for job executions is now optional based on a new configuration parameter. It defaults to
Falseif not set. - New parameter to configure how many threads the extension will spin up to capture the job's logs, if enabled. It defaults to 5 if not set.
- Order Date is now captured for every job, if available, as a dimension of the job status metric and as a property of the job entity.
Full version history
- Fixed an issue where the status WAIT HOST was not recognized and stopped the execution of the extension, creating missing data.
- Added a new metric for counting WAIT HOST status jobs
- Added chart for said metric to the job's screen
Full version history
- Fixed a bug that prevented metrics from coming in
Full version history
- Required minimum version increased to 1.289 for both the ActiveGate and the Dynatrace cluster
- Error events generated by the extension now get attached to the corresponding Control-M job entity instead of to the environment
- The extension now avoids querying every single job for its log on the first execution and gets only the latest ones
- Aded a new server parameter that filters API results by its value
- The extension now iterates through multiple paginated results when the amount of jobs returned by the API is greater than 10000
Full version history
- Adapted the extension to use cases where all folders in a Control-M instance have the same ID to report all folders correctly.
Full version history
- Fixed a broken link in the built-in dashboard.
- Fixed a bug where monitoring the first execution of a job would break the extension.
- Fixed a bug where the resource consumption of the ActiveGate running the extension would increase to unreasonable numbers based on the amount of jobs monitored.
Full version history
Converted extension to EF2.0:
- Added a new metric to monitor individual job status
- controlm.job.status
- Added feature sets to control metric ingestion
- Added custom topology for Control-M instances, folders and jobs and their relevant relationships
- Added UA screens for each one of the entities
- Added log monitoring for individual job run logs
- Added overview dashboard
- Added filtering in the configuration to filter out jobs/folders
