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

Better logging #451

Open
justinmchase opened this issue Apr 4, 2023 · 2 comments
Open

Better logging #451

justinmchase opened this issue Apr 4, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@justinmchase
Copy link

Prerequisites:

Not related to the UI or API

New Feature

The logging in the success case is pretty poor. It will generate a lot with information about the webhook request but none of the data in the body is included int he log. As a consequence I cannot see which repo it is operating against or which event is triggering the event and I have no idea what settings its resolving and atteampting to apply which makes debugging things difficult when they seem to not work.

  • I would like to know which event is being fired for every webhook call
  • I would like to know which repositories are going to be updated when a suborg file is updated (suborg resolution set)
  • I would like a log showing which settings are being set to which repo before they are set.
  • When a repo has one of its settings set I'd like to know how it resolved those settings, did it come from the settings.yml? A suborg file? Which suborg file? A repository file? What were the values it rejected?
@justinmchase justinmchase added the enhancement New feature or request label Apr 4, 2023
@svg153
Copy link
Contributor

svg153 commented Jul 27, 2023

Anything related to this #413? Probably not all, but it would be nice to update this issue with the missing stuff once that PR is merged.

@HagegeR
Copy link

HagegeR commented Jan 19, 2025

I completely agree with this request. Even with the latest version, we experience a total absence of info logs after the repository name validation. Enabling debug logs significantly increases the runtime without making the logs easier to follow.

For example, I encountered this issue with the debug log:

DEBUG (probot): There are no changes for Autolinks for repo [object Object]. Skipping changes

this.log.debug(`There are no changes for ${this.constructor.name} for repo ${this.repo}. Skipping changes`)

The repository name should be included here, and this message could potentially be at the info level, indicating either "Skipping changes" or "Applying requested Autolinks."

Another example in the same function we receive a similar "is [object Object]" instead of the repo name:

this.log.debug(`Results of comparing ${this.constructor.name} diffable target ${JSON.stringify(existingRecords)} with source ${JSON.stringify(filteredEntries)} is ${results}`)

Additionally, there is insufficient indication of the sync progress during a full sync, I would like to get a sense of the percentage of the progress if possible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants