refactor: moved agent config types to collector (#2011)

refs #2010

Author: kirrg001

packages/collector/src/agent/opts.js

@@ -16,7 +16,7 @@ exports.agentUuid = undefined;
 // @ts-ignore - Cannot redeclare exported variable
 exports.autoProfile = false;
 
-/** @type {import('@instana/core/src/config').AgentConfig} config */
+/** @type {import('@instana/collector/src/types/collector').AgentConfig} config */
 exports.config = {};
 
 /**

packages/collector/src/announceCycle/unannounced.js

@@ -43,9 +43,9 @@ const maxRetryDelay = 60 * 1000; // one minute
  * @typedef {Object} TracingConfig
  * @property {Array.<string>} [extra-http-headers]
  * @property {KafkaTracingConfig} [kafka]
- * @property {import('@instana/core/src/tracing').IgnoreEndpoints} [ignore-endpoints]
+ * @property {import('@instana/core/src/config/types').IgnoreEndpoints} [ignore-endpoints]
  * @property {boolean} [span-batching-enabled]
- * @property {import('@instana/core/src/tracing').Disable} [disable]
+ * @property {import('@instana/core/src/config/types').Disable} [disable]
  */
 
 /**

packages/collector/src/types/collector.d.ts

@@ -1,4 +1,21 @@
 import { GenericLogger } from '@instana/core/src/core';
+import { IgnoreEndpoints, Disable } from '@instana/core/src/config/types';
+
+export interface AgentConfig {
+  tracing?: {
+    http?: {
+      extraHttpHeadersToCapture?: string[];
+    };
+    kafka?: {
+      traceCorrelation?: boolean;
+    };
+    spanBatchingEnabled?: boolean | string;
+    ignoreEndpoints?: IgnoreEndpoints;
+    disable?: Disable;
+    [key: string]: any;
+  };
+  [key: string]: any;
+}
 
 export interface CollectorConfig {
   agentPort?: number;

packages/core/src/config/configNormalizers/disable.js

@@ -104,7 +104,7 @@ exports.normalizeExternalConfig = function normalizeExternalConfig(config) {
  * 3. INSTANA_TRACING_DISABLE=list
  * 4. INSTANA_DISABLED_TRACERS (deprecated)
  *
- * @returns {import('../../tracing').Disable}
+ * @returns {import('../../config/types').Disable}
  */
 function getDisableFromEnv() {
   const disable = {};

packages/core/src/config/configNormalizers/ignoreEndpoints.js

@@ -25,8 +25,8 @@ exports.init = function init(config) {
  * Normalized internal structure:
  * - { [serviceName: string]: [{ methods: string[], endpoints: string[] }] }
  *
- * @param {import('../../tracing').IgnoreEndpoints} ignoreEndpointConfig
- * @returns {import('../../tracing').IgnoreEndpoints}
+ * @param {import('../../config/types').IgnoreEndpoints} ignoreEndpointConfig
+ * @returns {import('../../config/types').IgnoreEndpoints}
  */
 
 exports.normalizeConfig = function normalizeConfig(ignoreEndpointConfig) {

packages/core/src/config/index.js

@@ -23,13 +23,13 @@ const deepMerge = require('../util/deepMerge');
  * @property {number} [transmissionDelay]
  * @property {number} [stackTraceLength]
  * @property {HTTPTracingOptions} [http]
- * @property {import('../tracing').Disable} [disable]
+ * @property {import('../config/types').Disable} [disable]
  * @property {Array<string>} [disabledTracers]
  * @property {boolean} [spanBatchingEnabled]
  * @property {boolean} [disableW3cTraceCorrelation]
  * @property {KafkaTracingOptions} [kafka]
  * @property {boolean} [allowRootExitSpan]
- * @property {import('../tracing').IgnoreEndpoints} [ignoreEndpoints]
+ * @property {import('../config/types').IgnoreEndpoints} [ignoreEndpoints]
  * @property {boolean} [ignoreEndpointsDisableSuppression]
  * @property {boolean} [disableEOLEvents]
  */
@@ -74,30 +74,6 @@ const allowedSecretMatchers = ['equals', 'equals-ignore-case', 'contains', 'cont
  * @property {number} [timeBetweenHealthcheckCalls]
  */
 
-/**
- * @typedef {Object} AgentConfig
- * @property {AgentTracingConfig} [tracing]
- */
-
-/**
- * @typedef {Object} AgentTracingConfig
- * @property {AgentTracingHttpConfig} [http]
- * @property {AgentTracingKafkaConfig} [kafka]
- * @property {boolean|string} [spanBatchingEnabled]
- * @property {import('../tracing').IgnoreEndpoints} [ignoreEndpoints]
- * @property {import('../tracing').Disable} [disable]
- */
-
-/**
- * @typedef {Object} AgentTracingHttpConfig
- * @property {Array.<string>} [extraHttpHeadersToCapture]
- */
-
-/**
- * @typedef {Object} AgentTracingKafkaConfig
- * @property {boolean} [traceCorrelation]
- */
-
 /** @type {import('../core').GenericLogger} */
 let logger;
 

packages/core/src/config/types.d.ts

@@ -0,0 +1,16 @@
+export interface IgnoreEndpoints {
+  [key: string]: IgnoreEndpointsFields[];
+}
+
+export interface IgnoreEndpointsFields {
+  methods?: string[];
+  endpoints?: string[];
+  connections?: string[];
+}
+
+export interface TracingDisableOptions {
+  instrumentations?: string[];
+  groups?: string[];
+}
+
+export type Disable = TracingDisableOptions | boolean;

packages/core/src/tracing/index.js

@@ -118,27 +118,6 @@ if (customInstrumentations.length > 0) {
  * @property {boolean} [traceCorrelation]
  */
 
-/**
- * @typedef {Object.<string,IgnoreEndpointsFields[]>}  IgnoreEndpoints
- */
-
-/**
- * @typedef {Object} IgnoreEndpointsFields
- * @property {string[]} [methods]
- * @property {string[]} [endpoints]
- * @property {string[]} [connections]
- */
-
-/**
- * @typedef {TracingDisableOptions|boolean} Disable
- */
-
-/**
- * @typedef {Object} TracingDisableOptions
- * @property {string[]} [instrumentations]
- * @property {string[]} [groups]
- */
-
 /** @type {Array.<InstanaInstrumentedModule>} */
 let additionalInstrumentationModules = [];
 /** @type {Object.<string, InstanaInstrumentedModule>} */

packages/core/src/tracing/spanBuffer.js

@@ -103,7 +103,7 @@ exports.init = function init(config, _downstreamConnection) {
 };
 
 /**
- * @param {import('../config').AgentConfig} extraConfig
+ * @param {import('@instana/collector/src/types/collector').AgentConfig} extraConfig
  */
 exports.activate = function activate(extraConfig) {
   if (!downstreamConnection) {

packages/core/src/util/disableInstrumentation.js

@@ -9,7 +9,7 @@ const { DISABLABLE_INSTRUMENTATION_GROUPS } = require('../tracing/constants');
 /** @type {import('../config').InstanaConfig} */
 let config;
 
-/** @type {import('../config').AgentConfig} */
+/** @type {import('@instana/collector/src/types/collector').AgentConfig} */
 let agentConfig;
 
 /**
@@ -20,7 +20,7 @@ function init(_config) {
 }
 
 /**
- * @param {import('../config').AgentConfig} _agentConfig
+ * @param {import('@instana/collector/src/types/collector').AgentConfig} _agentConfig
  */
 function activate(_agentConfig) {
   agentConfig = _agentConfig;