You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@kudu.apache.org by "Mike Percy (Code Review)" <ge...@cloudera.org> on 2017/03/29 01:45:04 UTC

[kudu-CR] docs: Add breakpad documentation to user guide

Mike Percy has uploaded a new change for review.

  http://gerrit.cloudera.org:8080/6504

Change subject: docs: Add breakpad documentation to user guide
......................................................................

docs: Add breakpad documentation to user guide

Change-Id: I05275aab0196dbf8fc37da320a0bf34662606a14
---
A docs/minidumps.adoc
M docs/support/jekyll-templates/document.html.erb
2 files changed, 110 insertions(+), 0 deletions(-)


  git pull ssh://gerrit.cloudera.org:29418/kudu refs/changes/04/6504/1
-- 
To view, visit http://gerrit.cloudera.org:8080/6504
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I05275aab0196dbf8fc37da320a0bf34662606a14
Gerrit-PatchSet: 1
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Mike Percy <mp...@apache.org>

[kudu-CR] docs: Add breakpad documentation to user guide

Posted by "Mike Percy (Code Review)" <ge...@cloudera.org>.
Hello Kudu Jenkins,

I'd like you to reexamine a change.  Please visit

    http://gerrit.cloudera.org:8080/6504

to look at the new patch set (#3).

Change subject: docs: Add breakpad documentation to user guide
......................................................................

docs: Add breakpad documentation to user guide

Change-Id: I05275aab0196dbf8fc37da320a0bf34662606a14
---
M docs/troubleshooting.adoc
1 file changed, 50 insertions(+), 0 deletions(-)


  git pull ssh://gerrit.cloudera.org:29418/kudu refs/changes/04/6504/3
-- 
To view, visit http://gerrit.cloudera.org:8080/6504
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: newpatchset
Gerrit-Change-Id: I05275aab0196dbf8fc37da320a0bf34662606a14
Gerrit-PatchSet: 3
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Andrew Wong <aw...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-Reviewer: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Todd Lipcon <to...@apache.org>

[kudu-CR] docs: Add breakpad documentation to user guide

Posted by "Alexey Serbin (Code Review)" <ge...@cloudera.org>.
Alexey Serbin has posted comments on this change.

Change subject: docs: Add breakpad documentation to user guide
......................................................................


Patch Set 2:

(2 comments)

http://gerrit.cloudera.org:8080/#/c/6504/2/docs/troubleshooting.adoc
File docs/troubleshooting.adoc:

Line 147: 
Does it make sense to add information about enabling/disabling minidumps using the ---enable_minidumps flag?  And also mention that it's disabled by default.


PS2, Line 148: glog
nit: why not just 'log' ?


-- 
To view, visit http://gerrit.cloudera.org:8080/6504
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I05275aab0196dbf8fc37da320a0bf34662606a14
Gerrit-PatchSet: 2
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-Reviewer: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Todd Lipcon <to...@apache.org>
Gerrit-HasComments: Yes

[kudu-CR] docs: Add breakpad documentation to user guide

Posted by "Andrew Wong (Code Review)" <ge...@cloudera.org>.
Andrew Wong has posted comments on this change.

Change subject: docs: Add breakpad documentation to user guide
......................................................................


Patch Set 2:

(1 comment)

http://gerrit.cloudera.org:8080/#/c/6504/2/docs/troubleshooting.adoc
File docs/troubleshooting.adoc:

PS2, Line 155: so
             : are not usable without access to the exact binary that crashed, or a very
             : similar binary.
> Without the binary, you can't use the minidump. For example, you can't prin
Ahh, got it. Makes sense


-- 
To view, visit http://gerrit.cloudera.org:8080/6504
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I05275aab0196dbf8fc37da320a0bf34662606a14
Gerrit-PatchSet: 2
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Andrew Wong <aw...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-Reviewer: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Todd Lipcon <to...@apache.org>
Gerrit-HasComments: Yes

[kudu-CR] docs: Add breakpad documentation to user guide

Posted by "Todd Lipcon (Code Review)" <ge...@cloudera.org>.
Todd Lipcon has posted comments on this change.

Change subject: docs: Add breakpad documentation to user guide
......................................................................


Patch Set 2:

(1 comment)

http://gerrit.cloudera.org:8080/#/c/6504/2/docs/troubleshooting.adoc
File docs/troubleshooting.adoc:

PS2, Line 162: Note that while a minidump does not contain a
             : heap memory dump, it does contain stack memory and therefore it is possible for
             : application-specific information to appear in a minidump.
move this to a NOTE: section (adoc has special syntax for it).

Also I think "application-specific" is not quite clear. Perhaps "user data" or "application data", and add another sentence saying something like "If confidential or personal information is stored on the cluster, do not share minidump files." to make it extra explicit


-- 
To view, visit http://gerrit.cloudera.org:8080/6504
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I05275aab0196dbf8fc37da320a0bf34662606a14
Gerrit-PatchSet: 2
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-Reviewer: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Todd Lipcon <to...@apache.org>
Gerrit-HasComments: Yes

[kudu-CR] docs: Add breakpad documentation to user guide

Posted by "Mike Percy (Code Review)" <ge...@cloudera.org>.
Hello Todd Lipcon, Kudu Jenkins,

I'd like you to reexamine a change.  Please visit

    http://gerrit.cloudera.org:8080/6504

to look at the new patch set (#2).

Change subject: docs: Add breakpad documentation to user guide
......................................................................

docs: Add breakpad documentation to user guide

Change-Id: I05275aab0196dbf8fc37da320a0bf34662606a14
---
M docs/troubleshooting.adoc
1 file changed, 49 insertions(+), 0 deletions(-)


  git pull ssh://gerrit.cloudera.org:29418/kudu refs/changes/04/6504/2
-- 
To view, visit http://gerrit.cloudera.org:8080/6504
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: newpatchset
Gerrit-Change-Id: I05275aab0196dbf8fc37da320a0bf34662606a14
Gerrit-PatchSet: 2
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-Reviewer: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Todd Lipcon <to...@apache.org>

[kudu-CR] docs: Add breakpad documentation to user guide

Posted by "Andrew Wong (Code Review)" <ge...@cloudera.org>.
Andrew Wong has posted comments on this change.

Change subject: docs: Add breakpad documentation to user guide
......................................................................


Patch Set 2:

(1 comment)

http://gerrit.cloudera.org:8080/#/c/6504/2/docs/troubleshooting.adoc
File docs/troubleshooting.adoc:

PS2, Line 155: so
             : are not usable without access to the exact binary that crashed, or a very
             : similar binary.
I might be missing context wrt how minidumps are used. Is this referring to the above point that the minidump contains info about processes, shared lib versions, etc. or is there another aspect in which the minidumps aren't usable in the absence of binaries?


-- 
To view, visit http://gerrit.cloudera.org:8080/6504
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I05275aab0196dbf8fc37da320a0bf34662606a14
Gerrit-PatchSet: 2
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Andrew Wong <aw...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-Reviewer: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Todd Lipcon <to...@apache.org>
Gerrit-HasComments: Yes

[kudu-CR] docs: Add breakpad documentation to user guide

Posted by "Mike Percy (Code Review)" <ge...@cloudera.org>.
Mike Percy has posted comments on this change.

Change subject: docs: Add breakpad documentation to user guide
......................................................................


Patch Set 1:

(4 comments)

http://gerrit.cloudera.org:8080/#/c/6504/1/docs/minidumps.adoc
File docs/minidumps.adoc:

PS1, Line 34: To disable minidump generation, set the
            : `--enable_minidumps` flag to `false`. 
> why would a user want to disable it?
I suppose they might want to disable it if they are very paranoid about PII that might be on the stack at the time of a crash. But I'll just remove this; they can refer to the configuration reference to find the flag to disable it.


Line 64: Kudu developers have access to the minidump tools in their development
> I think this developer-facing doc should be moved to different docs folder 
Removed for now.


Line 100: == Dumping the minidump stack trace to a text file (TODO)
> TODO?
Removed


http://gerrit.cloudera.org:8080/#/c/6504/1/docs/support/jekyll-templates/document.html.erb
File docs/support/jekyll-templates/document.html.erb:

Line 101:         :minidumps, "Debugging with minidumps",
> maybe this belongs under Troubleshooting?
Moved to troubleshooting and changed the title of the section to Reporting Kudu Crashes.


-- 
To view, visit http://gerrit.cloudera.org:8080/6504
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I05275aab0196dbf8fc37da320a0bf34662606a14
Gerrit-PatchSet: 1
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-Reviewer: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Todd Lipcon <to...@apache.org>
Gerrit-HasComments: Yes

[kudu-CR] docs: Add breakpad documentation to user guide

Posted by "Mike Percy (Code Review)" <ge...@cloudera.org>.
Mike Percy has posted comments on this change.

Change subject: docs: Add breakpad documentation to user guide
......................................................................


Patch Set 2:

(4 comments)

http://gerrit.cloudera.org:8080/#/c/6504/2/docs/troubleshooting.adoc
File docs/troubleshooting.adoc:

Line 147: 
> Does it make sense to add information about enabling/disabling minidumps us
I am not sure why people will want to disable it, so that's why I removed that from the doc. It is enabled by default on Linux, which is the only platform that it's supported on.


PS2, Line 148: glog
> nit: why not just 'log' ?
To avoid confusion with the WAL


PS2, Line 155: so
             : are not usable without access to the exact binary that crashed, or a very
             : similar binary.
> I might be missing context wrt how minidumps are used. Is this referring to
Without the binary, you can't use the minidump. For example, you can't print stack trace from the minidump without also having the binary. Think of it like a core file in that regard. I am glossing over the fact that if the symbols are extracted from the binary then there are things you can do with the minidump without the binary, since that is a low level detail that doesn't really seem relevant to users.


PS2, Line 162: Note that while a minidump does not contain a
             : heap memory dump, it does contain stack memory and therefore it is possible for
             : application-specific information to appear in a minidump.
> move this to a NOTE: section (adoc has special syntax for it).
Done


-- 
To view, visit http://gerrit.cloudera.org:8080/6504
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I05275aab0196dbf8fc37da320a0bf34662606a14
Gerrit-PatchSet: 2
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Andrew Wong <aw...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-Reviewer: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Todd Lipcon <to...@apache.org>
Gerrit-HasComments: Yes

[kudu-CR] docs: Add breakpad documentation to user guide

Posted by "Todd Lipcon (Code Review)" <ge...@cloudera.org>.
Todd Lipcon has posted comments on this change.

Change subject: docs: Add breakpad documentation to user guide
......................................................................


Patch Set 1:

(4 comments)

http://gerrit.cloudera.org:8080/#/c/6504/1/docs/minidumps.adoc
File docs/minidumps.adoc:

PS1, Line 34: To disable minidump generation, set the
            : `--enable_minidumps` flag to `false`. 
why would a user want to disable it?


Line 64: Kudu developers have access to the minidump tools in their development
I think this developer-facing doc should be moved to different docs folder and keep this doc with just user-facing info on what minidumps are and where to send them.


Line 100: == Dumping the minidump stack trace to a text file (TODO)
TODO?


http://gerrit.cloudera.org:8080/#/c/6504/1/docs/support/jekyll-templates/document.html.erb
File docs/support/jekyll-templates/document.html.erb:

Line 101:         :minidumps, "Debugging with minidumps",
maybe this belongs under Troubleshooting?

"Debugging" also sounds like we're expecting users to debug kudu. Perhaps better to call it "Reporting Kudu crashes" or something?


-- 
To view, visit http://gerrit.cloudera.org:8080/6504
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I05275aab0196dbf8fc37da320a0bf34662606a14
Gerrit-PatchSet: 1
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-Reviewer: Todd Lipcon <to...@apache.org>
Gerrit-HasComments: Yes

[kudu-CR] docs: Add breakpad documentation to user guide

Posted by "Todd Lipcon (Code Review)" <ge...@cloudera.org>.
Todd Lipcon has posted comments on this change.

Change subject: docs: Add breakpad documentation to user guide
......................................................................


Patch Set 3: Code-Review+2

-- 
To view, visit http://gerrit.cloudera.org:8080/6504
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I05275aab0196dbf8fc37da320a0bf34662606a14
Gerrit-PatchSet: 3
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Andrew Wong <aw...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-Reviewer: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Todd Lipcon <to...@apache.org>
Gerrit-HasComments: No

[kudu-CR] docs: Add breakpad documentation to user guide

Posted by "Todd Lipcon (Code Review)" <ge...@cloudera.org>.
Todd Lipcon has submitted this change and it was merged.

Change subject: docs: Add breakpad documentation to user guide
......................................................................


docs: Add breakpad documentation to user guide

Change-Id: I05275aab0196dbf8fc37da320a0bf34662606a14
Reviewed-on: http://gerrit.cloudera.org:8080/6504
Tested-by: Kudu Jenkins
Reviewed-by: Alexey Serbin <as...@cloudera.com>
Reviewed-by: Todd Lipcon <to...@apache.org>
---
M docs/troubleshooting.adoc
1 file changed, 50 insertions(+), 0 deletions(-)

Approvals:
  Todd Lipcon: Looks good to me, approved
  Alexey Serbin: Looks good to me, but someone else must approve
  Kudu Jenkins: Verified



-- 
To view, visit http://gerrit.cloudera.org:8080/6504
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I05275aab0196dbf8fc37da320a0bf34662606a14
Gerrit-PatchSet: 4
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Andrew Wong <aw...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-Reviewer: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Todd Lipcon <to...@apache.org>

[kudu-CR] docs: Add breakpad documentation to user guide

Posted by "Alexey Serbin (Code Review)" <ge...@cloudera.org>.
Alexey Serbin has posted comments on this change.

Change subject: docs: Add breakpad documentation to user guide
......................................................................


Patch Set 3: Code-Review+1

(1 comment)

http://gerrit.cloudera.org:8080/#/c/6504/2/docs/troubleshooting.adoc
File docs/troubleshooting.adoc:

PS2, Line 148: glog
> To avoid confusion with the WAL
I see -- that makes sense then.


-- 
To view, visit http://gerrit.cloudera.org:8080/6504
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I05275aab0196dbf8fc37da320a0bf34662606a14
Gerrit-PatchSet: 3
Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-Owner: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Andrew Wong <aw...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-Reviewer: Mike Percy <mp...@apache.org>
Gerrit-Reviewer: Todd Lipcon <to...@apache.org>
Gerrit-HasComments: Yes