ruby-core@ruby-lang.org archive (unofficial mirror)
 help / color / mirror / Atom feed
From: "byroot (Jean Boussier) via ruby-core" <ruby-core@ml.ruby-lang.org>
To: ruby-core@ml.ruby-lang.org
Cc: "byroot (Jean Boussier)" <noreply@ruby-lang.org>
Subject: [ruby-core:117592] [Ruby master Feature#20396] ObjectSpace.dump_all(string_value: false): skip dumping the String contents
Date: Thu, 18 Apr 2024 06:56:03 +0000 (UTC)	[thread overview]
Message-ID: <redmine.journal-107993.20240418065603.7941@ruby-lang.org> (raw)
In-Reply-To: redmine.issue-20396.20240327082934.7941@ruby-lang.org

Issue #20396 has been updated by byroot (Jean Boussier).


I'm not sure reasoning by analogy with core dumps is sound here. If there was a way to be sure a core dump is stripped of all personally identifiable informations I'd definitely use it to share core dumps when it's useful.

> because, I'm pretty sure this is not the last thing you wanted for the output. ... and pretty sure we would end up need an entire SQL engine.

I think this is a bit of an unfair argument. Yes I requested multiple additions to this API over the last few years, but in my opinion there is a very long way to go before it can considered a complex API, especially for an API that is intended for very advanced debugging. And it's not like I have a long list of feature requests I'm drip feeding.

Also I don't even need that capability myself, I suggested it because I was trying to help @zzak  fix a memory leak at his company, and the dumps containing string values made it hard for him to get approval to generate heap dumps from production  because of security concerns, and thought this new option it could be useful for the community. 

----------------------------------------
Feature #20396: ObjectSpace.dump_all(string_value: false): skip dumping the String contents
https://bugs.ruby-lang.org/issues/20396#change-107993

* Author: byroot (Jean Boussier)
* Status: Open
----------------------------------------
`ObjectSpace.dump_all` is a very useful method to debug memory leaks and such, hence is frequently needed in production. But since all the 7bit strings content is included in the dump, it incur the risk of leaking personal data, or secrets.

Also, in many case the strings content isn't that helpful and is just making the dump much bigger for no good reason. And only pure-ASCII strings are dumped this way, which means all the tools that process these dumps should already be compatible with a dump without any string content.

### Feature

I propose to add another optional parameter to `dump_all`: `string_value: false`. When passed, no String content is ever dumped regardless of its coderange.

Implementation: https://github.com/ruby/ruby/pull/10382

cc @zzak



-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/postorius/lists/ruby-core.ml.ruby-lang.org/

      parent reply	other threads:[~2024-04-18  6:56 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-27  8:29 [ruby-core:117341] [Ruby master Feature#20396] ObjectSpace.dump_all(string_value: false): skip dumping the String contents byroot (Jean Boussier) via ruby-core
2024-03-27  8:48 ` [ruby-core:117342] " ko1 (Koichi Sasada) via ruby-core
2024-03-27  8:50 ` [ruby-core:117343] " byroot (Jean Boussier) via ruby-core
2024-03-27 16:55 ` [ruby-core:117345] " jhawthorn (John Hawthorn) via ruby-core
2024-04-17  8:38 ` [ruby-core:117551] " shyouhei (Shyouhei Urabe) via ruby-core
2024-04-17  8:41 ` [ruby-core:117552] " byroot (Jean Boussier) via ruby-core
2024-04-18  0:39 ` [ruby-core:117582] " shyouhei (Shyouhei Urabe) via ruby-core
2024-04-18  6:56 ` byroot (Jean Boussier) via ruby-core [this message]

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-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.ruby-lang.org/en/community/mailing-lists/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=redmine.journal-107993.20240418065603.7941@ruby-lang.org \
    --to=ruby-core@ruby-lang.org \
    --cc=noreply@ruby-lang.org \
    --cc=ruby-core@ml.ruby-lang.org \
    /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 read-only IMAP folder(s) and NNTP newsgroup(s).