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.

Sign up for GitHub

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

Jump to bottom

Add logging for agent usage by job #8283

Merged
merged 3 commits into from Jul 26, 2023
Merged

Add logging for agent usage by job #8283

merged 3 commits into from Jul 26, 2023

Conversation

meiswjn
Copy link
Contributor

@meiswjn meiswjn commented Jul 19, 2023 •
edited

We want to log what job used which agent. This can be useful when you want to deprecate an agent and see if there have been any builds on the particular agent.

(no Jira Issue bc minor change)

Testing done

Create a log recorder for "SlaveComputer" and set it to "FINER"
Completed ExecutorStepExecution.PlaceholderTask{runId=test_pipeline/main#38,label=custom_agent,context=CpsStepContext[3:node]:Owner[test_pipeline/main/38:test_pipeline/main #38],cookie=11f7dc82-eae1-45e5-9fdb-043cbd1119cd,auth=null} on custom_agent

Proposed changelog entries

  • Log agent usage by job.

Proposed upgrade guidelines

N/A

Submitter checklist

Edit tasklist title
Beta Give feedback Tasklist Submitter checklist, more options

Delete tasklist

Delete tasklist block?
Are you sure? All relationships in this tasklist will be removed.
  1. The Jira issue, if it exists, is well-described.
    Options
  2. The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see examples). Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
    Options
  3. There is automated testing or an explanation as to why this change has no tests.
    Options
  4. New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
    Options
  5. New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
    Options
  6. New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
    Options
  7. For dependency updates, there are links to external changelogs and, if possible, full differentials.
    Options
  8. For new APIs and extension points, there is a link to at least one consumer.
    Options

Desired reviewers

@mention

Before the changes are marked as ready-for-merge:

Maintainer checklist

Edit tasklist title
Beta Give feedback Tasklist Maintainer checklist, more options

Delete tasklist

Delete tasklist block?
Are you sure? All relationships in this tasklist will be removed.
  1. There are at least two (2) approvals for the pull request and no outstanding requests for change.
    Options
  2. Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
    Options
  3. Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
    Options
  4. Proper changelog labels are set so that the changelog can be generated automatically.
    Options
  5. If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see example).
    Options
  6. If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).
    Options

@meiswjn meiswjn changed the title Feat/add logging jobstart add logging for agent usage by job Jul 19, 2023
daniel-beck
daniel-beck reviewed Jul 19, 2023
View reviewed changes
Copy link
Member

@daniel-beck daniel-beck left a comment

Choose a reason for hiding this comment

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

Looks like a reasonable basic addition. Anything more elaborate can implement ExecutorListener, but being able to just add a logger is a nice addition.

I wonder whether there's something more suitable than #getFullDisplayName to call, as the display name is rarely what you want in logs. Is #toString on average more useful for these types?

core/src/main/java/hudson/slaves/SlaveComputer.java Outdated Show resolved Hide resolved
core/src/main/java/hudson/slaves/SlaveComputer.java Outdated Show resolved Hide resolved
@meiswjn
Copy link
Contributor Author

meiswjn commented Jul 19, 2023

Thanks for your feedback, @daniel-beck!

I tried it out:
task.getFullDisplayName -> Completed part of test_pipeline » main #38 on custom_agent
task.toString() -> Completed ExecutorStepExecution.PlaceholderTask{runId=test_pipeline/main#38,label=custom_agent,context=CpsStepContext[3:node]:Owner[test_pipeline/main/38:test_pipeline/main #38],cookie=11f7dc82-eae1-45e5-9fdb-043cbd1119cd,auth=null} on custom_agent
task.getDisplayName() -> Completed part of test_pipeline » main #38 on custom_agent

So yes, it is more informative, but also less read-able. It would be fine for me since it is on log level "fine" now, I guess. What do you prefer?

@daniel-beck
Copy link
Member

daniel-beck commented Jul 19, 2023 •
edited

test_pipeline/main#38 would clearly be preferable to test_pipeline » main #38 on its own (that's kinda what I was hoping to get in #toString). There's a lot of extra information that doesn't look relevant in this though. OTOH, display names of jobs and builds can easily mess with the log, causing confusion (e.g., there can be only one job with a given name, not so for display names). I'd prefer this be changed to #toString absent a #getFullName or similar, but no strong preference. Either way this can be approved (once the log levels are less noisy).

@meiswjn meiswjn requested a review from daniel-beck July 19, 2023 11:35
@meiswjn
Copy link
Contributor Author

meiswjn commented Jul 19, 2023

Agreed. Both done :)

@NotMyFault NotMyFault added skip-changelog Should not be shown in the changelog rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted and removed skip-changelog Should not be shown in the changelog labels Jul 19, 2023
NotMyFault
NotMyFault approved these changes Jul 19, 2023
View reviewed changes
Copy link
Member

@NotMyFault NotMyFault left a comment

Choose a reason for hiding this comment

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

/label ready-for-merge

This PR is now ready for merge. We will merge it after ~24 hours if there is no negative feedback.
Please see the merge process documentation for more information about the merge process.
Thanks!

@comment-ops-bot comment-ops-bot bot added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Jul 19, 2023
@NotMyFault NotMyFault changed the title add logging for agent usage by job Add logging for agent usage by job Jul 26, 2023
@NotMyFault NotMyFault merged commit d6fb182 into jenkinsci:master Jul 26, 2023
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@daniel-beck daniel-beck daniel-beck approved these changes

@NotMyFault NotMyFault NotMyFault approved these changes

@StefanSpieker StefanSpieker StefanSpieker approved these changes

Assignees
No one assigned
Labels
ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted
Projects
None yet
Milestone
No milestone
4 participants
@meiswjn @daniel-beck @NotMyFault @StefanSpieker