Enhance "Get a Step" Pipelines API response

XMLWordPrintable

    • 1

      Users building custom metrics and monitoring platforms for Bitbucket Cloud require granular metadata from the Pipelines API, specifically the "Get a Step" endpoint, to accurately track CI/CD performance and runner efficiency.

      The current JSON response for the Get a Step endpoint (https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pipelines/#api-repositories-workspace-repo-slug-pipelines-pipeline-uuid-steps-step-uuid-get) lacks several critical data points necessary for deep analysis of pipeline execution. This is particularly relevant for users monitoring self-hosted runners and complex parallel step configurations.

      Requested Enhancements:
      It is requested that the endpoint be updated to include these fields:

      1. Parallel Group/Stage Membership: A field indicating if the step is part of a parallel group and the identifier for that group or stage.
      1. Retry Metadata: Improved visibility into run_number and timing details specifically for partial retries to ensure distinct tracking of execution attempts.
      1. Script Item Durations: Breakdowns of duration for individual script items within a step, providing more detail than the current aggregate step duration.
      1. Queue Timing: Explicit timestamps for when a step was queued versus when it was picked up by a runner (data that is currently only visible as snapshots in Workspace settings).
      1. Log Correlation: Metadata that directly links a step’s execution to its specific log stream for more efficient programmatic retrieval.

      Use Case:
      This data is essential for organizations building internal dashboards to monitor runner health, identify bottlenecks in parallel execution, and audit pipeline performance trends over time.

              Assignee:
              Unassigned
              Reporter:
              Bruno M.
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: