@codefresh-io/cf-telemetry 2.3.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,3 +1,4 @@
1
1
  export declare const config: {
2
2
  readonly enabled: boolean;
3
+ readonly allowHttpInstrumentation: boolean;
3
4
  };
@@ -3,5 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.config = void 0;
4
4
  exports.config = {
5
5
  enabled: process.env['CF_TELEMETRY_OTEL_ENABLE'] === 'true',
6
+ allowHttpInstrumentation: process.env['CF_TELEMETRY_OTEL_ALLOW_HTTP_INSTRUMENTATION'] === 'true',
6
7
  };
7
8
  //# sourceMappingURL=config.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/otel/config.ts"],"names":[],"mappings":";;;AAAa,QAAA,MAAM,GAAG;IACpB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,KAAK,MAAM;CACnD,CAAC"}
1
+ {"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/otel/config.ts"],"names":[],"mappings":";;;AAAa,QAAA,MAAM,GAAG;IACpB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,KAAK,MAAM;IAC3D,wBAAwB,EAAE,OAAO,CAAC,GAAG,CAAC,8CAA8C,CAAC,KAAK,MAAM;CACxF,CAAC"}
@@ -0,0 +1 @@
1
+ export declare const disableHttpInstrumentation: () => void;
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.disableHttpInstrumentation = void 0;
4
+ const disableHttpInstrumentation = () => {
5
+ const disabledOtelInstrumentations = new Set(process.env['OTEL_NODE_DISABLED_INSTRUMENTATIONS']
6
+ ?.split(',')
7
+ .reduce((acc, instrumentation) => {
8
+ const trimmed = instrumentation.trim();
9
+ if (trimmed)
10
+ acc.push(trimmed);
11
+ return acc;
12
+ }, []));
13
+ disabledOtelInstrumentations.add('http');
14
+ process.env['OTEL_NODE_DISABLED_INSTRUMENTATIONS'] = [...disabledOtelInstrumentations].join(',');
15
+ };
16
+ exports.disableHttpInstrumentation = disableHttpInstrumentation;
17
+ //# sourceMappingURL=disable-http-instrumentation.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"disable-http-instrumentation.js","sourceRoot":"","sources":["../../src/otel/disable-http-instrumentation.ts"],"names":[],"mappings":";;;AAAO,MAAM,0BAA0B,GAAG,GAAS,EAAE;IACnD,MAAM,4BAA4B,GAAG,IAAI,GAAG,CAC1C,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC;QAChD,EAAE,KAAK,CAAC,GAAG,CAAC;SACX,MAAM,CAAC,CAAC,GAAG,EAAE,eAAe,EAAE,EAAE;QAC/B,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,EAAE,CAAC;QACvC,IAAI,OAAO;YAAE,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/B,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAc,CAAC,CACrB,CAAC;IACF,4BAA4B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACzC,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,GAAG,CAAC,GAAG,4BAA4B,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACnG,CAAC,CAAC;AAZW,QAAA,0BAA0B,8BAYrC"}
package/dist/otel/sdk.js CHANGED
@@ -9,6 +9,15 @@ const sdk_node_1 = require("@opentelemetry/sdk-node");
9
9
  const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
10
10
  const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
11
11
  const global_config_1 = require("../global-config");
12
+ const config_1 = require("./config");
13
+ const disable_http_instrumentation_1 = require("./disable-http-instrumentation");
14
+ /**
15
+ * HTTP instrumentation is disabled by default because of potential security issues.
16
+ * In particular, it adds span attributes with request query parameters (`url.full` and `url.query`),
17
+ * which may contain sensitive information.
18
+ */
19
+ if (config_1.config.allowHttpInstrumentation !== true)
20
+ (0, disable_http_instrumentation_1.disableHttpInstrumentation)();
12
21
  exports.sdk = new sdk_node_1.NodeSDK({
13
22
  serviceName: global_config_1.globalConfig.serviceName,
14
23
  autoDetectResources: true,
@@ -1 +1 @@
1
- {"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../src/otel/sdk.ts"],"names":[],"mappings":";;;AAAA,0FAAwF;AACxF,kFAAqG;AACrG,sFAA4E;AAC5E,wDAAkE;AAClE,sDAAkD;AAClD,kEAAmE;AACnE,8EAA8F;AAC9F,oDAAgD;AAEnC,QAAA,GAAG,GAAG,IAAI,kBAAO,CAAC;IAC7B,WAAW,EAAE,4BAAY,CAAC,WAAW;IACrC,mBAAmB,EAAE,IAAI;IACzB,QAAQ,EAAE,IAAA,kCAAsB,EAAC;QAC/B,CAAC,wCAAiB,CAAC,EAAE,4BAAY,CAAC,WAAW;QAC7C,CAAC,2CAAoB,CAAC,EAAE,4BAAY,CAAC,cAAc;KACpD,CAAC;IACF,cAAc,EAAE;QACd,IAAI,mCAAkB,CAAC,IAAI,4CAAiB,EAAE,CAAC;QAC/C,wDAAwD;QACxD,IAAI,6CAAoB,CAAC,+CAAsB,CAAC;KACjD;IACD,gBAAgB,EAAE,CAAC,IAAA,wDAA2B,EAAC;YAC7C,qCAAqC,EAAE;gBACrC,YAAY,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;oBAC/B,IAAI,WAAW,IAAI,QAAQ;wBAAE,QAAQ,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,CAAC;gBAC7F,CAAC;aACF;SACF,CAAC,CAAC;CACJ,CAAC,CAAC"}
1
+ {"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../src/otel/sdk.ts"],"names":[],"mappings":";;;AAAA,0FAAwF;AACxF,kFAAqG;AACrG,sFAA4E;AAC5E,wDAAkE;AAClE,sDAAkD;AAClD,kEAAmE;AACnE,8EAA8F;AAC9F,oDAAgD;AAChD,qCAAkC;AAClC,iFAA4E;AAE5E;;;;GAIG;AACH,IAAI,eAAM,CAAC,wBAAwB,KAAK,IAAI;IAAE,IAAA,yDAA0B,GAAE,CAAC;AAE9D,QAAA,GAAG,GAAG,IAAI,kBAAO,CAAC;IAC7B,WAAW,EAAE,4BAAY,CAAC,WAAW;IACrC,mBAAmB,EAAE,IAAI;IACzB,QAAQ,EAAE,IAAA,kCAAsB,EAAC;QAC/B,CAAC,wCAAiB,CAAC,EAAE,4BAAY,CAAC,WAAW;QAC7C,CAAC,2CAAoB,CAAC,EAAE,4BAAY,CAAC,cAAc;KACpD,CAAC;IACF,cAAc,EAAE;QACd,IAAI,mCAAkB,CAAC,IAAI,4CAAiB,EAAE,CAAC;QAC/C,wDAAwD;QACxD,IAAI,6CAAoB,CAAC,+CAAsB,CAAC;KACjD;IACD,gBAAgB,EAAE,CAAC,IAAA,wDAA2B,EAAC;YAC7C,qCAAqC,EAAE;gBACrC,YAAY,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;oBAC/B,IAAI,WAAW,IAAI,QAAQ;wBAAE,QAAQ,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,CAAC;gBAC7F,CAAC;aACF;SACF,CAAC,CAAC;CACJ,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@codefresh-io/cf-telemetry",
3
- "version": "2.3.0",
3
+ "version": "3.0.0",
4
4
  "exports": {
5
5
  "./init": {
6
6
  "import": "./dist/init.mjs",