@interopio/otel 0.0.70 → 0.0.72

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.
@@ -28,16 +28,25 @@ export interface LogsSettings {
28
28
  maxAttributeDepth?: number;
29
29
  filters?: LogFilter[];
30
30
  defaults?: LogOptions;
31
+ /**
32
+ * Additional headers to send in HTTP requests, e.g. when using HTTP exporters.
33
+ */
31
34
  headers?: {
32
35
  [x: string]: string;
33
36
  } | (() => {
34
37
  [x: string]: string;
35
38
  });
39
+ /**
40
+ * Additional attributes to add to observability entities (metrics, spans, log entries) by default.
41
+ */
36
42
  additionalAttributes?: {
37
43
  [x: string]: unknown;
38
44
  } | (() => {
39
45
  [x: string]: unknown;
40
46
  });
47
+ /**
48
+ * Additional attributes to add to the observability resource definition.
49
+ */
41
50
  additionalResourceAttributes?: {
42
51
  [x: string]: unknown;
43
52
  } | (() => {
@@ -16,16 +16,25 @@ export interface MetricsSettings {
16
16
  /** Maximum time the OTLP exporter will wait for each batch export.
17
17
  * The default value is 10000ms. */
18
18
  timeoutMillis?: number;
19
+ /**
20
+ * Additional headers to send in HTTP requests, e.g. when using HTTP exporters.
21
+ */
19
22
  headers?: {
20
23
  [x: string]: string;
21
24
  } | (() => {
22
25
  [x: string]: string;
23
26
  });
27
+ /**
28
+ * Additional attributes to add to observability entities (metrics, spans, log entries) by default.
29
+ */
24
30
  additionalAttributes?: {
25
31
  [x: string]: unknown;
26
32
  } | (() => {
27
33
  [x: string]: unknown;
28
34
  });
35
+ /**
36
+ * Additional attributes to add to the observability resource definition.
37
+ */
29
38
  additionalResourceAttributes?: {
30
39
  [x: string]: unknown;
31
40
  } | (() => {
@@ -308,6 +308,14 @@ export interface TracesSettings {
308
308
  * have an OTLPTraceExporter using this destination URL.
309
309
  */
310
310
  url?: string;
311
+ /**
312
+ * Whether the clickstream trace will be enabled.
313
+ */
314
+ clickstream?: boolean;
315
+ /**
316
+ * Whether the user journey trace will be enabled.
317
+ */
318
+ userJourney?: boolean;
311
319
  /**
312
320
  * If an OTEL TraceProvider isn't provided to the library,
313
321
  * it will initialize its own.
@@ -327,16 +335,25 @@ export interface TracesSettings {
327
335
  * have a ConsoleTraceExporter.
328
336
  */
329
337
  console?: boolean;
338
+ /**
339
+ * Additional headers to send in HTTP requests, e.g. when using HTTP exporters.
340
+ */
330
341
  headers?: {
331
342
  [x: string]: string;
332
343
  } | (() => {
333
344
  [x: string]: string;
334
345
  });
346
+ /**
347
+ * Additional attributes to add to observability entities (metrics, spans, log entries) by default.
348
+ */
335
349
  additionalAttributes?: {
336
350
  [x: string]: unknown;
337
351
  } | (() => {
338
352
  [x: string]: unknown;
339
353
  });
354
+ /**
355
+ * Additional attributes to add to the observability resource definition.
356
+ */
340
357
  additionalResourceAttributes?: {
341
358
  [x: string]: unknown;
342
359
  } | (() => {
package/dist/types.d.ts CHANGED
@@ -20,6 +20,11 @@ export interface Settings {
20
20
  * If disabled, API is still usable, but methods are no-ops.
21
21
  */
22
22
  enabled: boolean;
23
+ /**
24
+ * If the library should log the settings used to initialize it.
25
+ *
26
+ * @default true
27
+ */
23
28
  logSettingsOnStartup?: boolean;
24
29
  /**
25
30
  * If failure to initialize library will throw upstream error.
@@ -55,16 +60,25 @@ export interface Settings {
55
60
  * a different setting.
56
61
  */
57
62
  userId?: string;
63
+ /**
64
+ * Additional headers to send in HTTP requests, e.g. when using HTTP exporters.
65
+ */
58
66
  headers?: {
59
67
  [x: string]: string;
60
68
  } | (() => {
61
69
  [x: string]: string;
62
70
  });
71
+ /**
72
+ * Additional attributes to add to observability entities (metrics, spans, log entries) by default.
73
+ */
63
74
  additionalAttributes?: {
64
75
  [x: string]: unknown;
65
76
  } | (() => {
66
77
  [x: string]: unknown;
67
78
  });
79
+ /**
80
+ * Additional attributes to add to the observability resource definition.
81
+ */
68
82
  additionalResourceAttributes?: {
69
83
  [x: string]: unknown;
70
84
  } | (() => {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@interopio/otel",
3
- "version": "0.0.70",
3
+ "version": "0.0.72",
4
4
  "description": "otel library",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",