Skip to content

Consider job inclusion/exclusion setting when tracking logs#432

Merged
nikita-tkachenko-datadog merged 2 commits into
masterfrom
nikita-tkachenko/apply-job-filter-setting-to-logs
Jun 14, 2024
Merged

Consider job inclusion/exclusion setting when tracking logs#432
nikita-tkachenko-datadog merged 2 commits into
masterfrom
nikita-tkachenko/apply-job-filter-setting-to-logs

Conversation

@nikita-tkachenko-datadog

Copy link
Copy Markdown
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?

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.DatadogConsoleLogFilter and org.datadog.jenkins.plugins.datadog.logs.DatadogTaskListenerDecorator are 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)

  • 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/Fixed Fixed features results into a bug fix version bump label Jun 12, 2024
@github-actions github-actions Bot added the documentation Documentation related changes label Jun 12, 2024
@nikita-tkachenko-datadog
nikita-tkachenko-datadog marked this pull request as ready for review June 12, 2024 16:28

@sarah-witt sarah-witt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

looks good!

@nikita-tkachenko-datadog
nikita-tkachenko-datadog merged commit aa51fc8 into master Jun 14, 2024
@nikita-tkachenko-datadog
nikita-tkachenko-datadog deleted the nikita-tkachenko/apply-job-filter-setting-to-logs branch June 14, 2024 20:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog/Fixed Fixed features results into a bug fix version bump documentation Documentation related changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants