[leandrowilliam]

Closes

Closes #1464

Overview

Components' server-side console is currently only wired to the real console when local is true (i.e. oc dev). In deployed registries there's no way to see component logs.

Solution

Following @ricardo-devis-agullo's suggestion, add an optional componentConsole registry option. The registry passes it into the component sandbox, so you can provide console or a console-like object that forwards logs to a monitoring provider.

oc.Registry({
  // ...
  componentConsole: myMonitoringConsole
});

Defaults are unchanged: if componentConsole isn't set, components get the real console when local is true and a no-op console otherwise.

• packages/oc/src/types.ts: new optional componentConsole?: Partial<Console> on Config
• packages/oc/src/registry/routes/helpers/get-component.ts: conf.componentConsole ?? (conf.local ? console : noopConsole)
• Unit test + changeset (minor)

Rebased onto the current monorepo layout, replacing the earlier version of this PR.

cc: @kmcrawford @GinGatt

[ricardo-devis-agullo]

Hi, the distinction here is not local filesystem or remote storage, but local development or production. I don't think it's a great idea to let all components log on the registry without control. Even if we were I don't think enableComponentConsoleOutput is a great name, and even in that case, if we are going to give a pass to let components log, it might be better to let the the registry provide a console interface ({ componentConsole: console }), so perhaps you could pass a console interface that sends logs to a monitoring provider instead

[leandrowilliam]

Hi, the distinction here is not local filesystem or remote storage, but local development or production. I don't think it's a great idea to let all components log on the registry without control. Even if we were I don't think enableComponentConsoleOutput is a great name, and even in that case, if we are going to give a pass to let components log, it might be better to let the the registry provide a console interface ({ componentConsole: console }), so perhaps you could pass a console interface that sends logs to a monitoring provider instead

Got it, thanks for the clarification. I agree with that direction. I’ll update the approach and push the changes shortly

[leandrowilliam]

@ricardo-devis-agullo Let me know if that works for you or if you think we should adjust anything else. Thanks

Update: I also left a note in the issue

[leandrowilliam]

@ricardo-devis-agullo Hi, do you have any updates on this one? Thanks

[leandrowilliam]

@ricardo-devis-agullo I updated this PR, can we get it merged?