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

Improve logging in the targets files #770

Closed
duncanp-sonar opened this issue Aug 15, 2019 · 0 comments · Fixed by #785
Closed

Improve logging in the targets files #770

duncanp-sonar opened this issue Aug 15, 2019 · 0 comments · Fixed by #785
Projects
Milestone

Comments

@duncanp-sonar
Copy link
Contributor

@duncanp-sonar duncanp-sonar commented Aug 15, 2019

Description

It can be difficult to tell from the build logs whether the targets have been included and are operating correctly. This makes it difficult for users to self-diagnose issues, leading to delays in setting up analysis builds, more community/support requests and user frustration.

It should be possible to easy tell the following from the build output:

  • whether the targets have/have not been imported
  • whether or not the Sonar-specific processing was completed successfully for a project
  • whether the project was categorised as a test or product project, and why (e.g. `Sonar: project contains the MSTest ProjectTypeGuid => categorised as a test project' - TODO could be multiple separate messages)

The additional logging messages should have a standard prefix to make them easy to locate e.g. "Sonar: ".

The content of the messages should:
(a) be sufficient to enable self-diagnosis of issues, and
(b) stable, so that they can be referenced in documentation/troubleshooting guides (e.g. "To check whether Sonar analysis is correctly enabled for a project, search for the string Sonar: analysis enabled for project X"

TODO

Consider the verbosity of the additional messages. Ideally, there would be still be useful information at 'normal' output verbosity e.g.

Sonar: analysis enabled for project X
...
Sonar: project X processed successfully

@duncanp-sonar duncanp-sonar added this to To do in S4MSB via automation Aug 15, 2019
@duncanp-sonar duncanp-sonar added this to the Next milestone Aug 15, 2019
@duncanp-sonar duncanp-sonar moved this from To do to In progress in S4MSB Aug 28, 2019
@duncanp-sonar duncanp-sonar self-assigned this Aug 28, 2019
duncanp-sonar added a commit that referenced this issue Aug 28, 2019
Fixes #770
duncanp-sonar added a commit that referenced this issue Aug 28, 2019
Fixes #770
duncanp-sonar added a commit that referenced this issue Aug 28, 2019
Fixes #770
@duncanp-sonar duncanp-sonar moved this from In progress to Review in progress in S4MSB Aug 28, 2019
@duncanp-sonar duncanp-sonar removed their assignment Aug 28, 2019
S4MSB automation moved this from Review in progress to Done Aug 29, 2019
mickael-caro-sonarsource added a commit that referenced this issue Aug 29, 2019
Fixes #770
@duncanp-sonar duncanp-sonar modified the milestones: Next, Hardening Sep 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
S4MSB
  
Done
1 participant
You can’t perform that action at this time.