@xylabs/telemetry-exporter 4.13.20 → 4.13.21

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.
Files changed (2) hide show
  1. package/README.md +175 -3
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -12,13 +12,185 @@
12
12
  [![snyk-badge][]][snyk-link]
13
13
  [![socket-badge][]][socket-link]
14
14
 
15
- Version: 4.13.19
16
15
 
17
16
  Base functionality used throughout XY Labs TypeScript/JavaScript libraries
18
17
 
19
- ## Documentation
18
+ ## API Documentation
19
+
20
+ **@xylabs/telemetry-exporter**
21
+
22
+ ***
23
+
24
+ ## Classes
25
+
26
+ - [XyConsoleSpanExporter](#classes/XyConsoleSpanExporter)
27
+
28
+ ## Functions
29
+
30
+ - [spanDurationInMillis](#functions/spanDurationInMillis)
31
+
32
+ ### classes
33
+
34
+ ### <a id="XyConsoleSpanExporter"></a>XyConsoleSpanExporter
35
+
36
+ [**@xylabs/telemetry-exporter**](#../README)
37
+
38
+ ***
39
+
40
+ ## Extends
41
+
42
+ - `ConsoleSpanExporter`
43
+
44
+ ## Constructors
45
+
46
+ ### Constructor
47
+
48
+ ```ts
49
+ new XyConsoleSpanExporter(logLevel, logger): XyConsoleSpanExporter;
50
+ ```
51
+
52
+ ### Parameters
53
+
54
+ #### logLevel
55
+
56
+ `number` = `0`
57
+
58
+ #### logger
59
+
60
+ `Logger` = `console`
61
+
62
+ ### Returns
63
+
64
+ `XyConsoleSpanExporter`
65
+
66
+ ### Overrides
67
+
68
+ ```ts
69
+ ConsoleSpanExporter.constructor
70
+ ```
71
+
72
+ ## Properties
73
+
74
+ ### durationToLogLevel
75
+
76
+ ```ts
77
+ readonly static durationToLogLevel: number[];
78
+ ```
79
+
80
+ ***
81
+
82
+ ### logLevelToChalkColor
83
+
84
+ ```ts
85
+ readonly static logLevelToChalkColor: ChalkInstance[];
86
+ ```
87
+
88
+ ***
89
+
90
+ ### logger
91
+
92
+ ```ts
93
+ logger: Logger;
94
+ ```
95
+
96
+ ## Accessors
97
+
98
+ ### logLevel
99
+
100
+ ### Get Signature
101
+
102
+ ```ts
103
+ get logLevel(): number;
104
+ ```
105
+
106
+ #### Returns
107
+
108
+ `number`
109
+
110
+ ## Methods
111
+
112
+ ### export()
113
+
114
+ ```ts
115
+ export(spans): void;
116
+ ```
117
+
118
+ Export spans.
119
+
120
+ ### Parameters
121
+
122
+ #### spans
123
+
124
+ `ReadableSpan`[]
125
+
126
+ ### Returns
127
+
128
+ `void`
129
+
130
+ ### Overrides
131
+
132
+ ```ts
133
+ ConsoleSpanExporter.export
134
+ ```
135
+
136
+ ***
137
+
138
+ ### logColor()
139
+
140
+ ```ts
141
+ logColor(level): ChalkInstance;
142
+ ```
143
+
144
+ ### Parameters
145
+
146
+ #### level
147
+
148
+ `number`
149
+
150
+ ### Returns
151
+
152
+ `ChalkInstance`
153
+
154
+ ***
155
+
156
+ ### spanLevel()
157
+
158
+ ```ts
159
+ spanLevel(span): number;
160
+ ```
161
+
162
+ ### Parameters
163
+
164
+ #### span
165
+
166
+ `ReadableSpan`
167
+
168
+ ### Returns
169
+
170
+ `number`
171
+
172
+ ### functions
173
+
174
+ ### <a id="spanDurationInMillis"></a>spanDurationInMillis
175
+
176
+ [**@xylabs/telemetry-exporter**](#../README)
177
+
178
+ ***
179
+
180
+ ```ts
181
+ function spanDurationInMillis(span): number;
182
+ ```
183
+
184
+ ## Parameters
185
+
186
+ ### span
187
+
188
+ `ReadableSpan`
189
+
190
+ ## Returns
191
+
192
+ `number`
20
193
 
21
- Coming Soon!
22
194
 
23
195
  Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
24
196
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/telemetry-exporter",
3
- "version": "4.13.20",
3
+ "version": "4.13.21",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "hex",
@@ -43,7 +43,7 @@
43
43
  ],
44
44
  "dependencies": {
45
45
  "@opentelemetry/sdk-trace-base": "^2.0.1",
46
- "@xylabs/logger": "^4.13.20",
46
+ "@xylabs/logger": "^4.13.21",
47
47
  "chalk": "^5.4.1"
48
48
  },
49
49
  "devDependencies": {