History Status API

[Jeremydupras]

Description

This API provides a way to get the information within the Job History Index.

API calls
GET /_plugins/_job_scheduler/api/history

With
GET /_plugins/_job_scheduler/api/history/.scheduler_sample_extension-jobid1

GET /_plugins/_job_scheduler/api/history/

The history ID is the "index_id"-"jobid"

Example API response

{
  "total_history": 2,
  "history": {
    ".scheduler_sample_extension-jobid1-1755727454": {
      "job_index_name": ".scheduler_sample_extension",
      "job_id": "jobid1",
      "start_time": 1755727454,
      "completion_status": 0,
      "end_time": 1755727454
    },
    ".scheduler_sample_extension-jobid1-1755727514": {
      "job_index_name": ".scheduler_sample_extension",
      "job_id": "jobid1",
      "start_time": 1755727514,
      "completion_status": 0,
      "end_time": 1755727514
    }
  }
}

Related Issues

Resolves #808

Check List

• New functionality includes testing.
• New functionality has been documented.
• API changes companion pull request created.
• Commits are signed per the DCO using --signoff.
• Public documentation issue/PR created.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[codecov]

Codecov Report

❌ Patch coverage is 51.44928% with 67 lines in your changes missing coverage. Please review.
✅ Project coverage is 68.57%. Comparing base (8b2c5fa) to head (f3a7a0e).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...er/transport/action/TransportGetHistoryAction.java	43.67%	48 Missing and 1 partial ⚠️
...heduler/transport/response/GetHistoryResponse.java	56.52%	10 Missing ⚠️
...scheduler/transport/request/GetHistoryRequest.java	38.46%	8 Missing ⚠️

❌ Your project check has failed because the head coverage (68.57%) is below the target coverage (75.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #823      +/-   ##
==========================================
- Coverage   69.99%   68.57%   -1.42%     
==========================================
  Files          38       43       +5     
  Lines        1733     1868     +135     
  Branches      156      160       +4     
==========================================
+ Hits         1213     1281      +68     
- Misses        430      496      +66     
- Partials       90       91       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[cwperks]

@Jeremydupras FYI I fixed the conflicts after #833 was merged.

Sorry about the delay in feedback. Taking a pass now.

[cwperks]

A few high-level comments on the API response:

{
  "total_history": 2,
  "history": {
    ".scheduler_sample_extension-jobid1-1755727454": {
      "job_index_name": ".scheduler_sample_extension",
      "job_id": "jobid1",
      "start_time": 1755727454,
      "completion_status": 0,
      "end_time": 1755727454
    },
    ".scheduler_sample_extension-jobid1-1755727514": {
      "job_index_name": ".scheduler_sample_extension",
      "job_id": "jobid1",
      "start_time": 1755727514,
      "completion_status": 0,
      "end_time": 1755727514
    }
  }
}

• Instead of total_history, wdyt about run_count or something similar?
• IMO history should be a list sorted from most recent to least recent. Perhaps a URL param can be added for sort in future versions?

[cwperks]

@Jeremydupras I'll push a commit to resolve the compilation failures.

[cwperks]

@Jeremydupras I'm not able to push to the branch, but the compilation issue is in TransportGetHistoryAction where this import:

import org.opensearch.jobscheduler.spi.utils.JobHistoryService;

needs to change to this:

import org.opensearch.jobscheduler.utils.JobHistoryService;

[cwperks]

sorry, inadvertently hit Close with comment instead of Comment.