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

Add config params to make debugging easier #110

Merged
merged 2 commits into from Mar 25, 2019

Conversation

Projects
None yet
2 participants
@rafeca
Copy link
Contributor

commented Mar 25, 2019

Description of the Change

This PR adds a few config params to the metrics package in Atom to make it easier to debug it:

Screen Shot 2019-03-25 at 19 46 27

In order to properly work, this PR needs the functionality added in atom/telemetry#24 .

Test plan

  • Patch this PR from atom/telemetry and verify that the 3 config params work correctly by looking at the developer tools and the network tab:
    • verboseMode prints messages in the console.
    • reportingFrequency allows to control how often to send the metrics.
    • logInDevMode sends network requests also in dev mode. It also prints them in the console (only in dev mode).

Alternate Designs

N/A

Benefits

Easier debugging.

Possible Drawbacks

Developers may enable logging in dev mode and forget about it. To mitigate this, we enable the verbose mode when a user has logging in dev mode enabled.

Applicable Issues

N/A

@rafeca rafeca referenced this pull request Mar 25, 2019

Merged

Easier debugging #24

@rafeca rafeca self-assigned this Mar 25, 2019

@annthurium
Copy link
Contributor

left a comment

@rafeca this is awesome!!!!

one quick question -- we have downstream packages (like atom/github) that are using the providedServices for inter package communication, to send their metrics. If you set these debug config settings in metrics, do they also apply to the downstream packages?

@rafeca

This comment has been minimized.

Copy link
Contributor Author

commented Mar 25, 2019

one quick question -- we have downstream packages (like atom/github) that are using the providedServices for inter package communication, to send their metrics. If you set these debug config settings in metrics, do they also apply to the downstream packages?

Good question! Yes, they will apply to any package using the metrics providedService, does it make sense?

@rafeca rafeca merged commit 7856616 into master Mar 25, 2019

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@rafeca rafeca deleted the add-options-for-easier-debugging branch Mar 25, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.