[Feature Request] Explain OpenTelemetryPlugin's interaction with WorkflowCodeBundler?

[FauxFaux]

Is your feature request related to a problem? Please describe.

I have failed to correctly configure OpenTelemetry trace reporting in my large application with an existing opentelemetry setup. It works for activities and StartWorkflow, but not for the tasks which happen inside a workflow.

The docs advise us to new WorkflowCodeBundler({ workflowsPath }).createBundle(); at build time.

I have inferred from a comment in the sample code that we are expected to pass the plugin during bundling.

But, the plugin's constructor requires a SpanProcessor and a Resource? I do not have these available at build time. I cannot think how they would be serialised into the bundle. I do not want the Resource serialised into the bundle.

Describe the solution you'd like

I suspect that these attributes are actually unused at bundling time, so perhaps another plugin (with associated docs) would be clearer?

new WorkflowCodeBundler({
  workflowsPath,
  plugins: [new OpenTelemetryBundlingPlugin(/* no args */)],
}).createBundle();

Worker.create({
  ...,
  plugins: [new OpenTelemetryWorkerPlugin(otelNodeSdk)],
});

[chris-olszewski]

You are correct that the plugin needs to be passed in at bundle time. The initial plugin design matched what you suggested, but we decided not to pursue it initially as the current plugin interface definition does not allow us to prevent plugin misuse e.g. new WorkflowCodeBundler({ ..., plugins: [new ClientPlugin()}).

As a current work around you should be to use an explicit cast since those required options are only used by the worker and not at bundle time:

new WorkflowCodeBundler({
  workflowsPath,
  plugins: [new OpenTelemetryPlugin({} as OpenTelemetryPluginOptions)],
}).createBundle();

I will see if we could prioritize making this easier to use correctly.