Idea #17284: [controller] Redact internal RailsAPI URLs from error messages returned to caller - Arvados

Actions

Copy link

Idea #17284

closed

[controller] Redact internal RailsAPI URLs from error messages returned to caller

Added by Tom Clegg about 3 years ago. Updated almost 3 years ago.

Status:

Resolved

Priority:

Normal

Assigned To:

Tom Clegg

Category:

API

Target version:

2021-05-12 sprint

Story points:

Release:

Arvados 2.2.0

Release relationship:

Auto

Description

Currently, controller returns error messages like this:

request failed: http://localhost:8004/arvados/v1/containers/ce8i5-4zz18-t1qaidhvwn7rusu: 404 Not Found: Path not found (req-yewplazjko7817hghxxk)

The "http://localhost:8004" part can be confusing/misleading to someone who was expecting to connect to "https://ce8i5.arvadosapi.com". It also reveals a bit of detail about internal configuration, which might not be desirable (if the RailsAPI internal URL were an internal domain name instead of localhost, for example).

On the other hand, the internal URL (and the fact that the error originated from RailsAPI rather than controller itself) can be useful for troubleshooting.

We might:

Change "http://localhost:8004" to "//railsapi.internal" in these error messages
Remove the "http://localhost:8004" part entirely
Make this behavior configurable

Subtasks 1 (0 open — 1 closed)

Related issues

Actions

Copy link

Updated by Tom Clegg about 3 years ago

Related to Feature #17170: Shell into container proof of concept added

Actions

Copy link

Updated by Ward Vandewege about 3 years ago

It seems to me that the normal pattern would be appropriate here:

a) not leaking internal information in a user level error message
b) providing more detailed information including the internal URL in the service logs

I don't think we should make this a configurable thing, that's just unneeded complexity.

Actions

Copy link