apply review suggestions

Co-authored-by: Marc Pichler <[email protected]>

Author: raphael-theriault-swi

experimental/CHANGELOG.md

@@ -9,11 +9,13 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
 ### :boom: Breaking Changes
 
 * feat(api-logs)!: Marked private methods as "conventionally private". [#5789](https://github.com/open-telemetry/opentelemetry-js/pull/5789)
+* feat(exporter-otlp-\*): support custom HTTP agents [#5719](https://github.com/open-telemetry/opentelemetry-js/pull/5719) @raphael-theriault-swi
+  * `OtlpHttpConfiguration.agentOptions` has been removed and functionality has been rolled into `OtlpHttpConfiguration.agentFactory`
+    * (old) `{ agentOptions: myOptions }`
+    * (new) `{ agentFactory: httpAgentFactoryFromOptions(myOptions) }`
 
 ### :rocket: Features
 
-* feat(exporter-otlp-\*): support custom HTTP agents [#5719](https://github.com/open-telemetry/opentelemetry-js/pull/5719) @raphael-theriault-swi
-
 ### :bug: Bug Fixes
 
 * fix(otlp-exporter-base): prioritize `esnext` export condition as it is more specific [#5458](https://github.com/open-telemetry/opentelemetry-js/pull/5458)

experimental/packages/otlp-exporter-base/src/configuration/legacy-node-configuration.ts

@@ -27,6 +27,28 @@ import type { HttpAgentFactory } from './otlp-http-configuration';
 export interface OTLPExporterNodeConfigBase extends OTLPExporterConfigBase {
   keepAlive?: boolean;
   compression?: CompressionAlgorithm;
+  /**
+   * Custom HTTP agent options or a factory function for creating agents.
+   *
+   * @remarks
+   * Prefer using `http.AgentOptions` or `https.AgentOptions` over a factory function wherever possible.
+   * If using a factory function (`HttpAgentFactory`), **do not import `http.Agent` or `https.Agent`
+   * statically at the top of the file**.
+   * Instead, use dynamic `import()` or `require()` to load the module. This ensures that the `http` or `https`
+   * module is not loaded before `@opentelemetry/instrumentation-http` can instrument it.
+   *
+   * @example <caption> Using agent options directly: </caption>
+   * httpAgentOptions: {
+   *   keepAlive: true,
+   *   maxSockets: 10
+   * }
+   *
+   * @example <caption> Using a factory with dynamic import: </caption>
+   * httpAgentOptions: async (protocol) => {
+   *   const module = protocol === 'http:' ? await import('http') : await import('https');
+   *   return new module.Agent({ keepAlive: true });
+   * }
+   */
   httpAgentOptions?: http.AgentOptions | https.AgentOptions | HttpAgentFactory;
 }
 

experimental/packages/otlp-exporter-base/src/configuration/otlp-http-configuration.ts

@@ -25,15 +25,23 @@ import { validateAndNormalizeHeaders } from '../util';
 import type * as http from 'http';
 import type * as https from 'https';
 
-export type HttpAgentFactory =
-  | ((protocol: string) => http.Agent)
-  | ((protocol: string) => https.Agent)
-  | ((protocol: string) => Promise<http.Agent>)
-  | ((protocol: string) => Promise<https.Agent>);
+export type HttpAgentFactory = (
+  protocol: string
+) => http.Agent | https.Agent | Promise<http.Agent> | Promise<https.Agent>;
 
 export interface OtlpHttpConfiguration extends OtlpSharedConfiguration {
   url: string;
   headers: () => Record<string, string>;
+  /**
+   * Factory function for creating agents.
+   *
+   * @remarks
+   * Prefer using {@link httpAgentFactoryFromOptions} over manually writing a factory function wherever possible.
+   * If using a factory function (`HttpAgentFactory`), **do not import `http.Agent` or `https.Agent`
+   * statically at the top of the file**.
+   * Instead, use dynamic `import()` or `require()` to load the module. This ensures that the `http` or `https`
+   * module is not loaded before `@opentelemetry/instrumentation-http` can instrument it.
+   */
   agentFactory: HttpAgentFactory;
 }
 

scripts/update-ts-configs.js

@@ -40,7 +40,6 @@ const tsConfigMergeKeys = [
   'compilerOptions',
   'include',
   'files',
-  "ts-node",
 ];
 // Make `extends` the first field.
 const tsConfigPriorityKeys = ['extends'];