Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support linking downstream pipelines to upstream pipelines in CI Visibility #405

Merged

Conversation

nikita-tkachenko-datadog
Copy link
Collaborator

Requirements for Contributing to this repository

  • Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
  • The pull request must only fix one issue at the time.
  • The pull request must update the test suite to demonstrate the changed functionality.
  • After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see CONTRIBUTING.

What does this PR do?

Implements linking downstream pipelines to upstream pipelines in CI Visibility.
In order to link the two pipelines, the downstream pipeline's webhook payload should contain an additional section that has the URL and trace ID of its upstream pipeline.
The needed data are obtained from the CauseAction of the downstream's pipeline and from the BuildSpanManager in-memory cache.

The BuildSpanManager is changed from only storing info about the running jobs to also storing info about the latest N (1024 by default) finished jobs.
Storing info about the finished jobs is required because the downstream pipeline event handler needs to obtain the trace ID of the upstream pipeline (by the time this happens the upstream pipeline has already finished its execution).

The size of the cache should be in the hundreds of kilobytes.

It should be very unlikely that the upstream pipeline trace context is already removed by the time the downstream pipeline is executed, but if it happens the only logic that stops working is the one that links upstream to downstream.

Description of the Change

Alternate Designs

Possible Drawbacks

Verification Process

Additional Notes

Release Notes

Review checklist (to be filled by reviewers)

  • Feature or bug fix MUST have appropriate tests (unit, integration, etc...)
  • PR title must be written as a CHANGELOG entry (see why)
  • Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
  • PR must have one changelog/ label attached. If applicable it should have the backward-incompatible label attached.
  • PR should not have do-not-merge/ label attached.
  • If Applicable, issue must have kind/ and severity/ labels attached at least.

@nikita-tkachenko-datadog nikita-tkachenko-datadog added the changelog/Added Added features results into a minor version bump label Mar 22, 2024
@github-actions github-actions bot added the documentation Documentation related changes label Mar 22, 2024
@nikita-tkachenko-datadog nikita-tkachenko-datadog marked this pull request as ready for review March 22, 2024 17:19
Copy link
Collaborator

@drodriguezhdez drodriguezhdez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've dropped some comments.

Copy link
Collaborator

@drodriguezhdez drodriguezhdez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@nikita-tkachenko-datadog nikita-tkachenko-datadog merged commit 3e74749 into master Mar 26, 2024
16 checks passed
@nikita-tkachenko-datadog nikita-tkachenko-datadog deleted the nikita-tkachenko/downstream-pipelines-support branch March 26, 2024 14:03
nikita-tkachenko-datadog added a commit that referenced this pull request May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/Added Added features results into a minor version bump documentation Documentation related changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants