core: dump some debug info in `/data/environment` #4755

wchargin · 2021-03-09T05:47:14Z

Summary:
In #4751, we implemented data_location support for RustBoard, which
means that the location no longer includes the gRPC address. But while
this is an improvement for users, the address was convenient for
development, and there’s no other way to get it from the UI. This patch
augments /data/environment to dump some basic debug info: the
TensorBoard version, the data provider, and the command-line flags.

This behavior can be turned off. It’s enabled in tensorboard(1), but
disabled by default on the CorePlugin and CorePluginLoader APIs.
Thus, users who build their own TensorBoards will not find themselves
unexpectedly leaking information about their setup. For normal users of
tensorboard(1), the flags are fine to render; the only potentially
sensitive thing is the logdir path, which is of course already
prominent.

Sample response, passed through jq .:

{
  "version": "2.5.0a0",
  "data_location": "logs/mnist/",
  "window_title": "",
  "debug": {
    "data_provider": "GrpcDataProvider(addr='localhost:32877')",
    "flags": {
      "logdir": "logs/mnist/",
      "logdir_spec": "",
      "host": null,
      "bind_all": true,
      "port": null,
      "reuse_port": false,
      "load_fast": true,
      "grpc_creds_type": "local",
      "grpc_data_provider": "",
      "purge_orphaned_data": true,
      "db": "",
      "db_import": false,
      "inspect": false,
      "version_tb": false,
      "tag": "",
      "event_file": "",
      "path_prefix": "",
      "window_title": "",
      "max_reload_threads": 1,
      "reload_interval": 5,
      "reload_task": "auto",
      "reload_multifile": null,
      "reload_multifile_inactive_secs": 86400,
      "generic_data": "auto",
      "samples_per_plugin": {},
      "custom_predict_fn": "",
      "wit_data_dir": "",
      "__tensorboard_subcommand": "serve"
    }
  }
}

Test Plan:
Manually navigated to /data/environment and verified that the flags
render and the data provider appears for both --load_fast and the
legacy multiplexer. Checked that when the change to default.py is
reverted, no debug data shows up.

wchargin-branch: environment-debug-info

Summary: In #4751, we implemented `data_location` support for RustBoard, which means that the location no longer includes the gRPC address. But while this is an improvement for users, the address was convenient for development, and there’s no other way to get it from the UI. This patch augments `/data/environment` to dump some basic debug info: the TensorBoard version, the data provider, and the command-line flags. This behavior can be turned off. It’s enabled in `tensorboard(1)`, but disabled by default on the `CorePlugin` and `CorePluginLoader` APIs. Thus, users who build their own TensorBoards will not find themselves unexpectedly leaking information about their setup. For normal users of `tensorboard(1)`, the flags are fine to render; the only potentially sensitive thing is the logdir path, which is of course already prominent. Sample response, passed through `jq .`: ``` { "data_location": "logs/mnist/", "window_title": "", "debug": { "version": "2.5.0a0", "data_provider": "GrpcDataProvider(addr='localhost:42127')", "flags": { "logdir": "logs/mnist/", "logdir_spec": "", "host": null, "bind_all": true, "port": null, "reuse_port": false, "load_fast": true, "grpc_creds_type": "local", "grpc_data_provider": "", "purge_orphaned_data": true, "db": "", "db_import": false, "inspect": false, "version_tb": false, "tag": "", "event_file": "", "path_prefix": "", "window_title": "", "max_reload_threads": 1, "reload_interval": 5, "reload_task": "auto", "reload_multifile": null, "reload_multifile_inactive_secs": 86400, "generic_data": "auto", "samples_per_plugin": { "scalars": 0, "images": 0 }, "custom_predict_fn": "", "wit_data_dir": "", "__tensorboard_subcommand": "serve" } } } ``` Test Plan: Manually navigated to `/data/environment` and verified that the flags render and the data provider appears for both `--load_fast` and the legacy multiplexer. Checked that when the change to `default.py` is reverted, no debug data shows up. wchargin-branch: environment-debug-info wchargin-source: 772a3783d6f19e4060b37fe43076b963cfd8d96e

wchargin · 2021-03-09T05:49:01Z

tensorboard/plugins/core/core_plugin.py

+            default to prevent surprising information leaks in custom builds of
+            TensorBoard.
        """
+        self._flags = context.flags


Apropos of #2801 and comments on #4411: I don’t mind this because it
really does want to get all of flags rather than just using it as a
shortcut for some specific properties, and also because this
functionality really could be part of the actual core, anyway.
But open to pushback if you disagree.

Yeah, I agree it's fine for now, although if you don't mind editing #2801 after this goes in so it reflects the current state that'd be helpful.

wchargin-branch: environment-debug-info wchargin-source: e55a96e2e1623792787aebc9603c54da67ad6e85

nfelt

Let's also update http_api.md?
https://github.com/tensorflow/tensorboard/blob/master/tensorboard/http_api.md#dataenvironment

Maybe worth specifying there and possibly in the code that the format of the debug payload is subject to change and intended for human consumption, not machine consumption, so that we can change it in the future without being told we broke someone's workflow.

nfelt · 2021-03-10T05:25:34Z

tensorboard/plugins/core/core_plugin.py

+            default to prevent surprising information leaks in custom builds of
+            TensorBoard.
        """
+        self._flags = context.flags


Yeah, I agree it's fine for now, although if you don't mind editing #2801 after this goes in so it reflects the current state that'd be helpful.

nfelt · 2021-03-10T05:29:36Z

tensorboard/plugins/core/core_plugin.py

            )
+        if self._include_debug_info:
+            environment["debug"] = {
+                "version": version.VERSION,


Maybe worth including version unconditionally at the top level? That seems safe, and it's more structured than the rest, so we could exempt it from the "human consumption only" constraint in case we do want to render it in the frontend.

Sure; done. The Python version can be read from the Server response
header already, so I don’t see much harm in exposing the TensorBoard
version.

wchargin-branch: environment-debug-info wchargin-source: 35e9a6c306c132075e402bf6d74878237b65c806

wchargin

Let's also update http_api.md? […]

Done; thanks.

wchargin · 2021-03-11T19:54:13Z

tensorboard/plugins/core/core_plugin.py

+            default to prevent surprising information leaks in custom builds of
+            TensorBoard.
        """
+        self._flags = context.flags


wchargin · 2021-03-11T19:54:17Z

tensorboard/plugins/core/core_plugin.py

            )
+        if self._include_debug_info:
+            environment["debug"] = {
+                "version": version.VERSION,


Sure; done. The Python version can be read from the Server response
header already, so I don’t see much harm in exposing the TensorBoard
version.

wchargin added core:backend theme:usability Areas to reduce confusion and frustration. labels Mar 9, 2021

google-cla bot added the cla: yes label Mar 9, 2021

wchargin commented Mar 9, 2021

View reviewed changes

wchargin requested a review from nfelt March 9, 2021 05:50

[environment-debug-info: fix buildifier]

185591e

wchargin-branch: environment-debug-info wchargin-source: e55a96e2e1623792787aebc9603c54da67ad6e85

nfelt reviewed Mar 10, 2021

View reviewed changes

nfelt approved these changes Mar 10, 2021

View reviewed changes

wchargin added 2 commits March 11, 2021 11:59

[environment-debug-info: update diffbase]

780648c

wchargin-branch: environment-debug-info wchargin-source: 35e9a6c306c132075e402bf6d74878237b65c806

[environment-debug-info: update patch]

da59f82

wchargin-branch: environment-debug-info wchargin-source: 35e9a6c306c132075e402bf6d74878237b65c806

wchargin commented Mar 11, 2021

View reviewed changes

wchargin merged commit edcf254 into master Mar 11, 2021

wchargin deleted the wchargin-environment-debug-info branch March 11, 2021 20:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

core: dump some debug info in `/data/environment` #4755

core: dump some debug info in `/data/environment` #4755

Uh oh!

wchargin commented Mar 9, 2021 •

edited

Loading

Uh oh!

wchargin Mar 9, 2021

Uh oh!

nfelt Mar 10, 2021

Uh oh!

wchargin Mar 11, 2021

Uh oh!

nfelt left a comment

Uh oh!

nfelt Mar 10, 2021

Uh oh!

nfelt Mar 10, 2021

Uh oh!

wchargin Mar 11, 2021

Uh oh!

wchargin left a comment

Uh oh!

wchargin Mar 11, 2021

Uh oh!

wchargin Mar 11, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

core: dump some debug info in /data/environment #4755

core: dump some debug info in /data/environment #4755

Uh oh!

Conversation

wchargin commented Mar 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nfelt left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wchargin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

core: dump some debug info in `/data/environment` #4755

core: dump some debug info in `/data/environment` #4755

wchargin commented Mar 9, 2021 •

edited

Loading