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 a dfe-specific diagnostics function #63

Open
cjrace opened this issue Feb 11, 2024 · 0 comments
Open

Add a dfe-specific diagnostics function #63

cjrace opened this issue Feb 11, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@cjrace
Copy link
Contributor

cjrace commented Feb 11, 2024

Is your feature request related to a problem? Please describe.
It's fairly common for our team to need to check through certain environment variables that are known to cause issues on DfE machines while helping teams to diagnose and fix issues.

Describe the solution you'd like
A diagnostics function that prints out common variables such as the following list to the console:

  • HTTP_PROXY
  • HTTPS_PROXY
  • no_proxy
  • GITHUB_PAT
  • RENV_DOWNLOAD_METHOD

I'm sure there'll be more to add to this to. Including does RTools exist, can it be found, and what's the location of key files such as the .Renviron and .Rprofile.

We could also add a verbosity argument, which if = full or true or something, returns full lists such as:

  • renv::diagnostics()
  • Sys.getenv()
  • options()

Describe alternatives you've considered
Combining this with a clear all / unset all function, might be worth it.

Additional context
In the documentation (and console output) we should include the warning that some of the data printed may be sensitive, e.g. GitHub PATs, and not to share them more widely.

@cjrace cjrace added the enhancement New feature or request label Feb 11, 2024
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

2 participants