From: Emily Shaffer <emilyshaffer@google.com>
To: Derrick Stolee <stolee@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] bugreport: add tool to generate debugging info
Date: Thu, 15 Aug 2019 13:13:24 -0700 [thread overview]
Message-ID: <20190815201324.GA208753@google.com> (raw)
In-Reply-To: <e6d56d97-99c9-064a-71b5-2b7eb9b71e01@gmail.com>
On Thu, Aug 15, 2019 at 10:15:24AM -0400, Derrick Stolee wrote:
> > - Do we want to advertise the Git mailing list for bug reports?
>
> That is possible. Isn't there another mailing list for git users?
I know there's an IRC channel for Git users, I dunno about mailing list.
I'm worried that places I name as points of contact will grow stale,
although I suppose #git on freenode isn't really going anywhere, for
example. (But as a counterexample, I hope that nobody sends something
like this to #git-devel, which seems to have a lower population than
this mailing list.)
>
> I could see a patch added on top of this for git-for-windows/git that
> changes the instructions to create issues on GitHub.
Indeed; I imagine we'd probably like to patch it to ask for bugs in our
bug tracker.
>
> > - Which config options should we filter to avoid accidentally receiving
> > credentials?
>
> The remote URLs are pretty sensitive. Not only do users sometimes put passwords
> or PATs into their URLs, the literal name of the repo could be a secret.
Now here's where I start to wonder. We often debug internally by asking
for the remote URL and replicating the issue there, which is why I
mentioned it explicitly in the commit message. But I hadn't considered
folks including the password in the URL.
Well, I suppose anybody can keep a local patch to change the config
filter pattern. I'll try to make it easy to spot and modify.
[snip]
> At first I was alarmed by "What? another shell script?" but this command should
> prioritize flexibility and extensibility over speed. Running multiple processes
> shouldn't be too taxing for what we are trying to do here.
If shell scripts are entirely deprecated I can convert it, but doing it
in C seemed like overkill when I really just wanted "what are all the
commands we would ask the user to run and tell us the output?". I
figured also that it would be a little more immune to bitrot to output
the contents of porcelain commands here.
> > + echo "[Git Config]"
> > + # TODO: Pass this through grep -v to avoid users sending us their credentials.
> > + git config --show-origin --list
> > + echo
>
> Config options to consider stripping out:
>
> *url*
> *pass* (anything "password" but also "sendmail.smtppass")
Done, thanks.
>
> > + echo "[Configured Hooks]"
> > + find "$GIT_DIR/hooks/" -type f | grep -v "\.sample$" | print_filenames_and_content
> > + echo
>
> Remove the sample hooks, but focus on the others. Will this look like garbage if a hook
> is a binary file?
Yeah, I'm sure it will. I'll add a check to
print_filenames_and_content() so it can tell us if there is a hook
installed there, even if we can't see the content.
>
> > +
> > + echo "[Git Logs]"
> > + find "$GIT_DIR/logs" -type f | print_filenames_and_content
> > + echo
>
> As mentioned before, I've sometimes found it helpful to know the data shape for the object
> store. Having a few extra steps such as the following could be nice:
>
> echo "[Loose Objects]"
> for objdir in $(find "$GIT_DIR/objects/??" -type d)
> do
> echo "$objdir: $(ls $objdir | wc -l)"
`echo "$objdir: $(ls $objdir | wc -l) objects`
I'll add context so we don't need to have the bugreport script memorized
in order to read a bugreport :)
> done
> echo
>
> echo "[Pack Data]"
> ls -l "$GIT_DIR/objects/pack"
> echo
>
> echo "[Object Info Data]"
> ls -lR "$GIT_DIR/objects/info"
> echo
>
> echo "[Alternates File]"
> echo "========"
> cat "$GIT_DIR/objects/info/alternates"
> echo
>
> That last one will collect information on the commit-graph file, even if it is an
> incremental file.
Thanks Stolee, these are awesome and exactly the kind of feedback I was
hoping for.
>
> I think this is a great start, and I'll take some time later to try it out.
>
> Thanks,
> -Stolee
Awesome. I'm excited to hear how it goes.
- Emily
next prev parent reply other threads:[~2019-08-15 20:13 UTC|newest]
Thread overview: 68+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-15 2:34 [PATCH] bugreport: add tool to generate debugging info Emily Shaffer
2019-08-15 14:15 ` Derrick Stolee
2019-08-15 14:36 ` Junio C Hamano
2019-08-15 22:52 ` Emily Shaffer
2019-08-15 23:40 ` Junio C Hamano
2019-08-16 1:25 ` Emily Shaffer
2019-08-16 16:41 ` Junio C Hamano
2019-08-16 19:08 ` Emily Shaffer
2019-08-15 20:07 ` Johannes Schindelin
2019-08-15 22:24 ` Emily Shaffer
2019-08-16 20:19 ` Johannes Schindelin
2019-08-15 20:13 ` Emily Shaffer [this message]
2019-08-15 18:10 ` Junio C Hamano
2019-08-15 21:52 ` Emily Shaffer
2019-08-15 22:29 ` Junio C Hamano
2019-08-15 22:54 ` Emily Shaffer
2019-08-17 0:39 ` [PATCH v2 0/2] add git-bugreport tool Emily Shaffer
2019-08-17 0:39 ` [PATCH v2 1/2] bugreport: add tool to generate debugging info Emily Shaffer
2019-08-17 0:39 ` [PATCH v2 2/2] bugreport: generate config whitelist based on docs Emily Shaffer
2019-08-17 20:38 ` Martin Ågren
2019-08-21 17:40 ` Emily Shaffer
2019-10-25 2:51 ` [PATCH v3 0/9] add git-bugreport tool Emily Shaffer
2019-10-25 2:51 ` [PATCH v3 1/9] bugreport: add tool to generate debugging info Emily Shaffer
2019-10-29 20:29 ` Josh Steadmon
2019-11-16 3:11 ` Junio C Hamano
2019-11-19 20:25 ` Emily Shaffer
2019-11-19 23:24 ` Johannes Schindelin
2019-11-20 0:37 ` Junio C Hamano
2019-11-20 10:51 ` Johannes Schindelin
2019-11-19 23:31 ` Johannes Schindelin
2019-11-20 0:39 ` Junio C Hamano
2019-11-20 2:09 ` Emily Shaffer
2019-11-20 0:32 ` Junio C Hamano
2019-10-25 2:51 ` [PATCH v3 2/9] bugreport: generate config whitelist based on docs Emily Shaffer
2019-10-28 13:27 ` Johannes Schindelin
2019-10-25 2:51 ` [PATCH v3 3/9] bugreport: add version and system information Emily Shaffer
2019-10-28 13:49 ` Johannes Schindelin
2019-11-08 21:48 ` Emily Shaffer
2019-11-11 13:48 ` Johannes Schindelin
2019-11-14 21:42 ` Emily Shaffer
2019-10-29 20:43 ` Josh Steadmon
2019-10-25 2:51 ` [PATCH v3 4/9] bugreport: add config values from whitelist Emily Shaffer
2019-10-28 14:14 ` Johannes Schindelin
2019-12-11 20:48 ` Emily Shaffer
2019-12-15 17:30 ` Johannes Schindelin
2019-10-29 20:58 ` Josh Steadmon
2019-10-30 1:37 ` Junio C Hamano
2019-11-14 21:55 ` Emily Shaffer
2019-10-25 2:51 ` [PATCH v3 5/9] bugreport: collect list of populated hooks Emily Shaffer
2019-10-28 14:31 ` Johannes Schindelin
2019-12-11 20:51 ` Emily Shaffer
2019-12-15 17:40 ` Johannes Schindelin
2019-10-25 2:51 ` [PATCH v3 6/9] bugreport: count loose objects Emily Shaffer
2019-10-28 15:07 ` Johannes Schindelin
2019-12-10 22:34 ` Emily Shaffer
2019-10-29 21:18 ` Josh Steadmon
2019-10-25 2:51 ` [PATCH v3 7/9] bugreport: add packed object summary Emily Shaffer
2019-10-28 15:43 ` Johannes Schindelin
2019-12-11 0:29 ` Emily Shaffer
2019-12-11 13:37 ` Johannes Schindelin
2019-12-11 20:52 ` Emily Shaffer
2019-10-25 2:51 ` [PATCH v3 8/9] bugreport: list contents of $OBJDIR/info Emily Shaffer
2019-10-28 15:51 ` Johannes Schindelin
2019-10-25 2:51 ` [PATCH v3 9/9] bugreport: print contents of alternates file Emily Shaffer
2019-10-28 15:57 ` Johannes Schindelin
2019-11-19 20:40 ` Emily Shaffer
2019-10-29 1:54 ` [PATCH v3 0/9] add git-bugreport tool Junio C Hamano
2019-10-29 11:13 ` Johannes Schindelin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190815201324.GA208753@google.com \
--to=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
--cc=stolee@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).