Skip to main content

Use ROI Metric Data

Use ROI Metric Data

Incubating: This feature or API is new! We may still have a few bugs or change some functionality in the future.

ROI Metrics Data stores arbitrary key value pairs against your job to help understand your ROI per job execution. The metrics will be stored against the execution of the job, and accessible via API for further analysis. This article will walk through a setup scenario and provide some helpful example scripts to gather data from the API.

Configuring the Metrics

Example Scenario:

Customer X has decided to track how much time is saved with their newly implemented Automation job (uniquely titled ROI Job). They know from historical ticket-data that doing the same work manually - prior to writing this job - took around 75 minutes across all teams, start to finish. The job now runs in just seconds. To configure the job follow the steps or download the job definition.

  1. Create a new Job.
  2. Title job ROI Job.
  3. On the Workflow Tab add a single Command step with the command sleep 5. (Assumes this will be running on Linux host)
  4. Choose the Execution Plugins tab.
  5. Check the box for ROI Metrics Data.

    ROI Metrics Plugin
  6. Click Add Custom Field.

    Add Custom Field
  7. Enter a value for:
    • Field Label: Hours Saved
    • Field Key: hours
    • Description: FTE hours saved each time this job is run.
  8. Click Add.
  9. Enter a value of 1.25 for the metric in the Hours Saved field.
  10. Save the job.
  11. Run the job and look for the ROI Metrics Data tab. Confirm that the data is populated.
  12. Run the job a few more times so we have multiple executions.

Gathering Data

This section assumes familiarity with fundamental Rundeck operations like Creating User API Tokens, editing/importing jobs, etc.

  • Configure a User API Key with the necessary access to gather metrics from the job/project where your data is located.
  • Save the User API Key in the Key Storage by going to Project Settings > Key Storage and adding the key there.
  • Copy the job definition (next tab) and import to your project.
  • Edit the Job Definition. Configure the api-key Option Input with the API Key entry you created earlier.
  • Feel free to update any defaults on the other job options for rundeck-server, project-name, job-tags as needed.

Run the job to gather data and see a list of JSON output for any jobs with ROI data.