Consider job inclusion/exclusion setting when tracking logs#432
Merged
nikita-tkachenko-datadog merged 2 commits intoJun 14, 2024
Merged
Conversation
nikita-tkachenko-datadog
marked this pull request as ready for review
June 12, 2024 16:28
nikita-tkachenko-datadog
deleted the
nikita-tkachenko/apply-job-filter-setting-to-logs
branch
June 14, 2024 20:14
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requirements for Contributing to this repository
What does this PR do?
This PR updates logic that determines whether logs from a logger/taskListener should be sent to Datadog or not.
After the update the logs will be tracked only if the job that they're coming from satisfies the plugin's include/exclude filters.
Description of the Change
org.datadog.jenkins.plugins.datadog.logs.DatadogConsoleLogFilterandorg.datadog.jenkins.plugins.datadog.logs.DatadogTaskListenerDecoratorare two main classes that decorate logging output streams with Datadog tracker.These two classes were updated to consult the plugin's settings as described above.
Alternate Designs
Possible Drawbacks
Verification Process
The logic was tested manually, and integration tests were implemented where appropriate.
Additional Notes
A common method is created in the utilities class that verifies whether a job should be tracked or not.
It is meant to replace the existing method which verifiers the same using the job name (the reason is that the same logic extracting the name is repeated in multiple places).
Release Notes
Review checklist (to be filled by reviewers)
changelog/label attached. If applicable it should have thebackward-incompatiblelabel attached.do-not-merge/label attached.kind/andseverity/labels attached at least.