@redocly/client-generator 0.9.3 → 0.10.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.
Files changed (82) hide show
  1. package/eject-assets/generators/cli/docs.ts +1 -1
  2. package/eject-assets/generators/cli/engine-source.ts +1 -1
  3. package/eject-assets/generators/cli/index.ts +2 -2
  4. package/eject-assets/generators/cli/render.ts +1 -1
  5. package/eject-assets/generators/go/client.ts +1 -1
  6. package/eject-assets/generators/go/descriptor.ts +1 -1
  7. package/eject-assets/generators/go/index.ts +2 -2
  8. package/eject-assets/generators/go/models.ts +1 -1
  9. package/eject-assets/generators/go/naming.ts +1 -1
  10. package/eject-assets/generators/go/operations.ts +1 -1
  11. package/eject-assets/generators/go/pagination.ts +1 -1
  12. package/eject-assets/generators/go/types.ts +1 -1
  13. package/eject-assets/generators/java/client.ts +1 -1
  14. package/eject-assets/generators/java/descriptor.ts +1 -1
  15. package/eject-assets/generators/java/index.ts +2 -2
  16. package/eject-assets/generators/java/models.ts +1 -1
  17. package/eject-assets/generators/java/naming.ts +1 -1
  18. package/eject-assets/generators/java/operations.ts +1 -1
  19. package/eject-assets/generators/java/pagination.ts +1 -1
  20. package/eject-assets/generators/java/types.ts +1 -1
  21. package/eject-assets/generators/mock/faker.ts +1 -1
  22. package/eject-assets/generators/mock/index.ts +2 -2
  23. package/eject-assets/generators/mock/render.ts +1 -1
  24. package/eject-assets/generators/mock/sample.ts +1 -1
  25. package/eject-assets/generators/mock/values.ts +1 -1
  26. package/eject-assets/generators/php/client.ts +1 -1
  27. package/eject-assets/generators/php/descriptor.ts +1 -1
  28. package/eject-assets/generators/php/index.ts +2 -2
  29. package/eject-assets/generators/php/models.ts +1 -1
  30. package/eject-assets/generators/php/naming.ts +1 -1
  31. package/eject-assets/generators/php/operations.ts +1 -1
  32. package/eject-assets/generators/php/pagination.ts +1 -1
  33. package/eject-assets/generators/php/types.ts +1 -1
  34. package/eject-assets/generators/python/client.ts +1 -1
  35. package/eject-assets/generators/python/descriptor.ts +1 -1
  36. package/eject-assets/generators/python/index.ts +2 -2
  37. package/eject-assets/generators/python/models.ts +1 -1
  38. package/eject-assets/generators/python/naming.ts +1 -1
  39. package/eject-assets/generators/python/operations.ts +1 -1
  40. package/eject-assets/generators/python/pagination.ts +1 -1
  41. package/eject-assets/generators/python/types.ts +1 -1
  42. package/eject-assets/generators/swr/index.ts +2 -2
  43. package/eject-assets/generators/swr/render.ts +1 -1
  44. package/eject-assets/generators/tanstack-query/index.ts +2 -2
  45. package/eject-assets/generators/tanstack-query/render.ts +1 -1
  46. package/eject-assets/generators/transformers/index.ts +2 -2
  47. package/eject-assets/generators/transformers/render.ts +1 -1
  48. package/eject-assets/generators/typescript/banner.ts +1 -1
  49. package/eject-assets/generators/typescript/client.ts +1 -1
  50. package/eject-assets/generators/typescript/descriptor.ts +1 -1
  51. package/eject-assets/generators/typescript/index.ts +2 -2
  52. package/eject-assets/generators/typescript/inline-runtime.ts +1 -1
  53. package/eject-assets/generators/typescript/operation-signature.ts +1 -1
  54. package/eject-assets/generators/typescript/operation-types.ts +1 -1
  55. package/eject-assets/generators/typescript/operations.ts +1 -1
  56. package/eject-assets/generators/typescript/response-headers.ts +1 -1
  57. package/eject-assets/generators/typescript/type-guards.ts +1 -1
  58. package/eject-assets/generators/typescript/types.ts +1 -1
  59. package/eject-assets/generators/zod/index.ts +2 -2
  60. package/eject-assets/generators/zod/schemas.ts +1 -1
  61. package/eject-assets/skills/typescript-generator/SKILL.md +2 -1
  62. package/lib/generators/typescript/telemetry/telemetry.d.ts +4 -12
  63. package/lib/generators/typescript/telemetry/telemetry.d.ts.map +1 -1
  64. package/lib/generators/typescript/telemetry/telemetry.js +53 -21
  65. package/lib/generators/typescript/telemetry/telemetry.js.map +1 -1
  66. package/lib/runtime-sources/go-telemetry.d.ts +1 -1
  67. package/lib/runtime-sources/go-telemetry.d.ts.map +1 -1
  68. package/lib/runtime-sources/go-telemetry.js +1 -1
  69. package/lib/runtime-sources/go-telemetry.js.map +1 -1
  70. package/lib/runtime-sources/php-telemetry.d.ts +1 -1
  71. package/lib/runtime-sources/php-telemetry.d.ts.map +1 -1
  72. package/lib/runtime-sources/php-telemetry.js +1 -1
  73. package/lib/runtime-sources/php-telemetry.js.map +1 -1
  74. package/lib/runtime-sources/python-telemetry.d.ts +1 -1
  75. package/lib/runtime-sources/python-telemetry.d.ts.map +1 -1
  76. package/lib/runtime-sources/python-telemetry.js +1 -1
  77. package/lib/runtime-sources/python-telemetry.js.map +1 -1
  78. package/lib/runtime-sources/telemetry.d.ts +1 -1
  79. package/lib/runtime-sources/telemetry.d.ts.map +1 -1
  80. package/lib/runtime-sources/telemetry.js +1 -1
  81. package/lib/runtime-sources/telemetry.js.map +1 -1
  82. package/package.json +3 -2
@@ -3,6 +3,7 @@ const DEFAULT_ENDPOINT = 'https://otel.cloud.redocly.com/v1/traces';
3
3
  const EVENT_TYPE = 'com.redocly.sdkUsage.aggregated';
4
4
  const SEND_TIMEOUT_MS = 3000;
5
5
  const SERVICE_NAME = 'redocly-sdk';
6
+ const CROCKFORD_BASE32 = '0123456789abcdefghjkmnpqrstvwxyz';
6
7
  const STATUS_CLASSES = [
7
8
  '2xx',
8
9
  '3xx',
@@ -66,7 +67,9 @@ export function telemetry(options) {
66
67
  runtimeVersion = versions.deno;
67
68
  }
68
69
  const sdk = {
69
- name: options.sdkName,
70
+ id: options.sdkName,
71
+ object: 'sdk',
72
+ uri: `urn:redocly:cli:sdk:typescript:${options.sdkName}`,
70
73
  version: options.sdkVersion,
71
74
  generator_version: GENERATOR_VERSION,
72
75
  language: 'typescript',
@@ -90,7 +93,7 @@ export function telemetry(options) {
90
93
  clearTimeout(timer);
91
94
  timer = undefined;
92
95
  activeWindows.delete(flushWindow);
93
- const events = toEvents(counts, windowStart, Date.now() - windowStart, options.sdkName, sdk);
96
+ const events = toEvents(counts, windowStart, Date.now() - windowStart, sdk);
94
97
  const sentCounts = counts;
95
98
  const sentWindowStart = windowStart;
96
99
  counts = new Map();
@@ -199,11 +202,13 @@ function statusClass(call) {
199
202
  return '3xx';
200
203
  return '2xx';
201
204
  }
202
- function toEvents(counts, windowStart, windowMs, source, sdk) {
205
+ function toEvents(counts, windowStart, windowMs, sdk) {
203
206
  const events = [];
204
207
  for (const [operationId, operation] of counts) {
205
- const usage = {
206
- operation_id: operationId,
208
+ const operationItem = {
209
+ id: operationId,
210
+ object: 'operation',
211
+ uri: `${sdk.uri}:operation:${operationId}`,
207
212
  window_ms: windowMs,
208
213
  calls: operation.calls,
209
214
  attempts: operation.attempts,
@@ -212,25 +217,44 @@ function toEvents(counts, windowStart, windowMs, source, sdk) {
212
217
  for (const statusClass of STATUS_CLASSES) {
213
218
  const count = operation.status[statusClass];
214
219
  if (count > 0) {
215
- usage[`status_${statusClass}`] = count;
220
+ operationItem[`status_${statusClass}`] = count;
216
221
  }
217
222
  }
218
223
  for (const { bucket } of LATENCY_BUCKETS) {
219
224
  const count = operation.latency[bucket];
220
225
  if (count > 0) {
221
- usage[`latency_${bucket}`] = count;
226
+ operationItem[`latency_${bucket}`] = count;
222
227
  }
223
228
  }
224
229
  events.push({
225
- id: `evt_${randomHex(16)}`,
230
+ id: eventId(),
231
+ object: 'event',
232
+ specversion: '1.0',
233
+ datacontenttype: 'application/json; charset=utf-8',
226
234
  type: EVENT_TYPE,
227
- source,
235
+ source: 'urn:redocly:cli',
228
236
  time: new Date(windowStart).toISOString(),
229
- data: { usage, sdk },
237
+ origin: 'redocly-sdk',
238
+ category: 'product',
239
+ signal: 'metric',
240
+ data: [operationItem, sdk],
230
241
  });
231
242
  }
232
243
  return events;
233
244
  }
245
+ /** `evt_` and a lowercase ULID: 10 characters of the time in milliseconds, then 16 random ones. */
246
+ function eventId() {
247
+ let time = Date.now();
248
+ let id = '';
249
+ for (let index = 0; index < 10; index++) {
250
+ id = CROCKFORD_BASE32[time % 32] + id;
251
+ time = Math.floor(time / 32);
252
+ }
253
+ for (const byte of crypto.getRandomValues(new Uint8Array(16))) {
254
+ id += CROCKFORD_BASE32[byte % 32];
255
+ }
256
+ return `evt_${id}`;
257
+ }
234
258
  async function sendOtlp(endpoint, events) {
235
259
  const response = await fetch(endpoint, {
236
260
  method: 'POST',
@@ -268,24 +292,32 @@ function toOtlpRequest(events) {
268
292
  const spans = [];
269
293
  for (const event of events) {
270
294
  const timeUnixNano = `${Date.parse(event.time)}000000`;
295
+ // The attributes that `processCloudEventAttributes` of @redocly/cli-otel gives for the event.
271
296
  const attributes = [
272
297
  attribute('cloudevents.event_id', event.id),
273
298
  attribute('cloudevents.event_type', event.type),
274
299
  attribute('cloudevents.event_source', event.source),
275
- attribute('cloudevents.event_spec_version', '1.0'),
276
- attribute('cloudevents.event_data_content_type', 'application/json; charset=utf-8'),
300
+ attribute('cloudevents.event_spec_version', event.specversion),
301
+ attribute('cloudevents.event_data_content_type', event.datacontenttype),
277
302
  attribute('cloudevents.event_time', event.time),
278
- attribute('cloudevents.event_subject', ''),
279
- attribute('cloudevents.event_origin', SERVICE_NAME),
280
- attribute('cloudevents.event_object', 'event'),
281
- attribute('cloudevents.event_category', 'product'),
282
- attribute('cloudevents.event_signal', 'metric'),
303
+ attribute('cloudevents.event_subject', event.data[0].id),
304
+ attribute('cloudevents.event_origin', event.origin),
305
+ attribute('cloudevents.event_object', event.object),
306
+ attribute('cloudevents.event_category', event.category),
307
+ attribute('cloudevents.event_signal', event.signal),
308
+ attribute('cloudevents.event_request_id', ''),
283
309
  ];
284
- for (const [key, value] of Object.entries(event.data.usage)) {
285
- attributes.push(attribute(`cloudevents.event_data.usage.${key}`, value));
310
+ for (const item of event.data) {
311
+ for (const [key, value] of Object.entries(item)) {
312
+ if (value !== undefined) {
313
+ attributes.push(attribute(`cloudevents.event_data.${item.object}.${key}`, value));
314
+ }
315
+ }
286
316
  }
287
- for (const [key, value] of Object.entries(event.data.sdk)) {
288
- attributes.push(attribute(`cloudevents.event_data.sdk.${key}`, value));
317
+ for (const item of event.data) {
318
+ attributes.push(attribute(`cloudevents.event_subjects.${item.object}.id`, item.id));
319
+ attributes.push(attribute(`cloudevents.event_subjects.${item.object}.object`, item.object));
320
+ attributes.push(attribute(`cloudevents.event_subjects.${item.object}.uri`, item.uri));
289
321
  }
290
322
  spans.push({
291
323
  traceId: randomHex(16),
@@ -1 +1 @@
1
- {"version":3,"file":"telemetry.js","sourceRoot":"","sources":["../../../../src/generators/typescript/telemetry/telemetry.ts"],"names":[],"mappings":"AAEA,MAAM,iBAAiB,GAAW,KAAK,CAAC;AACxC,MAAM,gBAAgB,GAAG,0CAA0C,CAAC;AACpE,MAAM,UAAU,GAAG,iCAAiC,CAAC;AACrD,MAAM,eAAe,GAAG,IAAI,CAAC;AAC7B,MAAM,YAAY,GAAG,aAAa,CAAC;AAKnC,MAAM,cAAc,GAAkB;IACpC,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,eAAe;IACf,SAAS;IACT,SAAS;CACV,CAAC;AACF,MAAM,eAAe,GAAsD;IACzE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE;IACpC,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE;IACpC,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE;IAClC,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE;IAClC,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE;IACpC,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE;CACzC,CAAC;AAsCF,MAAM,aAAa,GAAG,IAAI,GAAG,EAAiD,CAAC;AAC/E,MAAM,YAAY,GAAG,IAAI,GAAG,EAAiB,CAAC;AAC9C,IAAI,iBAAiB,GAAG,KAAK,CAAC;AAE9B,SAAS,WAAW;IAClB,OAAQ,UAAwC,CAAC,OAAO,CAAC;AAC3D,CAAC;AAED,SAAS,iBAAiB;IACxB,MAAM,cAAc,GAAG,WAAW,EAAE,CAAC;IACrC,IAAI,cAAc,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAC9C,2EAA2E;IAC3E,IAAI,OAAO,QAAQ,KAAK,WAAW;QAAE,OAAO,IAAI,CAAC;IACjD,MAAM,GAAG,GAAG,cAAc,CAAC,GAAG,IAAI,EAAE,CAAC;IACrC,IAAI,GAAG,CAAC,qBAAqB,KAAK,KAAK;QAAE,OAAO,IAAI,CAAC;IACrD,IAAI,GAAG,CAAC,YAAY,KAAK,GAAG;QAAE,OAAO,IAAI,CAAC;IAC1C,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,KAAK;IACnB,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC;AAC9B,CAAC;AAED,KAAK,UAAU,YAAY,CAAC,YAA0B;IACpD,KAAK,MAAM,WAAW,IAAI,aAAa;QAAE,KAAK,WAAW,CAAC,YAAY,CAAC,CAAC;IACxE,MAAM,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AAClC,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,OAAyB;IACjD,IAAI,iBAAiB,EAAE;QAAE,OAAO,EAAE,CAAC;IACnC,MAAM,UAAU,GAAG,OAAO,CAAC,eAAe,IAAI,MAAM,CAAC;IACrD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,gBAAgB,CAAC;IACtD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,MAAuB,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;IACvF,MAAM,QAAQ,GAAG,WAAW,EAAE,EAAE,QAAQ,IAAI,EAAE,CAAC;IAC/C,IAAI,OAAO,GAAG,MAAM,CAAC;IACrB,IAAI,cAAc,GAAG,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC;IACzC,IAAI,QAAQ,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,GAAG,KAAK,CAAC;QAChB,cAAc,GAAG,QAAQ,CAAC,GAAG,CAAC;IAChC,CAAC;SAAM,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QACvC,OAAO,GAAG,MAAM,CAAC;QACjB,cAAc,GAAG,QAAQ,CAAC,IAAI,CAAC;IACjC,CAAC;IACD,MAAM,GAAG,GAA2B;QAClC,IAAI,EAAE,OAAO,CAAC,OAAO;QACrB,OAAO,EAAE,OAAO,CAAC,UAAU;QAC3B,iBAAiB,EAAE,iBAAiB;QACpC,QAAQ,EAAE,YAAY;QACtB,OAAO;QACP,eAAe,EAAE,cAAc;QAC/B,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC;IACF,IAAI,MAAM,GAAG,IAAI,GAAG,EAA2B,CAAC;IAChD,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,IAAI,KAAgD,CAAC;IAErD,SAAS,UAAU;QACjB,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,KAAK,WAAW,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC;QAC/D,UAAU,CAAC,KAAK,CAAC,CAAC;QAClB,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACjC,CAAC;IAED,KAAK,UAAU,WAAW,CAAC,YAA0B;QACnD,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC;YAAE,OAAO;QAC9B,IAAI,KAAK,KAAK,SAAS;YAAE,YAAY,CAAC,KAAK,CAAC,CAAC;QAC7C,KAAK,GAAG,SAAS,CAAC;QAClB,aAAa,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAC7F,MAAM,UAAU,GAAG,MAAM,CAAC;QAC1B,MAAM,eAAe,GAAG,WAAW,CAAC;QACpC,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACnB,IAAI,iBAAiB,EAAE;YAAE,OAAO;QAChC,IAAI,MAAgC,CAAC;QACrC,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE;aAC3B,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aACxB,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;YACxB,MAAM,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QACL,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACvB,MAAM,IAAI,CAAC;QACX,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1B,IAAI,MAAM,KAAK,MAAM,IAAI,YAAY,KAAK,MAAM;YAAE,OAAO;QAEzD,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC;YAAE,UAAU,EAAE,CAAC;QACpC,IAAI,eAAe,GAAG,WAAW;YAAE,WAAW,GAAG,eAAe,CAAC;QACjE,KAAK,MAAM,CAAC,WAAW,EAAE,aAAa,CAAC,IAAI,UAAU,EAAE,CAAC;YACtD,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAC1C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;YACzC,CAAC;iBAAM,CAAC;gBACN,SAAS,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;IACH,CAAC;IAED,eAAe,EAAE,CAAC;IAElB,OAAO;QACL,SAAS,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACvB,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC;gBAAE,UAAU,EAAE,CAAC;YACpC,IAAI,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YAC7C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,SAAS,GAAG,WAAW,EAAE,CAAC;gBAC1B,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;YAC1C,CAAC;YACD,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC1B,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,eAAe;IACtB,IAAI,iBAAiB;QAAE,OAAO;IAC9B,iBAAiB,GAAG,IAAI,CAAC;IACzB,yDAAyD;IACzD,0FAA0F;IAC1F,WAAW,EAAE,EAAE,EAAE,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE,CAAC,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;AACrE,CAAC;AAED,SAAS,UAAU,CAAC,KAAc;IAChC,IAAI,KAAK,YAAY,MAAM,IAAI,OAAO,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;QACrF,KAAK,CAAC,KAAK,EAAE,CAAC;IAChB,CAAC;AACH,CAAC;AAED,SAAS,WAAW;IAClB,OAAO;QACL,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,CAAC;QACX,aAAa,EAAE,CAAC;QAChB,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,aAAa,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;QAC5F,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;KACjF,CAAC;AACJ,CAAC;AAED,SAAS,MAAM,CAAC,SAA0B,EAAE,IAAiB;IAC3D,SAAS,CAAC,KAAK,IAAI,CAAC,CAAC;IACrB,6FAA6F;IAC7F,+EAA+E;IAC/E,SAAS,CAAC,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACjD,SAAS,CAAC,aAAa,IAAI,IAAI,CAAC,UAAU,CAAC;IAC3C,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;IACzC,KAAK,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,eAAe,EAAE,CAAC;QAClD,IAAI,IAAI,CAAC,UAAU,GAAG,OAAO,EAAE,CAAC;YAC9B,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC/B,MAAM;QACR,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,MAAuB,EAAE,MAAuB;IACjE,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC;IACnC,MAAM,CAAC,aAAa,IAAI,MAAM,CAAC,aAAa,CAAC;IAC7C,KAAK,MAAM,WAAW,IAAI,cAAc,EAAE,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IACD,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAAC,IAAiB;IACpC,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAChC,IAAI,IAAI,CAAC,KAAK,YAAY,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,cAAc;YAAE,OAAO,SAAS,CAAC;QACxF,IAAI,IAAI,CAAC,KAAK,YAAY,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY;YAAE,OAAO,SAAS,CAAC;QACtF,OAAO,eAAe,CAAC;IACzB,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IACpC,IAAI,MAAM,IAAI,GAAG;QAAE,OAAO,KAAK,CAAC;IAChC,IAAI,MAAM,IAAI,GAAG;QAAE,OAAO,KAAK,CAAC;IAChC,IAAI,MAAM,IAAI,GAAG;QAAE,OAAO,KAAK,CAAC;IAChC,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,QAAQ,CACf,MAAoC,EACpC,WAAmB,EACnB,QAAgB,EAChB,MAAc,EACd,GAA2B;IAE3B,MAAM,MAAM,GAAoB,EAAE,CAAC;IACnC,KAAK,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,IAAI,MAAM,EAAE,CAAC;QAC9C,MAAM,KAAK,GAAoC;YAC7C,YAAY,EAAE,WAAW;YACzB,SAAS,EAAE,QAAQ;YACnB,KAAK,EAAE,SAAS,CAAC,KAAK;YACtB,QAAQ,EAAE,SAAS,CAAC,QAAQ;YAC5B,eAAe,EAAE,SAAS,CAAC,aAAa;SACzC,CAAC;QACF,KAAK,MAAM,WAAW,IAAI,cAAc,EAAE,CAAC;YACzC,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAC5C,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACd,KAAK,CAAC,UAAU,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC;YACzC,CAAC;QACH,CAAC;QACD,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,eAAe,EAAE,CAAC;YACzC,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACxC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACd,KAAK,CAAC,WAAW,MAAM,EAAE,CAAC,GAAG,KAAK,CAAC;YACrC,CAAC;QACH,CAAC;QACD,MAAM,CAAC,IAAI,CAAC;YACV,EAAE,EAAE,OAAO,SAAS,CAAC,EAAE,CAAC,EAAE;YAC1B,IAAI,EAAE,UAAU;YAChB,MAAM;YACN,IAAI,EAAE,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE;YACzC,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACrB,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,QAAgB,EAAE,MAAuB;IAC/D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,EAAE;QACrC,MAAM,EAAE,MAAM;QACd,2FAA2F;QAC3F,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,UAAU,EAAE,OAAO,EAAE;QACpE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC3C,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,eAAe,CAAC;KAC7C,CAAC,CAAC;IACH,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9B,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;AACH,CAAC;AAED,MAAM,iBAAkB,SAAQ,KAAK;IACnB,MAAM,CAAS;IAC/B,YAAY,MAAc;QACxB,KAAK,CAAC,mCAAmC,MAAM,GAAG,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED,SAAS,mBAAmB,CAAC,KAAc;IACzC,oEAAoE;IACpE,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc;QAAE,OAAO,MAAM,CAAC;IAC3E,IAAI,KAAK,YAAY,iBAAiB,EAAE,CAAC;QACvC,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG;YAAE,OAAO,MAAM,CAAC;QACvF,8CAA8C;QAC9C,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAKD,SAAS,aAAa,CAAC,MAAuB;IAC5C,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,YAAY,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;QACvD,MAAM,UAAU,GAAoB;YAClC,SAAS,CAAC,sBAAsB,EAAE,KAAK,CAAC,EAAE,CAAC;YAC3C,SAAS,CAAC,wBAAwB,EAAE,KAAK,CAAC,IAAI,CAAC;YAC/C,SAAS,CAAC,0BAA0B,EAAE,KAAK,CAAC,MAAM,CAAC;YACnD,SAAS,CAAC,gCAAgC,EAAE,KAAK,CAAC;YAClD,SAAS,CAAC,qCAAqC,EAAE,iCAAiC,CAAC;YACnF,SAAS,CAAC,wBAAwB,EAAE,KAAK,CAAC,IAAI,CAAC;YAC/C,SAAS,CAAC,2BAA2B,EAAE,EAAE,CAAC;YAC1C,SAAS,CAAC,0BAA0B,EAAE,YAAY,CAAC;YACnD,SAAS,CAAC,0BAA0B,EAAE,OAAO,CAAC;YAC9C,SAAS,CAAC,4BAA4B,EAAE,SAAS,CAAC;YAClD,SAAS,CAAC,0BAA0B,EAAE,QAAQ,CAAC;SAChD,CAAC;QACF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5D,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,gCAAgC,GAAG,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QAC3E,CAAC;QACD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1D,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,8BAA8B,GAAG,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QACzE,CAAC;QACD,KAAK,CAAC,IAAI,CAAC;YACT,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;YACtB,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;YACpB,IAAI,EAAE,SAAS,KAAK,CAAC,IAAI,EAAE;YAC3B,IAAI,EAAE,CAAC;YACP,iBAAiB,EAAE,YAAY;YAC/B,eAAe,EAAE,YAAY;YAC7B,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IACD,OAAO;QACL,aAAa,EAAE;YACb;gBACE,QAAQ,EAAE;oBACR,UAAU,EAAE;wBACV,SAAS,CAAC,cAAc,EAAE,YAAY,CAAC;wBACvC,SAAS,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;qBAChD;iBACF;gBACD,UAAU,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,uBAAuB,EAAE,EAAE,KAAK,EAAE,CAAC;aAClE;SACF;KACF,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,GAAW,EAAE,KAAsB;IACpD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,CAAC;IAC7E,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC;IACxE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,CAAC;AAChD,CAAC;AAED,SAAS,SAAS,CAAC,SAAiB;IAClC,MAAM,KAAK,GAAG,MAAM,CAAC,eAAe,CAAC,IAAI,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IAChE,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,KAAK,MAAM,IAAI,IAAI,KAAK;QAAE,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACpE,OAAO,GAAG,CAAC;AACb,CAAC"}
1
+ {"version":3,"file":"telemetry.js","sourceRoot":"","sources":["../../../../src/generators/typescript/telemetry/telemetry.ts"],"names":[],"mappings":"AAIA,MAAM,iBAAiB,GAAW,KAAK,CAAC;AACxC,MAAM,gBAAgB,GAAG,0CAA0C,CAAC;AACpE,MAAM,UAAU,GAAG,iCAAiC,CAAC;AACrD,MAAM,eAAe,GAAG,IAAI,CAAC;AAC7B,MAAM,YAAY,GAAG,aAAa,CAAC;AACnC,MAAM,gBAAgB,GAAG,kCAAkC,CAAC;AAK5D,MAAM,cAAc,GAAkB;IACpC,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,eAAe;IACf,SAAS;IACT,SAAS;CACV,CAAC;AACF,MAAM,eAAe,GAAsD;IACzE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE;IACpC,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE;IACpC,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE;IAClC,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE;IAClC,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE;IACpC,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE;CACzC,CAAC;AAuCF,MAAM,aAAa,GAAG,IAAI,GAAG,EAAiD,CAAC;AAC/E,MAAM,YAAY,GAAG,IAAI,GAAG,EAAiB,CAAC;AAC9C,IAAI,iBAAiB,GAAG,KAAK,CAAC;AAE9B,SAAS,WAAW;IAClB,OAAQ,UAAwC,CAAC,OAAO,CAAC;AAC3D,CAAC;AAED,SAAS,iBAAiB;IACxB,MAAM,cAAc,GAAG,WAAW,EAAE,CAAC;IACrC,IAAI,cAAc,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAC9C,2EAA2E;IAC3E,IAAI,OAAO,QAAQ,KAAK,WAAW;QAAE,OAAO,IAAI,CAAC;IACjD,MAAM,GAAG,GAAG,cAAc,CAAC,GAAG,IAAI,EAAE,CAAC;IACrC,IAAI,GAAG,CAAC,qBAAqB,KAAK,KAAK;QAAE,OAAO,IAAI,CAAC;IACrD,IAAI,GAAG,CAAC,YAAY,KAAK,GAAG;QAAE,OAAO,IAAI,CAAC;IAC1C,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,KAAK;IACnB,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC;AAC9B,CAAC;AAED,KAAK,UAAU,YAAY,CAAC,YAA0B;IACpD,KAAK,MAAM,WAAW,IAAI,aAAa;QAAE,KAAK,WAAW,CAAC,YAAY,CAAC,CAAC;IACxE,MAAM,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AAClC,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,OAAyB;IACjD,IAAI,iBAAiB,EAAE;QAAE,OAAO,EAAE,CAAC;IACnC,MAAM,UAAU,GAAG,OAAO,CAAC,eAAe,IAAI,MAAM,CAAC;IACrD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,gBAAgB,CAAC;IACtD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,MAAuB,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;IACvF,MAAM,QAAQ,GAAG,WAAW,EAAE,EAAE,QAAQ,IAAI,EAAE,CAAC;IAC/C,IAAI,OAAO,GAAG,MAAM,CAAC;IACrB,IAAI,cAAc,GAAG,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC;IACzC,IAAI,QAAQ,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,GAAG,KAAK,CAAC;QAChB,cAAc,GAAG,QAAQ,CAAC,GAAG,CAAC;IAChC,CAAC;SAAM,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QACvC,OAAO,GAAG,MAAM,CAAC;QACjB,cAAc,GAAG,QAAQ,CAAC,IAAI,CAAC;IACjC,CAAC;IACD,MAAM,GAAG,GAAY;QACnB,EAAE,EAAE,OAAO,CAAC,OAAO;QACnB,MAAM,EAAE,KAAK;QACb,GAAG,EAAE,kCAAkC,OAAO,CAAC,OAAO,EAAE;QACxD,OAAO,EAAE,OAAO,CAAC,UAAU;QAC3B,iBAAiB,EAAE,iBAAiB;QACpC,QAAQ,EAAE,YAAY;QACtB,OAAO;QACP,eAAe,EAAE,cAAc;QAC/B,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC;IACF,IAAI,MAAM,GAAG,IAAI,GAAG,EAA2B,CAAC;IAChD,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,IAAI,KAAgD,CAAC;IAErD,SAAS,UAAU;QACjB,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,KAAK,WAAW,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC;QAC/D,UAAU,CAAC,KAAK,CAAC,CAAC;QAClB,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACjC,CAAC;IAED,KAAK,UAAU,WAAW,CAAC,YAA0B;QACnD,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC;YAAE,OAAO;QAC9B,IAAI,KAAK,KAAK,SAAS;YAAE,YAAY,CAAC,KAAK,CAAC,CAAC;QAC7C,KAAK,GAAG,SAAS,CAAC;QAClB,aAAa,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,EAAE,GAAG,CAAC,CAAC;QAC5E,MAAM,UAAU,GAAG,MAAM,CAAC;QAC1B,MAAM,eAAe,GAAG,WAAW,CAAC;QACpC,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACnB,IAAI,iBAAiB,EAAE;YAAE,OAAO;QAChC,IAAI,MAAgC,CAAC;QACrC,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE;aAC3B,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aACxB,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;YACxB,MAAM,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QACL,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACvB,MAAM,IAAI,CAAC;QACX,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1B,IAAI,MAAM,KAAK,MAAM,IAAI,YAAY,KAAK,MAAM;YAAE,OAAO;QAEzD,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC;YAAE,UAAU,EAAE,CAAC;QACpC,IAAI,eAAe,GAAG,WAAW;YAAE,WAAW,GAAG,eAAe,CAAC;QACjE,KAAK,MAAM,CAAC,WAAW,EAAE,aAAa,CAAC,IAAI,UAAU,EAAE,CAAC;YACtD,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAC1C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;YACzC,CAAC;iBAAM,CAAC;gBACN,SAAS,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;IACH,CAAC;IAED,eAAe,EAAE,CAAC;IAElB,OAAO;QACL,SAAS,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACvB,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC;gBAAE,UAAU,EAAE,CAAC;YACpC,IAAI,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YAC7C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,SAAS,GAAG,WAAW,EAAE,CAAC;gBAC1B,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;YAC1C,CAAC;YACD,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC1B,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,eAAe;IACtB,IAAI,iBAAiB;QAAE,OAAO;IAC9B,iBAAiB,GAAG,IAAI,CAAC;IACzB,yDAAyD;IACzD,0FAA0F;IAC1F,WAAW,EAAE,EAAE,EAAE,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE,CAAC,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;AACrE,CAAC;AAED,SAAS,UAAU,CAAC,KAAc;IAChC,IAAI,KAAK,YAAY,MAAM,IAAI,OAAO,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;QACrF,KAAK,CAAC,KAAK,EAAE,CAAC;IAChB,CAAC;AACH,CAAC;AAED,SAAS,WAAW;IAClB,OAAO;QACL,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,CAAC;QACX,aAAa,EAAE,CAAC;QAChB,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,aAAa,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;QAC5F,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;KACjF,CAAC;AACJ,CAAC;AAED,SAAS,MAAM,CAAC,SAA0B,EAAE,IAAiB;IAC3D,SAAS,CAAC,KAAK,IAAI,CAAC,CAAC;IACrB,6FAA6F;IAC7F,+EAA+E;IAC/E,SAAS,CAAC,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACjD,SAAS,CAAC,aAAa,IAAI,IAAI,CAAC,UAAU,CAAC;IAC3C,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;IACzC,KAAK,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,eAAe,EAAE,CAAC;QAClD,IAAI,IAAI,CAAC,UAAU,GAAG,OAAO,EAAE,CAAC;YAC9B,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC/B,MAAM;QACR,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,MAAuB,EAAE,MAAuB;IACjE,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC;IACnC,MAAM,CAAC,aAAa,IAAI,MAAM,CAAC,aAAa,CAAC;IAC7C,KAAK,MAAM,WAAW,IAAI,cAAc,EAAE,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IACD,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAAC,IAAiB;IACpC,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAChC,IAAI,IAAI,CAAC,KAAK,YAAY,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,cAAc;YAAE,OAAO,SAAS,CAAC;QACxF,IAAI,IAAI,CAAC,KAAK,YAAY,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY;YAAE,OAAO,SAAS,CAAC;QACtF,OAAO,eAAe,CAAC;IACzB,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IACpC,IAAI,MAAM,IAAI,GAAG;QAAE,OAAO,KAAK,CAAC;IAChC,IAAI,MAAM,IAAI,GAAG;QAAE,OAAO,KAAK,CAAC;IAChC,IAAI,MAAM,IAAI,GAAG;QAAE,OAAO,KAAK,CAAC;IAChC,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,QAAQ,CACf,MAAoC,EACpC,WAAmB,EACnB,QAAgB,EAChB,GAAY;IAEZ,MAAM,MAAM,GAAoB,EAAE,CAAC;IACnC,KAAK,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,IAAI,MAAM,EAAE,CAAC;QAC9C,MAAM,aAAa,GAAkB;YACnC,EAAE,EAAE,WAAW;YACf,MAAM,EAAE,WAAW;YACnB,GAAG,EAAE,GAAG,GAAG,CAAC,GAAG,cAAc,WAAW,EAAE;YAC1C,SAAS,EAAE,QAAQ;YACnB,KAAK,EAAE,SAAS,CAAC,KAAK;YACtB,QAAQ,EAAE,SAAS,CAAC,QAAQ;YAC5B,eAAe,EAAE,SAAS,CAAC,aAAa;SACzC,CAAC;QACF,KAAK,MAAM,WAAW,IAAI,cAAc,EAAE,CAAC;YACzC,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAC5C,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACd,aAAa,CAAC,UAAU,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC;YACjD,CAAC;QACH,CAAC;QACD,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,eAAe,EAAE,CAAC;YACzC,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACxC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACd,aAAa,CAAC,WAAW,MAAM,EAAE,CAAC,GAAG,KAAK,CAAC;YAC7C,CAAC;QACH,CAAC;QACD,MAAM,CAAC,IAAI,CAAC;YACV,EAAE,EAAE,OAAO,EAAE;YACb,MAAM,EAAE,OAAO;YACf,WAAW,EAAE,KAAK;YAClB,eAAe,EAAE,iCAAiC;YAClD,IAAI,EAAE,UAAU;YAChB,MAAM,EAAE,iBAAiB;YACzB,IAAI,EAAE,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE;YACzC,MAAM,EAAE,aAAa;YACrB,QAAQ,EAAE,SAAS;YACnB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,CAAC,aAAa,EAAE,GAAG,CAAC;SAC3B,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,mGAAmG;AACnG,SAAS,OAAO;IACd,IAAI,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACtB,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC;QACxC,EAAE,GAAG,gBAAgB,CAAC,IAAI,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC;QACtC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;IAC/B,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,eAAe,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;QAC9D,EAAE,IAAI,gBAAgB,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,OAAO,EAAE,EAAE,CAAC;AACrB,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,QAAgB,EAAE,MAAuB;IAC/D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,EAAE;QACrC,MAAM,EAAE,MAAM;QACd,2FAA2F;QAC3F,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,UAAU,EAAE,OAAO,EAAE;QACpE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC3C,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,eAAe,CAAC;KAC7C,CAAC,CAAC;IACH,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;IAC9B,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;AACH,CAAC;AAED,MAAM,iBAAkB,SAAQ,KAAK;IACnB,MAAM,CAAS;IAC/B,YAAY,MAAc;QACxB,KAAK,CAAC,mCAAmC,MAAM,GAAG,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED,SAAS,mBAAmB,CAAC,KAAc;IACzC,oEAAoE;IACpE,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc;QAAE,OAAO,MAAM,CAAC;IAC3E,IAAI,KAAK,YAAY,iBAAiB,EAAE,CAAC;QACvC,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG;YAAE,OAAO,MAAM,CAAC;QACvF,8CAA8C;QAC9C,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAKD,SAAS,aAAa,CAAC,MAAuB;IAC5C,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,YAAY,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;QACvD,8FAA8F;QAC9F,MAAM,UAAU,GAAoB;YAClC,SAAS,CAAC,sBAAsB,EAAE,KAAK,CAAC,EAAE,CAAC;YAC3C,SAAS,CAAC,wBAAwB,EAAE,KAAK,CAAC,IAAI,CAAC;YAC/C,SAAS,CAAC,0BAA0B,EAAE,KAAK,CAAC,MAAM,CAAC;YACnD,SAAS,CAAC,gCAAgC,EAAE,KAAK,CAAC,WAAW,CAAC;YAC9D,SAAS,CAAC,qCAAqC,EAAE,KAAK,CAAC,eAAe,CAAC;YACvE,SAAS,CAAC,wBAAwB,EAAE,KAAK,CAAC,IAAI,CAAC;YAC/C,SAAS,CAAC,2BAA2B,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACxD,SAAS,CAAC,0BAA0B,EAAE,KAAK,CAAC,MAAM,CAAC;YACnD,SAAS,CAAC,0BAA0B,EAAE,KAAK,CAAC,MAAM,CAAC;YACnD,SAAS,CAAC,4BAA4B,EAAE,KAAK,CAAC,QAAQ,CAAC;YACvD,SAAS,CAAC,0BAA0B,EAAE,KAAK,CAAC,MAAM,CAAC;YACnD,SAAS,CAAC,8BAA8B,EAAE,EAAE,CAAC;SAC9C,CAAC;QACF,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YAC9B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAChD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBACxB,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,0BAA0B,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;gBACpF,CAAC;YACH,CAAC;QACH,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YAC9B,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,8BAA8B,IAAI,CAAC,MAAM,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;YACpF,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,8BAA8B,IAAI,CAAC,MAAM,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YAC5F,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,8BAA8B,IAAI,CAAC,MAAM,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACxF,CAAC;QACD,KAAK,CAAC,IAAI,CAAC;YACT,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;YACtB,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;YACpB,IAAI,EAAE,SAAS,KAAK,CAAC,IAAI,EAAE;YAC3B,IAAI,EAAE,CAAC;YACP,iBAAiB,EAAE,YAAY;YAC/B,eAAe,EAAE,YAAY;YAC7B,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IACD,OAAO;QACL,aAAa,EAAE;YACb;gBACE,QAAQ,EAAE;oBACR,UAAU,EAAE;wBACV,SAAS,CAAC,cAAc,EAAE,YAAY,CAAC;wBACvC,SAAS,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;qBAChD;iBACF;gBACD,UAAU,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,uBAAuB,EAAE,EAAE,KAAK,EAAE,CAAC;aAClE;SACF;KACF,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,GAAW,EAAE,KAAsB;IACpD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,CAAC;IAC7E,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC;IACxE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,CAAC;AAChD,CAAC;AAED,SAAS,SAAS,CAAC,SAAiB;IAClC,MAAM,KAAK,GAAG,MAAM,CAAC,eAAe,CAAC,IAAI,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IAChE,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,KAAK,MAAM,IAAI,IAAI,KAAK;QAAE,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACpE,OAAO,GAAG,CAAC;AACb,CAAC"}
@@ -1,3 +1,3 @@
1
- export declare const GO_TELEMETRY_SOURCE = "// Usage telemetry for a generated Go SDK, written beside the client by\n// `client.telemetry: on`. It counts calls per operation through the runtime's\n// OnSettled hook and sends one event per operation and window. An event holds\n// only the operation id, the counts, the window, and the SDK identity.\npackage client\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"crypto/rand\"\n\t\"encoding/hex\"\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"math\"\n\t\"net/http\"\n\t\"os\"\n\t\"runtime\"\n\t\"strconv\"\n\t\"strings\"\n\t\"sync\"\n\t\"time\"\n)\n\nconst (\n\tusageTelemetryGeneratorVersion = \"dev\"\n\tusageTelemetryEndpoint = \"https://otel.cloud.redocly.com/v1/traces\"\n\tusageTelemetryEventType = \"com.redocly.sdkUsage.aggregated\"\n\tusageTelemetryServiceName = \"redocly-sdk\"\n\tusageTelemetrySendTimeout = 3 * time.Second\n)\n\n// usageTelemetryRegistered holds each UsageTelemetry that Register added.\nvar usageTelemetryRegistered []*UsageTelemetry\n\nvar usageTelemetryLatencyBuckets = []struct {\n\tname string\n\tbelowMs int64\n}{\n\t{\"lt_100ms\", 100},\n\t{\"lt_300ms\", 300},\n\t{\"lt_1s\", 1000},\n\t{\"lt_3s\", 3000},\n\t{\"lt_10s\", 10000},\n\t{\"gte_10s\", math.MaxInt64},\n}\n\n// UsageTelemetryOptions identifies the SDK. Endpoint defaults to the Redocly\n// OpenTelemetry endpoint and FlushInterval to one minute. Sink, when set,\n// receives the events instead of a send; an error it returns keeps the counts.\ntype UsageTelemetryOptions struct {\n\tSDKName string\n\tSDKVersion string\n\tClient string\n\tEndpoint string\n\tSink func(events []UsageTelemetryEvent) error\n\tFlushInterval time.Duration\n}\n\n// UsageTelemetryEvent is the counts of one operation in one window. Usage values\n// are strings or int64; Time is the window start in RFC 3339 with milliseconds.\ntype UsageTelemetryEvent struct {\n\tID string\n\tType string\n\tSource string\n\tTime string\n\tUsage map[string]any\n\tSDK map[string]string\n}\n\ntype usageTelemetryCounts struct {\n\tcalls int64\n\tattempts int64\n\tdurationSumMs int64\n\tstatus map[string]int64\n\tlatency map[string]int64\n}\n\n// UsageTelemetry counts the calls of every client whose Config.Middleware holds\n// its Middleware(). It is safe for concurrent use.\ntype UsageTelemetry struct {\n\toptions UsageTelemetryOptions\n\tsdk map[string]string\n\tmu sync.Mutex\n\tcounts map[string]*usageTelemetryCounts\n\twindowStart time.Time\n\ttimer *time.Timer\n\tsending sync.Mutex\n}\n\n// NewUsageTelemetry returns the counter. REDOCLY_SDK_TELEMETRY=off or\n// DO_NOT_TRACK=1 turns it off: Middleware then has no hooks.\nfunc NewUsageTelemetry(options UsageTelemetryOptions) *UsageTelemetry {\n\tif options.Endpoint == \"\" {\n\t\toptions.Endpoint = usageTelemetryEndpoint\n\t}\n\tif options.FlushInterval <= 0 {\n\t\toptions.FlushInterval = time.Minute\n\t}\n\treturn &UsageTelemetry{\n\t\toptions: options,\n\t\tsdk: map[string]string{\n\t\t\t\"name\": options.SDKName,\n\t\t\t\"version\": options.SDKVersion,\n\t\t\t\"generator_version\": usageTelemetryGeneratorVersion,\n\t\t\t\"language\": \"go\",\n\t\t\t\"runtime\": \"go\",\n\t\t\t\"runtime_version\": strings.TrimPrefix(runtime.Version(), \"go\"),\n\t\t\t\"client\": options.Client,\n\t\t},\n\t\tcounts: map[string]*usageTelemetryCounts{},\n\t}\n}\n\n// Middleware is the hook to add to Config.Middleware.\nfunc (t *UsageTelemetry) Middleware() Middleware {\n\tif usageTelemetryDisabled() {\n\t\treturn Middleware{}\n\t}\n\treturn Middleware{OnSettled: t.record}\n}\n\n// Register adds the middleware to every client of the package, also to a client created\n// before. Call it once, before the first call, for example in an init function.\nfunc (t *UsageTelemetry) Register() {\n\tregisteredMiddleware = append(registeredMiddleware, t.Middleware())\n\tusageTelemetryRegistered = append(usageTelemetryRegistered, t)\n}\n\n// FlushUsageTelemetry flushes every UsageTelemetry that Register added, as Flush does.\n// Go has no exit hook, so call it before the program ends.\nfunc FlushUsageTelemetry(ctx context.Context) error {\n\tfor _, telemetry := range usageTelemetryRegistered {\n\t\tif err := telemetry.Flush(ctx); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn nil\n}\n\n// Flush sends the open window and waits for the send, or for ctx.\n// Go has no exit hook, so call it before the program ends.\nfunc (t *UsageTelemetry) Flush(ctx context.Context) error {\n\tdone := make(chan struct{})\n\tgo func() {\n\t\tt.flushWindow()\n\t\tclose(done)\n\t}()\n\tselect {\n\tcase <-done:\n\t\treturn nil\n\tcase <-ctx.Done():\n\t\treturn ctx.Err()\n\t}\n}\n\nfunc usageTelemetryDisabled() bool {\n\treturn os.Getenv(\"REDOCLY_SDK_TELEMETRY\") == \"off\" || os.Getenv(\"DO_NOT_TRACK\") == \"1\"\n}\n\nfunc (t *UsageTelemetry) record(call SettledCall) {\n\tt.mu.Lock()\n\tdefer t.mu.Unlock()\n\tif len(t.counts) == 0 {\n\t\tt.openWindow()\n\t}\n\toperation := t.counts[call.OperationID]\n\tif operation == nil {\n\t\toperation = &usageTelemetryCounts{status: map[string]int64{}, latency: map[string]int64{}}\n\t\tt.counts[call.OperationID] = operation\n\t}\n\tdurationMs := call.Duration.Milliseconds()\n\toperation.calls++\n\toperation.attempts += int64(call.Attempts)\n\toperation.durationSumMs += durationMs\n\toperation.status[usageTelemetryStatusClass(call)]++\n\tfor _, bucket := range usageTelemetryLatencyBuckets {\n\t\tif durationMs < bucket.belowMs {\n\t\t\toperation.latency[bucket.name]++\n\t\t\tbreak\n\t\t}\n\t}\n}\n\n// openWindow must run with t.mu held.\nfunc (t *UsageTelemetry) openWindow() {\n\tt.windowStart = time.Now()\n\tt.timer = time.AfterFunc(t.options.FlushInterval, t.flushWindow)\n}\n\nfunc (t *UsageTelemetry) flushWindow() {\n\t// One send at a time, so Flush also waits for a send that the timer started.\n\tt.sending.Lock()\n\tdefer t.sending.Unlock()\n\tt.mu.Lock()\n\tif len(t.counts) == 0 {\n\t\tt.mu.Unlock()\n\t\treturn\n\t}\n\tt.timer.Stop()\n\tsentCounts := t.counts\n\tsentStart := t.windowStart\n\tt.counts = map[string]*usageTelemetryCounts{}\n\tt.mu.Unlock()\n\n\tif usageTelemetryDisabled() {\n\t\treturn\n\t}\n\tevents := t.toEvents(sentCounts, sentStart, time.Since(sentStart))\n\terr := t.send(events)\n\tif err == nil || !usageTelemetryKeepAfter(err) {\n\t\treturn\n\t}\n\tt.mu.Lock()\n\tdefer t.mu.Unlock()\n\tif len(t.counts) == 0 {\n\t\tt.openWindow()\n\t}\n\tif sentStart.Before(t.windowStart) {\n\t\tt.windowStart = sentStart\n\t}\n\tfor operationID, sent := range sentCounts {\n\t\toperation := t.counts[operationID]\n\t\tif operation == nil {\n\t\t\tt.counts[operationID] = sent\n\t\t\tcontinue\n\t\t}\n\t\toperation.calls += sent.calls\n\t\toperation.attempts += sent.attempts\n\t\toperation.durationSumMs += sent.durationSumMs\n\t\tfor key, count := range sent.status {\n\t\t\toperation.status[key] += count\n\t\t}\n\t\tfor key, count := range sent.latency {\n\t\t\toperation.latency[key] += count\n\t\t}\n\t}\n}\n\nfunc usageTelemetryStatusClass(call SettledCall) string {\n\tif call.Response == nil {\n\t\tvar timeout *TimeoutError\n\t\t// The caller's own deadline is a timeout too, as a caller's AbortSignal.timeout() is in TypeScript.\n\t\tif errors.As(call.Err, &timeout) || errors.Is(call.Err, context.DeadlineExceeded) {\n\t\t\treturn \"timeout\"\n\t\t}\n\t\tif errors.Is(call.Err, context.Canceled) {\n\t\t\treturn \"aborted\"\n\t\t}\n\t\treturn \"network_error\"\n\t}\n\tstatus := call.Response.StatusCode\n\tswitch {\n\tcase status >= 500:\n\t\treturn \"5xx\"\n\tcase status >= 400:\n\t\treturn \"4xx\"\n\tcase status >= 300:\n\t\treturn \"3xx\"\n\t}\n\treturn \"2xx\"\n}\n\nfunc (t *UsageTelemetry) toEvents(counts map[string]*usageTelemetryCounts, windowStart time.Time, window time.Duration) []UsageTelemetryEvent {\n\tevents := []UsageTelemetryEvent{}\n\tfor operationID, operation := range counts {\n\t\tusage := map[string]any{\n\t\t\t\"operation_id\": operationID,\n\t\t\t\"window_ms\": window.Milliseconds(),\n\t\t\t\"calls\": operation.calls,\n\t\t\t\"attempts\": operation.attempts,\n\t\t\t\"duration_sum_ms\": operation.durationSumMs,\n\t\t}\n\t\tfor key, count := range operation.status {\n\t\t\tusage[\"status_\"+key] = count\n\t\t}\n\t\tfor key, count := range operation.latency {\n\t\t\tusage[\"latency_\"+key] = count\n\t\t}\n\t\tevents = append(events, UsageTelemetryEvent{\n\t\t\tID: \"evt_\" + usageTelemetryRandomHex(16),\n\t\t\tType: usageTelemetryEventType,\n\t\t\tSource: t.options.SDKName,\n\t\t\tTime: windowStart.UTC().Format(\"2006-01-02T15:04:05.000Z\"),\n\t\t\tUsage: usage,\n\t\t\tSDK: t.sdk,\n\t\t})\n\t}\n\treturn events\n}\n\ntype usageTelemetryRejectedError struct {\n\tstatus int\n}\n\nfunc (e *usageTelemetryRejectedError) Error() string {\n\treturn fmt.Sprintf(\"the telemetry endpoint answered %d\", e.status)\n}\n\nfunc (t *UsageTelemetry) send(events []UsageTelemetryEvent) error {\n\tif t.options.Sink != nil {\n\t\treturn t.options.Sink(events)\n\t}\n\tbody, err := json.Marshal(usageTelemetryOtlpRequest(events))\n\tif err != nil {\n\t\treturn err\n\t}\n\tctx, cancel := context.WithTimeout(context.Background(), usageTelemetrySendTimeout)\n\tdefer cancel()\n\treq, err := http.NewRequestWithContext(ctx, http.MethodPost, t.options.Endpoint, bytes.NewReader(body))\n\tif err != nil {\n\t\treturn err\n\t}\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\t// One send per window, so the connection is never reused.\n\treq.Close = true\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\treturn err\n\t}\n\tresp.Body.Close()\n\tif resp.StatusCode < 200 || resp.StatusCode > 299 {\n\t\treturn &usageTelemetryRejectedError{status: resp.StatusCode}\n\t}\n\treturn nil\n}\n\nfunc usageTelemetryKeepAfter(err error) bool {\n\t// The endpoint can have stored the counts of a send that timed out.\n\tif errors.Is(err, context.DeadlineExceeded) {\n\t\treturn false\n\t}\n\tvar rejected *usageTelemetryRejectedError\n\tif errors.As(err, &rejected) {\n\t\treturn rejected.status == 408 || rejected.status == 429 || rejected.status >= 500\n\t}\n\treturn true\n}\n\nfunc usageTelemetryOtlpRequest(events []UsageTelemetryEvent) map[string]any {\n\tspans := []map[string]any{}\n\tfor _, event := range events {\n\t\teventTime, _ := time.Parse(time.RFC3339, event.Time)\n\t\ttimeUnixNano := strconv.FormatInt(eventTime.UnixMilli(), 10) + \"000000\"\n\t\tattributes := []map[string]any{\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_id\", event.ID),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_type\", event.Type),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_source\", event.Source),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_spec_version\", \"1.0\"),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_data_content_type\", \"application/json; charset=utf-8\"),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_time\", event.Time),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_subject\", \"\"),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_origin\", usageTelemetryServiceName),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_object\", \"event\"),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_category\", \"product\"),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_signal\", \"metric\"),\n\t\t}\n\t\tfor key, value := range event.Usage {\n\t\t\tattributes = append(attributes, usageTelemetryAttribute(\"cloudevents.event_data.usage.\"+key, value))\n\t\t}\n\t\tfor key, value := range event.SDK {\n\t\t\tattributes = append(attributes, usageTelemetryAttribute(\"cloudevents.event_data.sdk.\"+key, value))\n\t\t}\n\t\tspans = append(spans, map[string]any{\n\t\t\t\"traceId\": usageTelemetryRandomHex(16),\n\t\t\t\"spanId\": usageTelemetryRandomHex(8),\n\t\t\t\"name\": \"event.\" + event.Type,\n\t\t\t\"kind\": 1,\n\t\t\t\"startTimeUnixNano\": timeUnixNano,\n\t\t\t\"endTimeUnixNano\": timeUnixNano,\n\t\t\t\"attributes\": attributes,\n\t\t})\n\t}\n\treturn map[string]any{\n\t\t\"resourceSpans\": []map[string]any{\n\t\t\t{\n\t\t\t\t\"resource\": map[string]any{\n\t\t\t\t\t\"attributes\": []map[string]any{\n\t\t\t\t\t\tusageTelemetryAttribute(\"service.name\", usageTelemetryServiceName),\n\t\t\t\t\t\tusageTelemetryAttribute(\"service.version\", usageTelemetryGeneratorVersion),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\"scopeSpans\": []map[string]any{\n\t\t\t\t\t{\"scope\": map[string]any{\"name\": \"redocly-sdk-telemetry\"}, \"spans\": spans},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n}\n\nfunc usageTelemetryAttribute(key string, value any) map[string]any {\n\tswitch typed := value.(type) {\n\tcase int64:\n\t\treturn map[string]any{\"key\": key, \"value\": map[string]any{\"intValue\": typed}}\n\tcase string:\n\t\treturn map[string]any{\"key\": key, \"value\": map[string]any{\"stringValue\": typed}}\n\t}\n\treturn map[string]any{\"key\": key, \"value\": map[string]any{\"stringValue\": fmt.Sprint(value)}}\n}\n\nfunc usageTelemetryRandomHex(byteCount int) string {\n\tbuffer := make([]byte, byteCount)\n\trand.Read(buffer)\n\treturn hex.EncodeToString(buffer)\n}\n";
1
+ export declare const GO_TELEMETRY_SOURCE = "// Usage telemetry for a generated Go SDK, written beside the client by\n// `client.telemetry: on`. It counts calls per operation through the runtime's\n// OnSettled hook and sends one event per operation and window. An event holds\n// only the operation id, the counts, the window, and the SDK identity.\npackage client\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"crypto/rand\"\n\t\"encoding/hex\"\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"math\"\n\t\"net/http\"\n\t\"os\"\n\t\"runtime\"\n\t\"strconv\"\n\t\"strings\"\n\t\"sync\"\n\t\"time\"\n)\n\nconst (\n\tusageTelemetryGeneratorVersion = \"dev\"\n\tusageTelemetryEndpoint = \"https://otel.cloud.redocly.com/v1/traces\"\n\tusageTelemetryEventType = \"com.redocly.sdkUsage.aggregated\"\n\tusageTelemetryServiceName = \"redocly-sdk\"\n\tusageTelemetrySendTimeout = 3 * time.Second\n\tusageTelemetrySDKURNPrefix = \"urn:redocly:cli:sdk:go:\"\n\tusageTelemetryCrockfordBase32 = \"0123456789abcdefghjkmnpqrstvwxyz\"\n)\n\n// usageTelemetryRegistered holds each UsageTelemetry that Register added.\nvar usageTelemetryRegistered []*UsageTelemetry\n\nvar usageTelemetryLatencyBuckets = []struct {\n\tname string\n\tbelowMs int64\n}{\n\t{\"lt_100ms\", 100},\n\t{\"lt_300ms\", 300},\n\t{\"lt_1s\", 1000},\n\t{\"lt_3s\", 3000},\n\t{\"lt_10s\", 10000},\n\t{\"gte_10s\", math.MaxInt64},\n}\n\n// UsageTelemetryOptions identifies the SDK. Endpoint defaults to the Redocly\n// OpenTelemetry endpoint and FlushInterval to one minute. Sink, when set,\n// receives the events instead of a send; an error it returns keeps the counts.\ntype UsageTelemetryOptions struct {\n\tSDKName string\n\tSDKVersion string\n\tClient string\n\tEndpoint string\n\tSink func(events []UsageTelemetryEvent) error\n\tFlushInterval time.Duration\n}\n\n// UsageTelemetryEvent is one com.redocly.sdkUsage.aggregated CloudEvent: the counts\n// of one operation in one window. Data holds the operation, then the SDK; their values\n// are strings or int64. Time is the window start in RFC 3339 with milliseconds. The\n// OpenTelemetry collector sets the env of the event. The json tags make a Sink that\n// marshals an event write the CloudEvent field names, as in the other languages.\ntype UsageTelemetryEvent struct {\n\tID string `json:\"id\"`\n\tObject string `json:\"object\"`\n\tSpecVersion string `json:\"specversion\"`\n\tDataContentType string `json:\"datacontenttype\"`\n\tType string `json:\"type\"`\n\tSource string `json:\"source\"`\n\tTime string `json:\"time\"`\n\tOrigin string `json:\"origin\"`\n\tCategory string `json:\"category\"`\n\tSignal string `json:\"signal\"`\n\tData []map[string]any `json:\"data\"`\n}\n\ntype usageTelemetryCounts struct {\n\tcalls int64\n\tattempts int64\n\tdurationSumMs int64\n\tstatus map[string]int64\n\tlatency map[string]int64\n}\n\n// UsageTelemetry counts the calls of every client whose Config.Middleware holds\n// its Middleware(). It is safe for concurrent use.\ntype UsageTelemetry struct {\n\toptions UsageTelemetryOptions\n\tsdk map[string]any\n\tmu sync.Mutex\n\tcounts map[string]*usageTelemetryCounts\n\twindowStart time.Time\n\ttimer *time.Timer\n\tsending sync.Mutex\n}\n\n// NewUsageTelemetry returns the counter. REDOCLY_SDK_TELEMETRY=off or\n// DO_NOT_TRACK=1 turns it off: Middleware then has no hooks.\nfunc NewUsageTelemetry(options UsageTelemetryOptions) *UsageTelemetry {\n\tif options.Endpoint == \"\" {\n\t\toptions.Endpoint = usageTelemetryEndpoint\n\t}\n\tif options.FlushInterval <= 0 {\n\t\toptions.FlushInterval = time.Minute\n\t}\n\treturn &UsageTelemetry{\n\t\toptions: options,\n\t\tsdk: map[string]any{\n\t\t\t\"id\": options.SDKName,\n\t\t\t\"object\": \"sdk\",\n\t\t\t\"uri\": usageTelemetrySDKURNPrefix + options.SDKName,\n\t\t\t\"version\": options.SDKVersion,\n\t\t\t\"generator_version\": usageTelemetryGeneratorVersion,\n\t\t\t\"language\": \"go\",\n\t\t\t\"runtime\": \"go\",\n\t\t\t\"runtime_version\": strings.TrimPrefix(runtime.Version(), \"go\"),\n\t\t\t\"client\": options.Client,\n\t\t},\n\t\tcounts: map[string]*usageTelemetryCounts{},\n\t}\n}\n\n// Middleware is the hook to add to Config.Middleware.\nfunc (t *UsageTelemetry) Middleware() Middleware {\n\tif usageTelemetryDisabled() {\n\t\treturn Middleware{}\n\t}\n\treturn Middleware{OnSettled: t.record}\n}\n\n// Register adds the middleware to every client of the package, also to a client created\n// before. Call it once, before the first call, for example in an init function.\nfunc (t *UsageTelemetry) Register() {\n\tregisteredMiddleware = append(registeredMiddleware, t.Middleware())\n\tusageTelemetryRegistered = append(usageTelemetryRegistered, t)\n}\n\n// FlushUsageTelemetry flushes every UsageTelemetry that Register added, as Flush does.\n// Go has no exit hook, so call it before the program ends.\nfunc FlushUsageTelemetry(ctx context.Context) error {\n\tfor _, telemetry := range usageTelemetryRegistered {\n\t\tif err := telemetry.Flush(ctx); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn nil\n}\n\n// Flush sends the open window and waits for the send, or for ctx.\n// Go has no exit hook, so call it before the program ends.\nfunc (t *UsageTelemetry) Flush(ctx context.Context) error {\n\tdone := make(chan struct{})\n\tgo func() {\n\t\tt.flushWindow()\n\t\tclose(done)\n\t}()\n\tselect {\n\tcase <-done:\n\t\treturn nil\n\tcase <-ctx.Done():\n\t\treturn ctx.Err()\n\t}\n}\n\nfunc usageTelemetryDisabled() bool {\n\treturn os.Getenv(\"REDOCLY_SDK_TELEMETRY\") == \"off\" || os.Getenv(\"DO_NOT_TRACK\") == \"1\"\n}\n\nfunc (t *UsageTelemetry) record(call SettledCall) {\n\tt.mu.Lock()\n\tdefer t.mu.Unlock()\n\tif len(t.counts) == 0 {\n\t\tt.openWindow()\n\t}\n\toperation := t.counts[call.OperationID]\n\tif operation == nil {\n\t\toperation = &usageTelemetryCounts{status: map[string]int64{}, latency: map[string]int64{}}\n\t\tt.counts[call.OperationID] = operation\n\t}\n\tdurationMs := call.Duration.Milliseconds()\n\toperation.calls++\n\toperation.attempts += int64(call.Attempts)\n\toperation.durationSumMs += durationMs\n\toperation.status[usageTelemetryStatusClass(call)]++\n\tfor _, bucket := range usageTelemetryLatencyBuckets {\n\t\tif durationMs < bucket.belowMs {\n\t\t\toperation.latency[bucket.name]++\n\t\t\tbreak\n\t\t}\n\t}\n}\n\n// openWindow must run with t.mu held.\nfunc (t *UsageTelemetry) openWindow() {\n\tt.windowStart = time.Now()\n\tt.timer = time.AfterFunc(t.options.FlushInterval, t.flushWindow)\n}\n\nfunc (t *UsageTelemetry) flushWindow() {\n\t// One send at a time, so Flush also waits for a send that the timer started.\n\tt.sending.Lock()\n\tdefer t.sending.Unlock()\n\tt.mu.Lock()\n\tif len(t.counts) == 0 {\n\t\tt.mu.Unlock()\n\t\treturn\n\t}\n\tt.timer.Stop()\n\tsentCounts := t.counts\n\tsentStart := t.windowStart\n\tt.counts = map[string]*usageTelemetryCounts{}\n\tt.mu.Unlock()\n\n\tif usageTelemetryDisabled() {\n\t\treturn\n\t}\n\tevents := t.toEvents(sentCounts, sentStart, time.Since(sentStart))\n\terr := t.send(events)\n\tif err == nil || !usageTelemetryKeepAfter(err) {\n\t\treturn\n\t}\n\tt.mu.Lock()\n\tdefer t.mu.Unlock()\n\tif len(t.counts) == 0 {\n\t\tt.openWindow()\n\t}\n\tif sentStart.Before(t.windowStart) {\n\t\tt.windowStart = sentStart\n\t}\n\tfor operationID, sent := range sentCounts {\n\t\toperation := t.counts[operationID]\n\t\tif operation == nil {\n\t\t\tt.counts[operationID] = sent\n\t\t\tcontinue\n\t\t}\n\t\toperation.calls += sent.calls\n\t\toperation.attempts += sent.attempts\n\t\toperation.durationSumMs += sent.durationSumMs\n\t\tfor key, count := range sent.status {\n\t\t\toperation.status[key] += count\n\t\t}\n\t\tfor key, count := range sent.latency {\n\t\t\toperation.latency[key] += count\n\t\t}\n\t}\n}\n\nfunc usageTelemetryStatusClass(call SettledCall) string {\n\tif call.Response == nil {\n\t\tvar timeout *TimeoutError\n\t\t// The caller's own deadline is a timeout too, as a caller's AbortSignal.timeout() is in TypeScript.\n\t\tif errors.As(call.Err, &timeout) || errors.Is(call.Err, context.DeadlineExceeded) {\n\t\t\treturn \"timeout\"\n\t\t}\n\t\tif errors.Is(call.Err, context.Canceled) {\n\t\t\treturn \"aborted\"\n\t\t}\n\t\treturn \"network_error\"\n\t}\n\tstatus := call.Response.StatusCode\n\tswitch {\n\tcase status >= 500:\n\t\treturn \"5xx\"\n\tcase status >= 400:\n\t\treturn \"4xx\"\n\tcase status >= 300:\n\t\treturn \"3xx\"\n\t}\n\treturn \"2xx\"\n}\n\nfunc (t *UsageTelemetry) toEvents(counts map[string]*usageTelemetryCounts, windowStart time.Time, window time.Duration) []UsageTelemetryEvent {\n\tevents := []UsageTelemetryEvent{}\n\tfor operationID, operation := range counts {\n\t\toperationItem := map[string]any{\n\t\t\t\"id\": operationID,\n\t\t\t\"object\": \"operation\",\n\t\t\t\"uri\": usageTelemetrySDKURNPrefix + t.options.SDKName + \":operation:\" + operationID,\n\t\t\t\"window_ms\": window.Milliseconds(),\n\t\t\t\"calls\": operation.calls,\n\t\t\t\"attempts\": operation.attempts,\n\t\t\t\"duration_sum_ms\": operation.durationSumMs,\n\t\t}\n\t\tfor key, count := range operation.status {\n\t\t\toperationItem[\"status_\"+key] = count\n\t\t}\n\t\tfor key, count := range operation.latency {\n\t\t\toperationItem[\"latency_\"+key] = count\n\t\t}\n\t\tevents = append(events, UsageTelemetryEvent{\n\t\t\tID: usageTelemetryEventID(),\n\t\t\tObject: \"event\",\n\t\t\tSpecVersion: \"1.0\",\n\t\t\tDataContentType: \"application/json; charset=utf-8\",\n\t\t\tType: usageTelemetryEventType,\n\t\t\tSource: \"urn:redocly:cli\",\n\t\t\tTime: windowStart.UTC().Format(\"2006-01-02T15:04:05.000Z\"),\n\t\t\tOrigin: \"redocly-sdk\",\n\t\t\tCategory: \"product\",\n\t\t\tSignal: \"metric\",\n\t\t\tData: []map[string]any{operationItem, t.sdk},\n\t\t})\n\t}\n\treturn events\n}\n\n// usageTelemetryEventID returns evt_ and a lowercase ULID: 10 characters of the time\n// in milliseconds, then 16 random characters.\nfunc usageTelemetryEventID() string {\n\tid := make([]byte, 26)\n\tmillis := time.Now().UnixMilli()\n\tfor index := 9; index >= 0; index-- {\n\t\tid[index] = usageTelemetryCrockfordBase32[millis%32]\n\t\tmillis /= 32\n\t}\n\trandom := make([]byte, 16)\n\trand.Read(random)\n\tfor index, value := range random {\n\t\tid[10+index] = usageTelemetryCrockfordBase32[value%32]\n\t}\n\treturn \"evt_\" + string(id)\n}\n\ntype usageTelemetryRejectedError struct {\n\tstatus int\n}\n\nfunc (e *usageTelemetryRejectedError) Error() string {\n\treturn fmt.Sprintf(\"the telemetry endpoint answered %d\", e.status)\n}\n\nfunc (t *UsageTelemetry) send(events []UsageTelemetryEvent) error {\n\tif t.options.Sink != nil {\n\t\treturn t.options.Sink(events)\n\t}\n\tbody, err := json.Marshal(usageTelemetryOtlpRequest(events))\n\tif err != nil {\n\t\treturn err\n\t}\n\tctx, cancel := context.WithTimeout(context.Background(), usageTelemetrySendTimeout)\n\tdefer cancel()\n\treq, err := http.NewRequestWithContext(ctx, http.MethodPost, t.options.Endpoint, bytes.NewReader(body))\n\tif err != nil {\n\t\treturn err\n\t}\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\t// One send per window, so the connection is never reused.\n\treq.Close = true\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\treturn err\n\t}\n\tresp.Body.Close()\n\tif resp.StatusCode < 200 || resp.StatusCode > 299 {\n\t\treturn &usageTelemetryRejectedError{status: resp.StatusCode}\n\t}\n\treturn nil\n}\n\nfunc usageTelemetryKeepAfter(err error) bool {\n\t// The endpoint can have stored the counts of a send that timed out.\n\tif errors.Is(err, context.DeadlineExceeded) {\n\t\treturn false\n\t}\n\tvar rejected *usageTelemetryRejectedError\n\tif errors.As(err, &rejected) {\n\t\treturn rejected.status == 408 || rejected.status == 429 || rejected.status >= 500\n\t}\n\treturn true\n}\n\nfunc usageTelemetryOtlpRequest(events []UsageTelemetryEvent) map[string]any {\n\tspans := []map[string]any{}\n\tfor _, event := range events {\n\t\teventTime, _ := time.Parse(time.RFC3339, event.Time)\n\t\ttimeUnixNano := strconv.FormatInt(eventTime.UnixMilli(), 10) + \"000000\"\n\t\t// The attributes that processCloudEventAttributes of @redocly/cli-otel gives for the event.\n\t\tattributes := []map[string]any{\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_id\", event.ID),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_type\", event.Type),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_source\", event.Source),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_spec_version\", event.SpecVersion),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_data_content_type\", event.DataContentType),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_time\", event.Time),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_subject\", event.Data[0][\"id\"]),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_origin\", event.Origin),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_object\", event.Object),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_category\", event.Category),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_signal\", event.Signal),\n\t\t\tusageTelemetryAttribute(\"cloudevents.event_request_id\", \"\"),\n\t\t}\n\t\tfor _, item := range event.Data {\n\t\t\tfor key, value := range item {\n\t\t\t\tattributes = append(attributes, usageTelemetryAttribute(fmt.Sprintf(\"cloudevents.event_data.%s.%s\", item[\"object\"], key), value))\n\t\t\t}\n\t\t}\n\t\tfor _, item := range event.Data {\n\t\t\tfor _, key := range []string{\"id\", \"object\", \"uri\"} {\n\t\t\t\tattributes = append(attributes, usageTelemetryAttribute(fmt.Sprintf(\"cloudevents.event_subjects.%s.%s\", item[\"object\"], key), item[key]))\n\t\t\t}\n\t\t}\n\t\tspans = append(spans, map[string]any{\n\t\t\t\"traceId\": usageTelemetryRandomHex(16),\n\t\t\t\"spanId\": usageTelemetryRandomHex(8),\n\t\t\t\"name\": \"event.\" + event.Type,\n\t\t\t\"kind\": 1,\n\t\t\t\"startTimeUnixNano\": timeUnixNano,\n\t\t\t\"endTimeUnixNano\": timeUnixNano,\n\t\t\t\"attributes\": attributes,\n\t\t})\n\t}\n\treturn map[string]any{\n\t\t\"resourceSpans\": []map[string]any{\n\t\t\t{\n\t\t\t\t\"resource\": map[string]any{\n\t\t\t\t\t\"attributes\": []map[string]any{\n\t\t\t\t\t\tusageTelemetryAttribute(\"service.name\", usageTelemetryServiceName),\n\t\t\t\t\t\tusageTelemetryAttribute(\"service.version\", usageTelemetryGeneratorVersion),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\"scopeSpans\": []map[string]any{\n\t\t\t\t\t{\"scope\": map[string]any{\"name\": \"redocly-sdk-telemetry\"}, \"spans\": spans},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n}\n\nfunc usageTelemetryAttribute(key string, value any) map[string]any {\n\tswitch typed := value.(type) {\n\tcase int64:\n\t\treturn map[string]any{\"key\": key, \"value\": map[string]any{\"intValue\": typed}}\n\tcase string:\n\t\treturn map[string]any{\"key\": key, \"value\": map[string]any{\"stringValue\": typed}}\n\t}\n\treturn map[string]any{\"key\": key, \"value\": map[string]any{\"stringValue\": fmt.Sprint(value)}}\n}\n\nfunc usageTelemetryRandomHex(byteCount int) string {\n\tbuffer := make([]byte, byteCount)\n\trand.Read(buffer)\n\treturn hex.EncodeToString(buffer)\n}\n";
2
2
  export declare const GO_TELEMETRY_DECLARED_NAMES: readonly ["UsageTelemetryOptions", "UsageTelemetryEvent", "UsageTelemetry", "NewUsageTelemetry", "FlushUsageTelemetry"];
3
3
  //# sourceMappingURL=go-telemetry.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"go-telemetry.d.ts","sourceRoot":"","sources":["../../src/runtime-sources/go-telemetry.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,mBAAmB,o9ZACkuZ,CAAC;AAEnwZ,eAAO,MAAM,2BAA2B,yHAM9B,CAAC"}
1
+ {"version":3,"file":"go-telemetry.d.ts","sourceRoot":"","sources":["../../src/runtime-sources/go-telemetry.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,mBAAmB,uxeAC2+d,CAAC;AAE5ge,eAAO,MAAM,2BAA2B,yHAM9B,CAAC"}
@@ -1,5 +1,5 @@
1
1
  // GENERATED by scripts/generate-runtime-sources.mjs — do not edit. Regenerated on install (`prepare`); manually: `npm run prepare -w @redocly/client-generator`.
2
- export const GO_TELEMETRY_SOURCE = '// Usage telemetry for a generated Go SDK, written beside the client by\n// `client.telemetry: on`. It counts calls per operation through the runtime\'s\n// OnSettled hook and sends one event per operation and window. An event holds\n// only the operation id, the counts, the window, and the SDK identity.\npackage client\n\nimport (\n\t"bytes"\n\t"context"\n\t"crypto/rand"\n\t"encoding/hex"\n\t"encoding/json"\n\t"errors"\n\t"fmt"\n\t"math"\n\t"net/http"\n\t"os"\n\t"runtime"\n\t"strconv"\n\t"strings"\n\t"sync"\n\t"time"\n)\n\nconst (\n\tusageTelemetryGeneratorVersion = "dev"\n\tusageTelemetryEndpoint = "https://otel.cloud.redocly.com/v1/traces"\n\tusageTelemetryEventType = "com.redocly.sdkUsage.aggregated"\n\tusageTelemetryServiceName = "redocly-sdk"\n\tusageTelemetrySendTimeout = 3 * time.Second\n)\n\n// usageTelemetryRegistered holds each UsageTelemetry that Register added.\nvar usageTelemetryRegistered []*UsageTelemetry\n\nvar usageTelemetryLatencyBuckets = []struct {\n\tname string\n\tbelowMs int64\n}{\n\t{"lt_100ms", 100},\n\t{"lt_300ms", 300},\n\t{"lt_1s", 1000},\n\t{"lt_3s", 3000},\n\t{"lt_10s", 10000},\n\t{"gte_10s", math.MaxInt64},\n}\n\n// UsageTelemetryOptions identifies the SDK. Endpoint defaults to the Redocly\n// OpenTelemetry endpoint and FlushInterval to one minute. Sink, when set,\n// receives the events instead of a send; an error it returns keeps the counts.\ntype UsageTelemetryOptions struct {\n\tSDKName string\n\tSDKVersion string\n\tClient string\n\tEndpoint string\n\tSink func(events []UsageTelemetryEvent) error\n\tFlushInterval time.Duration\n}\n\n// UsageTelemetryEvent is the counts of one operation in one window. Usage values\n// are strings or int64; Time is the window start in RFC 3339 with milliseconds.\ntype UsageTelemetryEvent struct {\n\tID string\n\tType string\n\tSource string\n\tTime string\n\tUsage map[string]any\n\tSDK map[string]string\n}\n\ntype usageTelemetryCounts struct {\n\tcalls int64\n\tattempts int64\n\tdurationSumMs int64\n\tstatus map[string]int64\n\tlatency map[string]int64\n}\n\n// UsageTelemetry counts the calls of every client whose Config.Middleware holds\n// its Middleware(). It is safe for concurrent use.\ntype UsageTelemetry struct {\n\toptions UsageTelemetryOptions\n\tsdk map[string]string\n\tmu sync.Mutex\n\tcounts map[string]*usageTelemetryCounts\n\twindowStart time.Time\n\ttimer *time.Timer\n\tsending sync.Mutex\n}\n\n// NewUsageTelemetry returns the counter. REDOCLY_SDK_TELEMETRY=off or\n// DO_NOT_TRACK=1 turns it off: Middleware then has no hooks.\nfunc NewUsageTelemetry(options UsageTelemetryOptions) *UsageTelemetry {\n\tif options.Endpoint == "" {\n\t\toptions.Endpoint = usageTelemetryEndpoint\n\t}\n\tif options.FlushInterval <= 0 {\n\t\toptions.FlushInterval = time.Minute\n\t}\n\treturn &UsageTelemetry{\n\t\toptions: options,\n\t\tsdk: map[string]string{\n\t\t\t"name": options.SDKName,\n\t\t\t"version": options.SDKVersion,\n\t\t\t"generator_version": usageTelemetryGeneratorVersion,\n\t\t\t"language": "go",\n\t\t\t"runtime": "go",\n\t\t\t"runtime_version": strings.TrimPrefix(runtime.Version(), "go"),\n\t\t\t"client": options.Client,\n\t\t},\n\t\tcounts: map[string]*usageTelemetryCounts{},\n\t}\n}\n\n// Middleware is the hook to add to Config.Middleware.\nfunc (t *UsageTelemetry) Middleware() Middleware {\n\tif usageTelemetryDisabled() {\n\t\treturn Middleware{}\n\t}\n\treturn Middleware{OnSettled: t.record}\n}\n\n// Register adds the middleware to every client of the package, also to a client created\n// before. Call it once, before the first call, for example in an init function.\nfunc (t *UsageTelemetry) Register() {\n\tregisteredMiddleware = append(registeredMiddleware, t.Middleware())\n\tusageTelemetryRegistered = append(usageTelemetryRegistered, t)\n}\n\n// FlushUsageTelemetry flushes every UsageTelemetry that Register added, as Flush does.\n// Go has no exit hook, so call it before the program ends.\nfunc FlushUsageTelemetry(ctx context.Context) error {\n\tfor _, telemetry := range usageTelemetryRegistered {\n\t\tif err := telemetry.Flush(ctx); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn nil\n}\n\n// Flush sends the open window and waits for the send, or for ctx.\n// Go has no exit hook, so call it before the program ends.\nfunc (t *UsageTelemetry) Flush(ctx context.Context) error {\n\tdone := make(chan struct{})\n\tgo func() {\n\t\tt.flushWindow()\n\t\tclose(done)\n\t}()\n\tselect {\n\tcase <-done:\n\t\treturn nil\n\tcase <-ctx.Done():\n\t\treturn ctx.Err()\n\t}\n}\n\nfunc usageTelemetryDisabled() bool {\n\treturn os.Getenv("REDOCLY_SDK_TELEMETRY") == "off" || os.Getenv("DO_NOT_TRACK") == "1"\n}\n\nfunc (t *UsageTelemetry) record(call SettledCall) {\n\tt.mu.Lock()\n\tdefer t.mu.Unlock()\n\tif len(t.counts) == 0 {\n\t\tt.openWindow()\n\t}\n\toperation := t.counts[call.OperationID]\n\tif operation == nil {\n\t\toperation = &usageTelemetryCounts{status: map[string]int64{}, latency: map[string]int64{}}\n\t\tt.counts[call.OperationID] = operation\n\t}\n\tdurationMs := call.Duration.Milliseconds()\n\toperation.calls++\n\toperation.attempts += int64(call.Attempts)\n\toperation.durationSumMs += durationMs\n\toperation.status[usageTelemetryStatusClass(call)]++\n\tfor _, bucket := range usageTelemetryLatencyBuckets {\n\t\tif durationMs < bucket.belowMs {\n\t\t\toperation.latency[bucket.name]++\n\t\t\tbreak\n\t\t}\n\t}\n}\n\n// openWindow must run with t.mu held.\nfunc (t *UsageTelemetry) openWindow() {\n\tt.windowStart = time.Now()\n\tt.timer = time.AfterFunc(t.options.FlushInterval, t.flushWindow)\n}\n\nfunc (t *UsageTelemetry) flushWindow() {\n\t// One send at a time, so Flush also waits for a send that the timer started.\n\tt.sending.Lock()\n\tdefer t.sending.Unlock()\n\tt.mu.Lock()\n\tif len(t.counts) == 0 {\n\t\tt.mu.Unlock()\n\t\treturn\n\t}\n\tt.timer.Stop()\n\tsentCounts := t.counts\n\tsentStart := t.windowStart\n\tt.counts = map[string]*usageTelemetryCounts{}\n\tt.mu.Unlock()\n\n\tif usageTelemetryDisabled() {\n\t\treturn\n\t}\n\tevents := t.toEvents(sentCounts, sentStart, time.Since(sentStart))\n\terr := t.send(events)\n\tif err == nil || !usageTelemetryKeepAfter(err) {\n\t\treturn\n\t}\n\tt.mu.Lock()\n\tdefer t.mu.Unlock()\n\tif len(t.counts) == 0 {\n\t\tt.openWindow()\n\t}\n\tif sentStart.Before(t.windowStart) {\n\t\tt.windowStart = sentStart\n\t}\n\tfor operationID, sent := range sentCounts {\n\t\toperation := t.counts[operationID]\n\t\tif operation == nil {\n\t\t\tt.counts[operationID] = sent\n\t\t\tcontinue\n\t\t}\n\t\toperation.calls += sent.calls\n\t\toperation.attempts += sent.attempts\n\t\toperation.durationSumMs += sent.durationSumMs\n\t\tfor key, count := range sent.status {\n\t\t\toperation.status[key] += count\n\t\t}\n\t\tfor key, count := range sent.latency {\n\t\t\toperation.latency[key] += count\n\t\t}\n\t}\n}\n\nfunc usageTelemetryStatusClass(call SettledCall) string {\n\tif call.Response == nil {\n\t\tvar timeout *TimeoutError\n\t\t// The caller\'s own deadline is a timeout too, as a caller\'s AbortSignal.timeout() is in TypeScript.\n\t\tif errors.As(call.Err, &timeout) || errors.Is(call.Err, context.DeadlineExceeded) {\n\t\t\treturn "timeout"\n\t\t}\n\t\tif errors.Is(call.Err, context.Canceled) {\n\t\t\treturn "aborted"\n\t\t}\n\t\treturn "network_error"\n\t}\n\tstatus := call.Response.StatusCode\n\tswitch {\n\tcase status >= 500:\n\t\treturn "5xx"\n\tcase status >= 400:\n\t\treturn "4xx"\n\tcase status >= 300:\n\t\treturn "3xx"\n\t}\n\treturn "2xx"\n}\n\nfunc (t *UsageTelemetry) toEvents(counts map[string]*usageTelemetryCounts, windowStart time.Time, window time.Duration) []UsageTelemetryEvent {\n\tevents := []UsageTelemetryEvent{}\n\tfor operationID, operation := range counts {\n\t\tusage := map[string]any{\n\t\t\t"operation_id": operationID,\n\t\t\t"window_ms": window.Milliseconds(),\n\t\t\t"calls": operation.calls,\n\t\t\t"attempts": operation.attempts,\n\t\t\t"duration_sum_ms": operation.durationSumMs,\n\t\t}\n\t\tfor key, count := range operation.status {\n\t\t\tusage["status_"+key] = count\n\t\t}\n\t\tfor key, count := range operation.latency {\n\t\t\tusage["latency_"+key] = count\n\t\t}\n\t\tevents = append(events, UsageTelemetryEvent{\n\t\t\tID: "evt_" + usageTelemetryRandomHex(16),\n\t\t\tType: usageTelemetryEventType,\n\t\t\tSource: t.options.SDKName,\n\t\t\tTime: windowStart.UTC().Format("2006-01-02T15:04:05.000Z"),\n\t\t\tUsage: usage,\n\t\t\tSDK: t.sdk,\n\t\t})\n\t}\n\treturn events\n}\n\ntype usageTelemetryRejectedError struct {\n\tstatus int\n}\n\nfunc (e *usageTelemetryRejectedError) Error() string {\n\treturn fmt.Sprintf("the telemetry endpoint answered %d", e.status)\n}\n\nfunc (t *UsageTelemetry) send(events []UsageTelemetryEvent) error {\n\tif t.options.Sink != nil {\n\t\treturn t.options.Sink(events)\n\t}\n\tbody, err := json.Marshal(usageTelemetryOtlpRequest(events))\n\tif err != nil {\n\t\treturn err\n\t}\n\tctx, cancel := context.WithTimeout(context.Background(), usageTelemetrySendTimeout)\n\tdefer cancel()\n\treq, err := http.NewRequestWithContext(ctx, http.MethodPost, t.options.Endpoint, bytes.NewReader(body))\n\tif err != nil {\n\t\treturn err\n\t}\n\treq.Header.Set("Content-Type", "application/json")\n\t// One send per window, so the connection is never reused.\n\treq.Close = true\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\treturn err\n\t}\n\tresp.Body.Close()\n\tif resp.StatusCode < 200 || resp.StatusCode > 299 {\n\t\treturn &usageTelemetryRejectedError{status: resp.StatusCode}\n\t}\n\treturn nil\n}\n\nfunc usageTelemetryKeepAfter(err error) bool {\n\t// The endpoint can have stored the counts of a send that timed out.\n\tif errors.Is(err, context.DeadlineExceeded) {\n\t\treturn false\n\t}\n\tvar rejected *usageTelemetryRejectedError\n\tif errors.As(err, &rejected) {\n\t\treturn rejected.status == 408 || rejected.status == 429 || rejected.status >= 500\n\t}\n\treturn true\n}\n\nfunc usageTelemetryOtlpRequest(events []UsageTelemetryEvent) map[string]any {\n\tspans := []map[string]any{}\n\tfor _, event := range events {\n\t\teventTime, _ := time.Parse(time.RFC3339, event.Time)\n\t\ttimeUnixNano := strconv.FormatInt(eventTime.UnixMilli(), 10) + "000000"\n\t\tattributes := []map[string]any{\n\t\t\tusageTelemetryAttribute("cloudevents.event_id", event.ID),\n\t\t\tusageTelemetryAttribute("cloudevents.event_type", event.Type),\n\t\t\tusageTelemetryAttribute("cloudevents.event_source", event.Source),\n\t\t\tusageTelemetryAttribute("cloudevents.event_spec_version", "1.0"),\n\t\t\tusageTelemetryAttribute("cloudevents.event_data_content_type", "application/json; charset=utf-8"),\n\t\t\tusageTelemetryAttribute("cloudevents.event_time", event.Time),\n\t\t\tusageTelemetryAttribute("cloudevents.event_subject", ""),\n\t\t\tusageTelemetryAttribute("cloudevents.event_origin", usageTelemetryServiceName),\n\t\t\tusageTelemetryAttribute("cloudevents.event_object", "event"),\n\t\t\tusageTelemetryAttribute("cloudevents.event_category", "product"),\n\t\t\tusageTelemetryAttribute("cloudevents.event_signal", "metric"),\n\t\t}\n\t\tfor key, value := range event.Usage {\n\t\t\tattributes = append(attributes, usageTelemetryAttribute("cloudevents.event_data.usage."+key, value))\n\t\t}\n\t\tfor key, value := range event.SDK {\n\t\t\tattributes = append(attributes, usageTelemetryAttribute("cloudevents.event_data.sdk."+key, value))\n\t\t}\n\t\tspans = append(spans, map[string]any{\n\t\t\t"traceId": usageTelemetryRandomHex(16),\n\t\t\t"spanId": usageTelemetryRandomHex(8),\n\t\t\t"name": "event." + event.Type,\n\t\t\t"kind": 1,\n\t\t\t"startTimeUnixNano": timeUnixNano,\n\t\t\t"endTimeUnixNano": timeUnixNano,\n\t\t\t"attributes": attributes,\n\t\t})\n\t}\n\treturn map[string]any{\n\t\t"resourceSpans": []map[string]any{\n\t\t\t{\n\t\t\t\t"resource": map[string]any{\n\t\t\t\t\t"attributes": []map[string]any{\n\t\t\t\t\t\tusageTelemetryAttribute("service.name", usageTelemetryServiceName),\n\t\t\t\t\t\tusageTelemetryAttribute("service.version", usageTelemetryGeneratorVersion),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t"scopeSpans": []map[string]any{\n\t\t\t\t\t{"scope": map[string]any{"name": "redocly-sdk-telemetry"}, "spans": spans},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n}\n\nfunc usageTelemetryAttribute(key string, value any) map[string]any {\n\tswitch typed := value.(type) {\n\tcase int64:\n\t\treturn map[string]any{"key": key, "value": map[string]any{"intValue": typed}}\n\tcase string:\n\t\treturn map[string]any{"key": key, "value": map[string]any{"stringValue": typed}}\n\t}\n\treturn map[string]any{"key": key, "value": map[string]any{"stringValue": fmt.Sprint(value)}}\n}\n\nfunc usageTelemetryRandomHex(byteCount int) string {\n\tbuffer := make([]byte, byteCount)\n\trand.Read(buffer)\n\treturn hex.EncodeToString(buffer)\n}\n';
2
+ export const GO_TELEMETRY_SOURCE = '// Usage telemetry for a generated Go SDK, written beside the client by\n// `client.telemetry: on`. It counts calls per operation through the runtime\'s\n// OnSettled hook and sends one event per operation and window. An event holds\n// only the operation id, the counts, the window, and the SDK identity.\npackage client\n\nimport (\n\t"bytes"\n\t"context"\n\t"crypto/rand"\n\t"encoding/hex"\n\t"encoding/json"\n\t"errors"\n\t"fmt"\n\t"math"\n\t"net/http"\n\t"os"\n\t"runtime"\n\t"strconv"\n\t"strings"\n\t"sync"\n\t"time"\n)\n\nconst (\n\tusageTelemetryGeneratorVersion = "dev"\n\tusageTelemetryEndpoint = "https://otel.cloud.redocly.com/v1/traces"\n\tusageTelemetryEventType = "com.redocly.sdkUsage.aggregated"\n\tusageTelemetryServiceName = "redocly-sdk"\n\tusageTelemetrySendTimeout = 3 * time.Second\n\tusageTelemetrySDKURNPrefix = "urn:redocly:cli:sdk:go:"\n\tusageTelemetryCrockfordBase32 = "0123456789abcdefghjkmnpqrstvwxyz"\n)\n\n// usageTelemetryRegistered holds each UsageTelemetry that Register added.\nvar usageTelemetryRegistered []*UsageTelemetry\n\nvar usageTelemetryLatencyBuckets = []struct {\n\tname string\n\tbelowMs int64\n}{\n\t{"lt_100ms", 100},\n\t{"lt_300ms", 300},\n\t{"lt_1s", 1000},\n\t{"lt_3s", 3000},\n\t{"lt_10s", 10000},\n\t{"gte_10s", math.MaxInt64},\n}\n\n// UsageTelemetryOptions identifies the SDK. Endpoint defaults to the Redocly\n// OpenTelemetry endpoint and FlushInterval to one minute. Sink, when set,\n// receives the events instead of a send; an error it returns keeps the counts.\ntype UsageTelemetryOptions struct {\n\tSDKName string\n\tSDKVersion string\n\tClient string\n\tEndpoint string\n\tSink func(events []UsageTelemetryEvent) error\n\tFlushInterval time.Duration\n}\n\n// UsageTelemetryEvent is one com.redocly.sdkUsage.aggregated CloudEvent: the counts\n// of one operation in one window. Data holds the operation, then the SDK; their values\n// are strings or int64. Time is the window start in RFC 3339 with milliseconds. The\n// OpenTelemetry collector sets the env of the event. The json tags make a Sink that\n// marshals an event write the CloudEvent field names, as in the other languages.\ntype UsageTelemetryEvent struct {\n\tID string `json:"id"`\n\tObject string `json:"object"`\n\tSpecVersion string `json:"specversion"`\n\tDataContentType string `json:"datacontenttype"`\n\tType string `json:"type"`\n\tSource string `json:"source"`\n\tTime string `json:"time"`\n\tOrigin string `json:"origin"`\n\tCategory string `json:"category"`\n\tSignal string `json:"signal"`\n\tData []map[string]any `json:"data"`\n}\n\ntype usageTelemetryCounts struct {\n\tcalls int64\n\tattempts int64\n\tdurationSumMs int64\n\tstatus map[string]int64\n\tlatency map[string]int64\n}\n\n// UsageTelemetry counts the calls of every client whose Config.Middleware holds\n// its Middleware(). It is safe for concurrent use.\ntype UsageTelemetry struct {\n\toptions UsageTelemetryOptions\n\tsdk map[string]any\n\tmu sync.Mutex\n\tcounts map[string]*usageTelemetryCounts\n\twindowStart time.Time\n\ttimer *time.Timer\n\tsending sync.Mutex\n}\n\n// NewUsageTelemetry returns the counter. REDOCLY_SDK_TELEMETRY=off or\n// DO_NOT_TRACK=1 turns it off: Middleware then has no hooks.\nfunc NewUsageTelemetry(options UsageTelemetryOptions) *UsageTelemetry {\n\tif options.Endpoint == "" {\n\t\toptions.Endpoint = usageTelemetryEndpoint\n\t}\n\tif options.FlushInterval <= 0 {\n\t\toptions.FlushInterval = time.Minute\n\t}\n\treturn &UsageTelemetry{\n\t\toptions: options,\n\t\tsdk: map[string]any{\n\t\t\t"id": options.SDKName,\n\t\t\t"object": "sdk",\n\t\t\t"uri": usageTelemetrySDKURNPrefix + options.SDKName,\n\t\t\t"version": options.SDKVersion,\n\t\t\t"generator_version": usageTelemetryGeneratorVersion,\n\t\t\t"language": "go",\n\t\t\t"runtime": "go",\n\t\t\t"runtime_version": strings.TrimPrefix(runtime.Version(), "go"),\n\t\t\t"client": options.Client,\n\t\t},\n\t\tcounts: map[string]*usageTelemetryCounts{},\n\t}\n}\n\n// Middleware is the hook to add to Config.Middleware.\nfunc (t *UsageTelemetry) Middleware() Middleware {\n\tif usageTelemetryDisabled() {\n\t\treturn Middleware{}\n\t}\n\treturn Middleware{OnSettled: t.record}\n}\n\n// Register adds the middleware to every client of the package, also to a client created\n// before. Call it once, before the first call, for example in an init function.\nfunc (t *UsageTelemetry) Register() {\n\tregisteredMiddleware = append(registeredMiddleware, t.Middleware())\n\tusageTelemetryRegistered = append(usageTelemetryRegistered, t)\n}\n\n// FlushUsageTelemetry flushes every UsageTelemetry that Register added, as Flush does.\n// Go has no exit hook, so call it before the program ends.\nfunc FlushUsageTelemetry(ctx context.Context) error {\n\tfor _, telemetry := range usageTelemetryRegistered {\n\t\tif err := telemetry.Flush(ctx); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn nil\n}\n\n// Flush sends the open window and waits for the send, or for ctx.\n// Go has no exit hook, so call it before the program ends.\nfunc (t *UsageTelemetry) Flush(ctx context.Context) error {\n\tdone := make(chan struct{})\n\tgo func() {\n\t\tt.flushWindow()\n\t\tclose(done)\n\t}()\n\tselect {\n\tcase <-done:\n\t\treturn nil\n\tcase <-ctx.Done():\n\t\treturn ctx.Err()\n\t}\n}\n\nfunc usageTelemetryDisabled() bool {\n\treturn os.Getenv("REDOCLY_SDK_TELEMETRY") == "off" || os.Getenv("DO_NOT_TRACK") == "1"\n}\n\nfunc (t *UsageTelemetry) record(call SettledCall) {\n\tt.mu.Lock()\n\tdefer t.mu.Unlock()\n\tif len(t.counts) == 0 {\n\t\tt.openWindow()\n\t}\n\toperation := t.counts[call.OperationID]\n\tif operation == nil {\n\t\toperation = &usageTelemetryCounts{status: map[string]int64{}, latency: map[string]int64{}}\n\t\tt.counts[call.OperationID] = operation\n\t}\n\tdurationMs := call.Duration.Milliseconds()\n\toperation.calls++\n\toperation.attempts += int64(call.Attempts)\n\toperation.durationSumMs += durationMs\n\toperation.status[usageTelemetryStatusClass(call)]++\n\tfor _, bucket := range usageTelemetryLatencyBuckets {\n\t\tif durationMs < bucket.belowMs {\n\t\t\toperation.latency[bucket.name]++\n\t\t\tbreak\n\t\t}\n\t}\n}\n\n// openWindow must run with t.mu held.\nfunc (t *UsageTelemetry) openWindow() {\n\tt.windowStart = time.Now()\n\tt.timer = time.AfterFunc(t.options.FlushInterval, t.flushWindow)\n}\n\nfunc (t *UsageTelemetry) flushWindow() {\n\t// One send at a time, so Flush also waits for a send that the timer started.\n\tt.sending.Lock()\n\tdefer t.sending.Unlock()\n\tt.mu.Lock()\n\tif len(t.counts) == 0 {\n\t\tt.mu.Unlock()\n\t\treturn\n\t}\n\tt.timer.Stop()\n\tsentCounts := t.counts\n\tsentStart := t.windowStart\n\tt.counts = map[string]*usageTelemetryCounts{}\n\tt.mu.Unlock()\n\n\tif usageTelemetryDisabled() {\n\t\treturn\n\t}\n\tevents := t.toEvents(sentCounts, sentStart, time.Since(sentStart))\n\terr := t.send(events)\n\tif err == nil || !usageTelemetryKeepAfter(err) {\n\t\treturn\n\t}\n\tt.mu.Lock()\n\tdefer t.mu.Unlock()\n\tif len(t.counts) == 0 {\n\t\tt.openWindow()\n\t}\n\tif sentStart.Before(t.windowStart) {\n\t\tt.windowStart = sentStart\n\t}\n\tfor operationID, sent := range sentCounts {\n\t\toperation := t.counts[operationID]\n\t\tif operation == nil {\n\t\t\tt.counts[operationID] = sent\n\t\t\tcontinue\n\t\t}\n\t\toperation.calls += sent.calls\n\t\toperation.attempts += sent.attempts\n\t\toperation.durationSumMs += sent.durationSumMs\n\t\tfor key, count := range sent.status {\n\t\t\toperation.status[key] += count\n\t\t}\n\t\tfor key, count := range sent.latency {\n\t\t\toperation.latency[key] += count\n\t\t}\n\t}\n}\n\nfunc usageTelemetryStatusClass(call SettledCall) string {\n\tif call.Response == nil {\n\t\tvar timeout *TimeoutError\n\t\t// The caller\'s own deadline is a timeout too, as a caller\'s AbortSignal.timeout() is in TypeScript.\n\t\tif errors.As(call.Err, &timeout) || errors.Is(call.Err, context.DeadlineExceeded) {\n\t\t\treturn "timeout"\n\t\t}\n\t\tif errors.Is(call.Err, context.Canceled) {\n\t\t\treturn "aborted"\n\t\t}\n\t\treturn "network_error"\n\t}\n\tstatus := call.Response.StatusCode\n\tswitch {\n\tcase status >= 500:\n\t\treturn "5xx"\n\tcase status >= 400:\n\t\treturn "4xx"\n\tcase status >= 300:\n\t\treturn "3xx"\n\t}\n\treturn "2xx"\n}\n\nfunc (t *UsageTelemetry) toEvents(counts map[string]*usageTelemetryCounts, windowStart time.Time, window time.Duration) []UsageTelemetryEvent {\n\tevents := []UsageTelemetryEvent{}\n\tfor operationID, operation := range counts {\n\t\toperationItem := map[string]any{\n\t\t\t"id": operationID,\n\t\t\t"object": "operation",\n\t\t\t"uri": usageTelemetrySDKURNPrefix + t.options.SDKName + ":operation:" + operationID,\n\t\t\t"window_ms": window.Milliseconds(),\n\t\t\t"calls": operation.calls,\n\t\t\t"attempts": operation.attempts,\n\t\t\t"duration_sum_ms": operation.durationSumMs,\n\t\t}\n\t\tfor key, count := range operation.status {\n\t\t\toperationItem["status_"+key] = count\n\t\t}\n\t\tfor key, count := range operation.latency {\n\t\t\toperationItem["latency_"+key] = count\n\t\t}\n\t\tevents = append(events, UsageTelemetryEvent{\n\t\t\tID: usageTelemetryEventID(),\n\t\t\tObject: "event",\n\t\t\tSpecVersion: "1.0",\n\t\t\tDataContentType: "application/json; charset=utf-8",\n\t\t\tType: usageTelemetryEventType,\n\t\t\tSource: "urn:redocly:cli",\n\t\t\tTime: windowStart.UTC().Format("2006-01-02T15:04:05.000Z"),\n\t\t\tOrigin: "redocly-sdk",\n\t\t\tCategory: "product",\n\t\t\tSignal: "metric",\n\t\t\tData: []map[string]any{operationItem, t.sdk},\n\t\t})\n\t}\n\treturn events\n}\n\n// usageTelemetryEventID returns evt_ and a lowercase ULID: 10 characters of the time\n// in milliseconds, then 16 random characters.\nfunc usageTelemetryEventID() string {\n\tid := make([]byte, 26)\n\tmillis := time.Now().UnixMilli()\n\tfor index := 9; index >= 0; index-- {\n\t\tid[index] = usageTelemetryCrockfordBase32[millis%32]\n\t\tmillis /= 32\n\t}\n\trandom := make([]byte, 16)\n\trand.Read(random)\n\tfor index, value := range random {\n\t\tid[10+index] = usageTelemetryCrockfordBase32[value%32]\n\t}\n\treturn "evt_" + string(id)\n}\n\ntype usageTelemetryRejectedError struct {\n\tstatus int\n}\n\nfunc (e *usageTelemetryRejectedError) Error() string {\n\treturn fmt.Sprintf("the telemetry endpoint answered %d", e.status)\n}\n\nfunc (t *UsageTelemetry) send(events []UsageTelemetryEvent) error {\n\tif t.options.Sink != nil {\n\t\treturn t.options.Sink(events)\n\t}\n\tbody, err := json.Marshal(usageTelemetryOtlpRequest(events))\n\tif err != nil {\n\t\treturn err\n\t}\n\tctx, cancel := context.WithTimeout(context.Background(), usageTelemetrySendTimeout)\n\tdefer cancel()\n\treq, err := http.NewRequestWithContext(ctx, http.MethodPost, t.options.Endpoint, bytes.NewReader(body))\n\tif err != nil {\n\t\treturn err\n\t}\n\treq.Header.Set("Content-Type", "application/json")\n\t// One send per window, so the connection is never reused.\n\treq.Close = true\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\treturn err\n\t}\n\tresp.Body.Close()\n\tif resp.StatusCode < 200 || resp.StatusCode > 299 {\n\t\treturn &usageTelemetryRejectedError{status: resp.StatusCode}\n\t}\n\treturn nil\n}\n\nfunc usageTelemetryKeepAfter(err error) bool {\n\t// The endpoint can have stored the counts of a send that timed out.\n\tif errors.Is(err, context.DeadlineExceeded) {\n\t\treturn false\n\t}\n\tvar rejected *usageTelemetryRejectedError\n\tif errors.As(err, &rejected) {\n\t\treturn rejected.status == 408 || rejected.status == 429 || rejected.status >= 500\n\t}\n\treturn true\n}\n\nfunc usageTelemetryOtlpRequest(events []UsageTelemetryEvent) map[string]any {\n\tspans := []map[string]any{}\n\tfor _, event := range events {\n\t\teventTime, _ := time.Parse(time.RFC3339, event.Time)\n\t\ttimeUnixNano := strconv.FormatInt(eventTime.UnixMilli(), 10) + "000000"\n\t\t// The attributes that processCloudEventAttributes of @redocly/cli-otel gives for the event.\n\t\tattributes := []map[string]any{\n\t\t\tusageTelemetryAttribute("cloudevents.event_id", event.ID),\n\t\t\tusageTelemetryAttribute("cloudevents.event_type", event.Type),\n\t\t\tusageTelemetryAttribute("cloudevents.event_source", event.Source),\n\t\t\tusageTelemetryAttribute("cloudevents.event_spec_version", event.SpecVersion),\n\t\t\tusageTelemetryAttribute("cloudevents.event_data_content_type", event.DataContentType),\n\t\t\tusageTelemetryAttribute("cloudevents.event_time", event.Time),\n\t\t\tusageTelemetryAttribute("cloudevents.event_subject", event.Data[0]["id"]),\n\t\t\tusageTelemetryAttribute("cloudevents.event_origin", event.Origin),\n\t\t\tusageTelemetryAttribute("cloudevents.event_object", event.Object),\n\t\t\tusageTelemetryAttribute("cloudevents.event_category", event.Category),\n\t\t\tusageTelemetryAttribute("cloudevents.event_signal", event.Signal),\n\t\t\tusageTelemetryAttribute("cloudevents.event_request_id", ""),\n\t\t}\n\t\tfor _, item := range event.Data {\n\t\t\tfor key, value := range item {\n\t\t\t\tattributes = append(attributes, usageTelemetryAttribute(fmt.Sprintf("cloudevents.event_data.%s.%s", item["object"], key), value))\n\t\t\t}\n\t\t}\n\t\tfor _, item := range event.Data {\n\t\t\tfor _, key := range []string{"id", "object", "uri"} {\n\t\t\t\tattributes = append(attributes, usageTelemetryAttribute(fmt.Sprintf("cloudevents.event_subjects.%s.%s", item["object"], key), item[key]))\n\t\t\t}\n\t\t}\n\t\tspans = append(spans, map[string]any{\n\t\t\t"traceId": usageTelemetryRandomHex(16),\n\t\t\t"spanId": usageTelemetryRandomHex(8),\n\t\t\t"name": "event." + event.Type,\n\t\t\t"kind": 1,\n\t\t\t"startTimeUnixNano": timeUnixNano,\n\t\t\t"endTimeUnixNano": timeUnixNano,\n\t\t\t"attributes": attributes,\n\t\t})\n\t}\n\treturn map[string]any{\n\t\t"resourceSpans": []map[string]any{\n\t\t\t{\n\t\t\t\t"resource": map[string]any{\n\t\t\t\t\t"attributes": []map[string]any{\n\t\t\t\t\t\tusageTelemetryAttribute("service.name", usageTelemetryServiceName),\n\t\t\t\t\t\tusageTelemetryAttribute("service.version", usageTelemetryGeneratorVersion),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t"scopeSpans": []map[string]any{\n\t\t\t\t\t{"scope": map[string]any{"name": "redocly-sdk-telemetry"}, "spans": spans},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n}\n\nfunc usageTelemetryAttribute(key string, value any) map[string]any {\n\tswitch typed := value.(type) {\n\tcase int64:\n\t\treturn map[string]any{"key": key, "value": map[string]any{"intValue": typed}}\n\tcase string:\n\t\treturn map[string]any{"key": key, "value": map[string]any{"stringValue": typed}}\n\t}\n\treturn map[string]any{"key": key, "value": map[string]any{"stringValue": fmt.Sprint(value)}}\n}\n\nfunc usageTelemetryRandomHex(byteCount int) string {\n\tbuffer := make([]byte, byteCount)\n\trand.Read(buffer)\n\treturn hex.EncodeToString(buffer)\n}\n';
3
3
  export const GO_TELEMETRY_DECLARED_NAMES = [
4
4
  'UsageTelemetryOptions',
5
5
  'UsageTelemetryEvent',
@@ -1 +1 @@
1
- {"version":3,"file":"go-telemetry.js","sourceRoot":"","sources":["../../src/runtime-sources/go-telemetry.ts"],"names":[],"mappings":"AAAA,iKAAiK;AACjK,MAAM,CAAC,MAAM,mBAAmB,GAC9B,gwZAAgwZ,CAAC;AAEnwZ,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACzC,uBAAuB;IACvB,qBAAqB;IACrB,gBAAgB;IAChB,mBAAmB;IACnB,qBAAqB;CACb,CAAC"}
1
+ {"version":3,"file":"go-telemetry.js","sourceRoot":"","sources":["../../src/runtime-sources/go-telemetry.ts"],"names":[],"mappings":"AAAA,iKAAiK;AACjK,MAAM,CAAC,MAAM,mBAAmB,GAC9B,ygeAAyge,CAAC;AAE5ge,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACzC,uBAAuB;IACvB,qBAAqB;IACrB,gBAAgB;IAChB,mBAAmB;IACnB,qBAAqB;CACb,CAAC"}
@@ -1,3 +1,3 @@
1
- export declare const PHP_TELEMETRY_SOURCE = "<?php\n\n// Usage telemetry for a generated PHP SDK, written beside the client by\n// `client.telemetry: on`. It counts calls per operation through the runtime's\n// `onSettled` hook and sends one event per operation and window. An event holds\n// only the operation id, the counts, the window, and the SDK identity.\n\ndeclare(strict_types=1);\n\nnamespace RedoclyClientRuntime;\n\n/**\n * Register with `new Config(onSettled: [new UsageTelemetry(...)])`. PHP has no timers:\n * a call that finds its window elapsed sends that window first, in the calling request,\n * and a shutdown function sends the open windows. `sink`, when set, receives the events\n * instead of a send; an exception it throws keeps the counts.\n */\nfinal class UsageTelemetry\n{\n private const GENERATOR_VERSION = 'dev';\n private const DEFAULT_ENDPOINT = 'https://otel.cloud.redocly.com/v1/traces';\n private const EVENT_TYPE = 'com.redocly.sdkUsage.aggregated';\n private const SEND_TIMEOUT_MS = 3000;\n private const SERVICE_NAME = 'redocly-sdk';\n private const STATUS_CLASSES = ['2xx', '3xx', '4xx', '5xx', 'network_error', 'timeout', 'aborted'];\n private const LATENCY_BUCKETS = [\n 'lt_100ms' => 100,\n 'lt_300ms' => 300,\n 'lt_1s' => 1000,\n 'lt_3s' => 3000,\n 'lt_10s' => 10000,\n 'gte_10s' => PHP_INT_MAX,\n ];\n\n private bool $enabled;\n private array $sdk;\n private string $endpoint;\n private ?\\Closure $sink;\n /** @var array<int, self> The instances with an open window, by object id. */\n private static array $openWindows = [];\n private static bool $shutdownRegistered = false;\n /** @var array<int, self> The instances that `register` added. */\n private static array $registered = [];\n\n private array $counts = [];\n private float $windowStart = 0.0;\n private float $nextSendAt = 0.0;\n\n public function __construct(\n string $sdkName,\n string $sdkVersion,\n string $client,\n ?callable $sink = null,\n ?string $endpoint = null,\n private int $flushIntervalMs = 60_000,\n ) {\n $this->enabled = !self::disabled();\n $this->sdk = [\n 'name' => $sdkName,\n 'version' => $sdkVersion,\n 'generator_version' => self::GENERATOR_VERSION,\n 'language' => 'php',\n 'runtime' => 'php',\n 'runtime_version' => PHP_VERSION,\n 'client' => $client,\n ];\n $this->endpoint = $endpoint ?? self::DEFAULT_ENDPOINT;\n $this->sink = $sink === null ? null : \\Closure::fromCallable($sink);\n if ($this->enabled && !self::$shutdownRegistered) {\n self::$shutdownRegistered = true;\n // There is no later window at shutdown, so a failed send drops its counts.\n register_shutdown_function(static function (): void {\n foreach (self::$openWindows as $telemetry) {\n $telemetry->flushWindow(false);\n }\n });\n }\n }\n\n public function __invoke(array $call): void\n {\n if (!$this->enabled) {\n return;\n }\n $now = microtime(true);\n if ($this->counts !== [] && $now >= $this->nextSendAt) {\n $this->flushWindow(true);\n // The send can take up to SEND_TIMEOUT_MS, so the next window starts after it.\n $now = microtime(true);\n }\n if ($this->counts === []) {\n $this->windowStart = $now;\n $this->nextSendAt = $now + $this->flushIntervalMs / 1000;\n self::$openWindows[spl_object_id($this)] = $this;\n }\n $operationId = $call['operationId'];\n $operation = $this->counts[$operationId] ?? self::emptyCounts();\n $operation['calls'] += 1;\n $operation['attempts'] += $call['attempts'];\n $operation['durationSumMs'] += $call['durationMs'];\n $status = self::statusClass($call);\n $operation['status'][$status] = ($operation['status'][$status] ?? 0) + 1;\n foreach (self::LATENCY_BUCKETS as $bucket => $belowMs) {\n if ($call['durationMs'] < $belowMs) {\n $operation['latency'][$bucket] = ($operation['latency'][$bucket] ?? 0) + 1;\n break;\n }\n }\n $this->counts[$operationId] = $operation;\n }\n\n /** Send the open window now, for example before `exit` in a long-running worker. */\n public function flush(): void\n {\n $this->flushWindow(true);\n }\n\n /** Count the calls of every client of the namespace, also of a client created before. */\n public function register(): void\n {\n Config::$registeredOnSettled[] = $this;\n self::$registered[] = $this;\n }\n\n /** Flush every instance that `register` added, as `flush` does. */\n public static function flushRegistered(): void\n {\n foreach (self::$registered as $telemetry) {\n $telemetry->flush();\n }\n }\n\n private static function disabled(): bool\n {\n return getenv('REDOCLY_SDK_TELEMETRY') === 'off' || getenv('DO_NOT_TRACK') === '1';\n }\n\n private static function emptyCounts(): array\n {\n return ['calls' => 0, 'attempts' => 0, 'durationSumMs' => 0, 'status' => [], 'latency' => []];\n }\n\n private static function statusClass(array $call): string\n {\n if ($call['timedOut']) {\n return 'timeout';\n }\n $status = $call['status'];\n if ($status === 0) {\n return 'network_error';\n }\n if ($status >= 500) {\n return '5xx';\n }\n if ($status >= 400) {\n return '4xx';\n }\n if ($status >= 300) {\n return '3xx';\n }\n return '2xx';\n }\n\n private function flushWindow(bool $keepOnFailure): void\n {\n if ($this->counts === []) {\n return;\n }\n $sentCounts = $this->counts;\n $sentStart = $this->windowStart;\n $this->counts = [];\n unset(self::$openWindows[spl_object_id($this)]);\n if (self::disabled()) {\n return;\n }\n $events = $this->toEvents($sentCounts, $sentStart, microtime(true) - $sentStart);\n if ($this->deliver($events) !== 'keep' || !$keepOnFailure) {\n return;\n }\n // PHP is single-threaded, so no call was recorded during the send.\n $this->counts = $sentCounts;\n $this->windowStart = $sentStart;\n $this->nextSendAt = microtime(true) + $this->flushIntervalMs / 1000;\n self::$openWindows[spl_object_id($this)] = $this;\n }\n\n /** `sent`, or what to do with the counts after a failed send: `keep` or `drop`. */\n private function deliver(array $events): string\n {\n if ($this->sink !== null) {\n try {\n ($this->sink)($events);\n return 'sent';\n } catch (\\Throwable) {\n return 'keep';\n }\n }\n $handle = curl_init($this->endpoint);\n curl_setopt_array($handle, [\n CURLOPT_POST => true,\n CURLOPT_POSTFIELDS => json_encode(self::toOtlpRequest($events)),\n // One send per window, so the connection is never reused.\n CURLOPT_HTTPHEADER => ['Content-Type: application/json', 'Connection: close'],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT_MS => self::SEND_TIMEOUT_MS,\n ]);\n if (curl_exec($handle) === false) {\n // The endpoint can have stored the counts of a send that timed out.\n return curl_errno($handle) === CURLE_OPERATION_TIMEDOUT ? 'drop' : 'keep';\n }\n $status = (int) curl_getinfo($handle, CURLINFO_RESPONSE_CODE);\n if ($status >= 200 && $status < 300) {\n return 'sent';\n }\n return $status === 408 || $status === 429 || $status >= 500 ? 'keep' : 'drop';\n }\n\n private function toEvents(array $counts, float $windowStart, float $windowSeconds): array\n {\n $milliseconds = (int) (($windowStart - floor($windowStart)) * 1000);\n $time = gmdate('Y-m-d\\TH:i:s', (int) $windowStart) . sprintf('.%03dZ', $milliseconds);\n $events = [];\n foreach ($counts as $operationId => $operation) {\n $usage = [\n 'operation_id' => (string) $operationId,\n 'window_ms' => (int) ($windowSeconds * 1000),\n 'calls' => $operation['calls'],\n 'attempts' => $operation['attempts'],\n 'duration_sum_ms' => $operation['durationSumMs'],\n ];\n foreach (self::STATUS_CLASSES as $status) {\n if (isset($operation['status'][$status])) {\n $usage[\"status_{$status}\"] = $operation['status'][$status];\n }\n }\n foreach (array_keys(self::LATENCY_BUCKETS) as $bucket) {\n if (isset($operation['latency'][$bucket])) {\n $usage[\"latency_{$bucket}\"] = $operation['latency'][$bucket];\n }\n }\n $events[] = [\n 'id' => 'evt_' . bin2hex(random_bytes(16)),\n 'type' => self::EVENT_TYPE,\n 'source' => $this->sdk['name'],\n 'time' => $time,\n 'data' => ['usage' => $usage, 'sdk' => $this->sdk],\n ];\n }\n return $events;\n }\n\n private static function toOtlpRequest(array $events): array\n {\n $spans = [];\n foreach ($events as $event) {\n $started = \\DateTimeImmutable::createFromFormat('Y-m-d\\TH:i:s.v\\Z', $event['time'], new \\DateTimeZone('UTC'));\n $timeUnixNano = $started->format('Uv') . '000000';\n $attributes = [\n self::attribute('cloudevents.event_id', $event['id']),\n self::attribute('cloudevents.event_type', $event['type']),\n self::attribute('cloudevents.event_source', $event['source']),\n self::attribute('cloudevents.event_spec_version', '1.0'),\n self::attribute('cloudevents.event_data_content_type', 'application/json; charset=utf-8'),\n self::attribute('cloudevents.event_time', $event['time']),\n self::attribute('cloudevents.event_subject', ''),\n self::attribute('cloudevents.event_origin', self::SERVICE_NAME),\n self::attribute('cloudevents.event_object', 'event'),\n self::attribute('cloudevents.event_category', 'product'),\n self::attribute('cloudevents.event_signal', 'metric'),\n ];\n foreach ($event['data']['usage'] as $key => $value) {\n $attributes[] = self::attribute(\"cloudevents.event_data.usage.{$key}\", $value);\n }\n foreach ($event['data']['sdk'] as $key => $value) {\n $attributes[] = self::attribute(\"cloudevents.event_data.sdk.{$key}\", $value);\n }\n $spans[] = [\n 'traceId' => bin2hex(random_bytes(16)),\n 'spanId' => bin2hex(random_bytes(8)),\n 'name' => 'event.' . $event['type'],\n 'kind' => 1,\n 'startTimeUnixNano' => $timeUnixNano,\n 'endTimeUnixNano' => $timeUnixNano,\n 'attributes' => $attributes,\n ];\n }\n return [\n 'resourceSpans' => [\n [\n 'resource' => [\n 'attributes' => [\n self::attribute('service.name', self::SERVICE_NAME),\n self::attribute('service.version', self::GENERATOR_VERSION),\n ],\n ],\n 'scopeSpans' => [['scope' => ['name' => 'redocly-sdk-telemetry'], 'spans' => $spans]],\n ],\n ],\n ];\n }\n\n private static function attribute(string $key, string|int|float $value): array\n {\n if (is_string($value)) {\n return ['key' => $key, 'value' => ['stringValue' => $value]];\n }\n if (is_int($value)) {\n return ['key' => $key, 'value' => ['intValue' => $value]];\n }\n return ['key' => $key, 'value' => ['doubleValue' => $value]];\n }\n}\n";
1
+ export declare const PHP_TELEMETRY_SOURCE = "<?php\n\n// Usage telemetry for a generated PHP SDK, written beside the client by\n// `client.telemetry: on`. It counts calls per operation through the runtime's\n// `onSettled` hook and sends one event per operation and window. An event holds\n// only the operation id, the counts, the window, and the SDK identity.\n\ndeclare(strict_types=1);\n\nnamespace RedoclyClientRuntime;\n\n/**\n * Register with `new Config(onSettled: [new UsageTelemetry(...)])`. PHP has no timers:\n * a call that finds its window elapsed sends that window first, in the calling request,\n * and a shutdown function sends the open windows. `sink`, when set, receives the events\n * instead of a send; an exception it throws keeps the counts. Each event is a\n * `com.redocly.sdkUsage.aggregated` CloudEvent whose `data` holds the operation, then the SDK.\n * The OpenTelemetry collector sets its `env`.\n */\nfinal class UsageTelemetry\n{\n private const GENERATOR_VERSION = 'dev';\n private const DEFAULT_ENDPOINT = 'https://otel.cloud.redocly.com/v1/traces';\n private const EVENT_TYPE = 'com.redocly.sdkUsage.aggregated';\n private const SEND_TIMEOUT_MS = 3000;\n private const SERVICE_NAME = 'redocly-sdk';\n private const SDK_URN_PREFIX = 'urn:redocly:cli:sdk:php:';\n private const CROCKFORD_BASE32 = '0123456789abcdefghjkmnpqrstvwxyz';\n private const STATUS_CLASSES = ['2xx', '3xx', '4xx', '5xx', 'network_error', 'timeout', 'aborted'];\n private const LATENCY_BUCKETS = [\n 'lt_100ms' => 100,\n 'lt_300ms' => 300,\n 'lt_1s' => 1000,\n 'lt_3s' => 3000,\n 'lt_10s' => 10000,\n 'gte_10s' => PHP_INT_MAX,\n ];\n\n private bool $enabled;\n private array $sdk;\n private string $endpoint;\n private ?\\Closure $sink;\n /** @var array<int, self> The instances with an open window, by object id. */\n private static array $openWindows = [];\n private static bool $shutdownRegistered = false;\n /** @var array<int, self> The instances that `register` added. */\n private static array $registered = [];\n\n private array $counts = [];\n private float $windowStart = 0.0;\n private float $nextSendAt = 0.0;\n\n public function __construct(\n string $sdkName,\n string $sdkVersion,\n string $client,\n ?callable $sink = null,\n ?string $endpoint = null,\n private int $flushIntervalMs = 60_000,\n ) {\n $this->enabled = !self::disabled();\n $this->sdk = [\n 'id' => $sdkName,\n 'object' => 'sdk',\n 'uri' => self::SDK_URN_PREFIX . $sdkName,\n 'version' => $sdkVersion,\n 'generator_version' => self::GENERATOR_VERSION,\n 'language' => 'php',\n 'runtime' => 'php',\n 'runtime_version' => PHP_VERSION,\n 'client' => $client,\n ];\n $this->endpoint = $endpoint ?? self::DEFAULT_ENDPOINT;\n $this->sink = $sink === null ? null : \\Closure::fromCallable($sink);\n if ($this->enabled && !self::$shutdownRegistered) {\n self::$shutdownRegistered = true;\n // There is no later window at shutdown, so a failed send drops its counts.\n register_shutdown_function(static function (): void {\n foreach (self::$openWindows as $telemetry) {\n $telemetry->flushWindow(false);\n }\n });\n }\n }\n\n public function __invoke(array $call): void\n {\n if (!$this->enabled) {\n return;\n }\n $now = microtime(true);\n if ($this->counts !== [] && $now >= $this->nextSendAt) {\n $this->flushWindow(true);\n // The send can take up to SEND_TIMEOUT_MS, so the next window starts after it.\n $now = microtime(true);\n }\n if ($this->counts === []) {\n $this->windowStart = $now;\n $this->nextSendAt = $now + $this->flushIntervalMs / 1000;\n self::$openWindows[spl_object_id($this)] = $this;\n }\n $operationId = $call['operationId'];\n $operation = $this->counts[$operationId] ?? self::emptyCounts();\n $operation['calls'] += 1;\n $operation['attempts'] += $call['attempts'];\n $operation['durationSumMs'] += $call['durationMs'];\n $status = self::statusClass($call);\n $operation['status'][$status] = ($operation['status'][$status] ?? 0) + 1;\n foreach (self::LATENCY_BUCKETS as $bucket => $belowMs) {\n if ($call['durationMs'] < $belowMs) {\n $operation['latency'][$bucket] = ($operation['latency'][$bucket] ?? 0) + 1;\n break;\n }\n }\n $this->counts[$operationId] = $operation;\n }\n\n /** Send the open window now, for example before `exit` in a long-running worker. */\n public function flush(): void\n {\n $this->flushWindow(true);\n }\n\n /** Count the calls of every client of the namespace, also of a client created before. */\n public function register(): void\n {\n Config::$registeredOnSettled[] = $this;\n self::$registered[] = $this;\n }\n\n /** Flush every instance that `register` added, as `flush` does. */\n public static function flushRegistered(): void\n {\n foreach (self::$registered as $telemetry) {\n $telemetry->flush();\n }\n }\n\n private static function disabled(): bool\n {\n return getenv('REDOCLY_SDK_TELEMETRY') === 'off' || getenv('DO_NOT_TRACK') === '1';\n }\n\n private static function emptyCounts(): array\n {\n return ['calls' => 0, 'attempts' => 0, 'durationSumMs' => 0, 'status' => [], 'latency' => []];\n }\n\n private static function statusClass(array $call): string\n {\n if ($call['timedOut']) {\n return 'timeout';\n }\n $status = $call['status'];\n if ($status === 0) {\n return 'network_error';\n }\n if ($status >= 500) {\n return '5xx';\n }\n if ($status >= 400) {\n return '4xx';\n }\n if ($status >= 300) {\n return '3xx';\n }\n return '2xx';\n }\n\n private function flushWindow(bool $keepOnFailure): void\n {\n if ($this->counts === []) {\n return;\n }\n $sentCounts = $this->counts;\n $sentStart = $this->windowStart;\n $this->counts = [];\n unset(self::$openWindows[spl_object_id($this)]);\n if (self::disabled()) {\n return;\n }\n $events = $this->toEvents($sentCounts, $sentStart, microtime(true) - $sentStart);\n if ($this->deliver($events) !== 'keep' || !$keepOnFailure) {\n return;\n }\n // PHP is single-threaded, so no call was recorded during the send.\n $this->counts = $sentCounts;\n $this->windowStart = $sentStart;\n $this->nextSendAt = microtime(true) + $this->flushIntervalMs / 1000;\n self::$openWindows[spl_object_id($this)] = $this;\n }\n\n /** `sent`, or what to do with the counts after a failed send: `keep` or `drop`. */\n private function deliver(array $events): string\n {\n if ($this->sink !== null) {\n try {\n ($this->sink)($events);\n return 'sent';\n } catch (\\Throwable) {\n return 'keep';\n }\n }\n $handle = curl_init($this->endpoint);\n curl_setopt_array($handle, [\n CURLOPT_POST => true,\n CURLOPT_POSTFIELDS => json_encode(self::toOtlpRequest($events)),\n // One send per window, so the connection is never reused.\n CURLOPT_HTTPHEADER => ['Content-Type: application/json', 'Connection: close'],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT_MS => self::SEND_TIMEOUT_MS,\n ]);\n if (curl_exec($handle) === false) {\n // The endpoint can have stored the counts of a send that timed out.\n return curl_errno($handle) === CURLE_OPERATION_TIMEDOUT ? 'drop' : 'keep';\n }\n $status = (int) curl_getinfo($handle, CURLINFO_RESPONSE_CODE);\n if ($status >= 200 && $status < 300) {\n return 'sent';\n }\n return $status === 408 || $status === 429 || $status >= 500 ? 'keep' : 'drop';\n }\n\n private function toEvents(array $counts, float $windowStart, float $windowSeconds): array\n {\n $milliseconds = (int) (($windowStart - floor($windowStart)) * 1000);\n $time = gmdate('Y-m-d\\TH:i:s', (int) $windowStart) . sprintf('.%03dZ', $milliseconds);\n $events = [];\n foreach ($counts as $operationId => $operation) {\n $operationItem = [\n 'id' => (string) $operationId,\n 'object' => 'operation',\n 'uri' => $this->sdk['uri'] . ':operation:' . $operationId,\n 'window_ms' => (int) ($windowSeconds * 1000),\n 'calls' => $operation['calls'],\n 'attempts' => $operation['attempts'],\n 'duration_sum_ms' => $operation['durationSumMs'],\n ];\n foreach (self::STATUS_CLASSES as $status) {\n if (isset($operation['status'][$status])) {\n $operationItem[\"status_{$status}\"] = $operation['status'][$status];\n }\n }\n foreach (array_keys(self::LATENCY_BUCKETS) as $bucket) {\n if (isset($operation['latency'][$bucket])) {\n $operationItem[\"latency_{$bucket}\"] = $operation['latency'][$bucket];\n }\n }\n $events[] = [\n 'id' => self::eventId(),\n 'object' => 'event',\n 'specversion' => '1.0',\n 'datacontenttype' => 'application/json; charset=utf-8',\n 'type' => self::EVENT_TYPE,\n 'source' => 'urn:redocly:cli',\n 'time' => $time,\n 'origin' => 'redocly-sdk',\n 'category' => 'product',\n 'signal' => 'metric',\n 'data' => [$operationItem, $this->sdk],\n ];\n }\n return $events;\n }\n\n /** `evt_` and a lowercase ULID: 10 characters of the time in milliseconds, then 16 random ones. */\n private static function eventId(): string\n {\n $millis = (int) floor(microtime(true) * 1000);\n $id = '';\n for ($index = 0; $index < 10; $index++) {\n $id = self::CROCKFORD_BASE32[$millis % 32] . $id;\n $millis = intdiv($millis, 32);\n }\n foreach (str_split(random_bytes(16)) as $byte) {\n $id .= self::CROCKFORD_BASE32[ord($byte) % 32];\n }\n return 'evt_' . $id;\n }\n\n private static function toOtlpRequest(array $events): array\n {\n $spans = [];\n foreach ($events as $event) {\n $started = \\DateTimeImmutable::createFromFormat('Y-m-d\\TH:i:s.v\\Z', $event['time'], new \\DateTimeZone('UTC'));\n $timeUnixNano = $started->format('Uv') . '000000';\n // The attributes that processCloudEventAttributes of @redocly/cli-otel gives for the event.\n $attributes = [\n self::attribute('cloudevents.event_id', $event['id']),\n self::attribute('cloudevents.event_type', $event['type']),\n self::attribute('cloudevents.event_source', $event['source']),\n self::attribute('cloudevents.event_spec_version', $event['specversion']),\n self::attribute('cloudevents.event_data_content_type', $event['datacontenttype']),\n self::attribute('cloudevents.event_time', $event['time']),\n self::attribute('cloudevents.event_subject', $event['data'][0]['id']),\n self::attribute('cloudevents.event_origin', $event['origin']),\n self::attribute('cloudevents.event_object', $event['object']),\n self::attribute('cloudevents.event_category', $event['category']),\n self::attribute('cloudevents.event_signal', $event['signal']),\n self::attribute('cloudevents.event_request_id', ''),\n ];\n foreach ($event['data'] as $item) {\n foreach ($item as $key => $value) {\n $attributes[] = self::attribute(\"cloudevents.event_data.{$item['object']}.{$key}\", $value);\n }\n }\n foreach ($event['data'] as $item) {\n foreach (['id', 'object', 'uri'] as $key) {\n $attributes[] = self::attribute(\"cloudevents.event_subjects.{$item['object']}.{$key}\", $item[$key]);\n }\n }\n $spans[] = [\n 'traceId' => bin2hex(random_bytes(16)),\n 'spanId' => bin2hex(random_bytes(8)),\n 'name' => 'event.' . $event['type'],\n 'kind' => 1,\n 'startTimeUnixNano' => $timeUnixNano,\n 'endTimeUnixNano' => $timeUnixNano,\n 'attributes' => $attributes,\n ];\n }\n return [\n 'resourceSpans' => [\n [\n 'resource' => [\n 'attributes' => [\n self::attribute('service.name', self::SERVICE_NAME),\n self::attribute('service.version', self::GENERATOR_VERSION),\n ],\n ],\n 'scopeSpans' => [['scope' => ['name' => 'redocly-sdk-telemetry'], 'spans' => $spans]],\n ],\n ],\n ];\n }\n\n private static function attribute(string $key, string|int|float $value): array\n {\n if (is_string($value)) {\n return ['key' => $key, 'value' => ['stringValue' => $value]];\n }\n if (is_int($value)) {\n return ['key' => $key, 'value' => ['intValue' => $value]];\n }\n return ['key' => $key, 'value' => ['doubleValue' => $value]];\n }\n}\n";
2
2
  export declare const PHP_TELEMETRY_DECLARED_NAMES: readonly ["UsageTelemetry"];
3
3
  //# sourceMappingURL=php-telemetry.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"php-telemetry.d.ts","sourceRoot":"","sources":["../../src/runtime-sources/php-telemetry.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,oBAAoB,gwYAC8tY,CAAC;AAEhwY,eAAO,MAAM,4BAA4B,6BAA8B,CAAC"}
1
+ {"version":3,"file":"php-telemetry.d.ts","sourceRoot":"","sources":["../../src/runtime-sources/php-telemetry.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,oBAAoB,27bACy5b,CAAC;AAE37b,eAAO,MAAM,4BAA4B,6BAA8B,CAAC"}
@@ -1,4 +1,4 @@
1
1
  // GENERATED by scripts/generate-runtime-sources.mjs — do not edit. Regenerated on install (`prepare`); manually: `npm run prepare -w @redocly/client-generator`.
2
- export const PHP_TELEMETRY_SOURCE = "<?php\n\n// Usage telemetry for a generated PHP SDK, written beside the client by\n// `client.telemetry: on`. It counts calls per operation through the runtime's\n// `onSettled` hook and sends one event per operation and window. An event holds\n// only the operation id, the counts, the window, and the SDK identity.\n\ndeclare(strict_types=1);\n\nnamespace RedoclyClientRuntime;\n\n/**\n * Register with `new Config(onSettled: [new UsageTelemetry(...)])`. PHP has no timers:\n * a call that finds its window elapsed sends that window first, in the calling request,\n * and a shutdown function sends the open windows. `sink`, when set, receives the events\n * instead of a send; an exception it throws keeps the counts.\n */\nfinal class UsageTelemetry\n{\n private const GENERATOR_VERSION = 'dev';\n private const DEFAULT_ENDPOINT = 'https://otel.cloud.redocly.com/v1/traces';\n private const EVENT_TYPE = 'com.redocly.sdkUsage.aggregated';\n private const SEND_TIMEOUT_MS = 3000;\n private const SERVICE_NAME = 'redocly-sdk';\n private const STATUS_CLASSES = ['2xx', '3xx', '4xx', '5xx', 'network_error', 'timeout', 'aborted'];\n private const LATENCY_BUCKETS = [\n 'lt_100ms' => 100,\n 'lt_300ms' => 300,\n 'lt_1s' => 1000,\n 'lt_3s' => 3000,\n 'lt_10s' => 10000,\n 'gte_10s' => PHP_INT_MAX,\n ];\n\n private bool $enabled;\n private array $sdk;\n private string $endpoint;\n private ?\\Closure $sink;\n /** @var array<int, self> The instances with an open window, by object id. */\n private static array $openWindows = [];\n private static bool $shutdownRegistered = false;\n /** @var array<int, self> The instances that `register` added. */\n private static array $registered = [];\n\n private array $counts = [];\n private float $windowStart = 0.0;\n private float $nextSendAt = 0.0;\n\n public function __construct(\n string $sdkName,\n string $sdkVersion,\n string $client,\n ?callable $sink = null,\n ?string $endpoint = null,\n private int $flushIntervalMs = 60_000,\n ) {\n $this->enabled = !self::disabled();\n $this->sdk = [\n 'name' => $sdkName,\n 'version' => $sdkVersion,\n 'generator_version' => self::GENERATOR_VERSION,\n 'language' => 'php',\n 'runtime' => 'php',\n 'runtime_version' => PHP_VERSION,\n 'client' => $client,\n ];\n $this->endpoint = $endpoint ?? self::DEFAULT_ENDPOINT;\n $this->sink = $sink === null ? null : \\Closure::fromCallable($sink);\n if ($this->enabled && !self::$shutdownRegistered) {\n self::$shutdownRegistered = true;\n // There is no later window at shutdown, so a failed send drops its counts.\n register_shutdown_function(static function (): void {\n foreach (self::$openWindows as $telemetry) {\n $telemetry->flushWindow(false);\n }\n });\n }\n }\n\n public function __invoke(array $call): void\n {\n if (!$this->enabled) {\n return;\n }\n $now = microtime(true);\n if ($this->counts !== [] && $now >= $this->nextSendAt) {\n $this->flushWindow(true);\n // The send can take up to SEND_TIMEOUT_MS, so the next window starts after it.\n $now = microtime(true);\n }\n if ($this->counts === []) {\n $this->windowStart = $now;\n $this->nextSendAt = $now + $this->flushIntervalMs / 1000;\n self::$openWindows[spl_object_id($this)] = $this;\n }\n $operationId = $call['operationId'];\n $operation = $this->counts[$operationId] ?? self::emptyCounts();\n $operation['calls'] += 1;\n $operation['attempts'] += $call['attempts'];\n $operation['durationSumMs'] += $call['durationMs'];\n $status = self::statusClass($call);\n $operation['status'][$status] = ($operation['status'][$status] ?? 0) + 1;\n foreach (self::LATENCY_BUCKETS as $bucket => $belowMs) {\n if ($call['durationMs'] < $belowMs) {\n $operation['latency'][$bucket] = ($operation['latency'][$bucket] ?? 0) + 1;\n break;\n }\n }\n $this->counts[$operationId] = $operation;\n }\n\n /** Send the open window now, for example before `exit` in a long-running worker. */\n public function flush(): void\n {\n $this->flushWindow(true);\n }\n\n /** Count the calls of every client of the namespace, also of a client created before. */\n public function register(): void\n {\n Config::$registeredOnSettled[] = $this;\n self::$registered[] = $this;\n }\n\n /** Flush every instance that `register` added, as `flush` does. */\n public static function flushRegistered(): void\n {\n foreach (self::$registered as $telemetry) {\n $telemetry->flush();\n }\n }\n\n private static function disabled(): bool\n {\n return getenv('REDOCLY_SDK_TELEMETRY') === 'off' || getenv('DO_NOT_TRACK') === '1';\n }\n\n private static function emptyCounts(): array\n {\n return ['calls' => 0, 'attempts' => 0, 'durationSumMs' => 0, 'status' => [], 'latency' => []];\n }\n\n private static function statusClass(array $call): string\n {\n if ($call['timedOut']) {\n return 'timeout';\n }\n $status = $call['status'];\n if ($status === 0) {\n return 'network_error';\n }\n if ($status >= 500) {\n return '5xx';\n }\n if ($status >= 400) {\n return '4xx';\n }\n if ($status >= 300) {\n return '3xx';\n }\n return '2xx';\n }\n\n private function flushWindow(bool $keepOnFailure): void\n {\n if ($this->counts === []) {\n return;\n }\n $sentCounts = $this->counts;\n $sentStart = $this->windowStart;\n $this->counts = [];\n unset(self::$openWindows[spl_object_id($this)]);\n if (self::disabled()) {\n return;\n }\n $events = $this->toEvents($sentCounts, $sentStart, microtime(true) - $sentStart);\n if ($this->deliver($events) !== 'keep' || !$keepOnFailure) {\n return;\n }\n // PHP is single-threaded, so no call was recorded during the send.\n $this->counts = $sentCounts;\n $this->windowStart = $sentStart;\n $this->nextSendAt = microtime(true) + $this->flushIntervalMs / 1000;\n self::$openWindows[spl_object_id($this)] = $this;\n }\n\n /** `sent`, or what to do with the counts after a failed send: `keep` or `drop`. */\n private function deliver(array $events): string\n {\n if ($this->sink !== null) {\n try {\n ($this->sink)($events);\n return 'sent';\n } catch (\\Throwable) {\n return 'keep';\n }\n }\n $handle = curl_init($this->endpoint);\n curl_setopt_array($handle, [\n CURLOPT_POST => true,\n CURLOPT_POSTFIELDS => json_encode(self::toOtlpRequest($events)),\n // One send per window, so the connection is never reused.\n CURLOPT_HTTPHEADER => ['Content-Type: application/json', 'Connection: close'],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT_MS => self::SEND_TIMEOUT_MS,\n ]);\n if (curl_exec($handle) === false) {\n // The endpoint can have stored the counts of a send that timed out.\n return curl_errno($handle) === CURLE_OPERATION_TIMEDOUT ? 'drop' : 'keep';\n }\n $status = (int) curl_getinfo($handle, CURLINFO_RESPONSE_CODE);\n if ($status >= 200 && $status < 300) {\n return 'sent';\n }\n return $status === 408 || $status === 429 || $status >= 500 ? 'keep' : 'drop';\n }\n\n private function toEvents(array $counts, float $windowStart, float $windowSeconds): array\n {\n $milliseconds = (int) (($windowStart - floor($windowStart)) * 1000);\n $time = gmdate('Y-m-d\\TH:i:s', (int) $windowStart) . sprintf('.%03dZ', $milliseconds);\n $events = [];\n foreach ($counts as $operationId => $operation) {\n $usage = [\n 'operation_id' => (string) $operationId,\n 'window_ms' => (int) ($windowSeconds * 1000),\n 'calls' => $operation['calls'],\n 'attempts' => $operation['attempts'],\n 'duration_sum_ms' => $operation['durationSumMs'],\n ];\n foreach (self::STATUS_CLASSES as $status) {\n if (isset($operation['status'][$status])) {\n $usage[\"status_{$status}\"] = $operation['status'][$status];\n }\n }\n foreach (array_keys(self::LATENCY_BUCKETS) as $bucket) {\n if (isset($operation['latency'][$bucket])) {\n $usage[\"latency_{$bucket}\"] = $operation['latency'][$bucket];\n }\n }\n $events[] = [\n 'id' => 'evt_' . bin2hex(random_bytes(16)),\n 'type' => self::EVENT_TYPE,\n 'source' => $this->sdk['name'],\n 'time' => $time,\n 'data' => ['usage' => $usage, 'sdk' => $this->sdk],\n ];\n }\n return $events;\n }\n\n private static function toOtlpRequest(array $events): array\n {\n $spans = [];\n foreach ($events as $event) {\n $started = \\DateTimeImmutable::createFromFormat('Y-m-d\\TH:i:s.v\\Z', $event['time'], new \\DateTimeZone('UTC'));\n $timeUnixNano = $started->format('Uv') . '000000';\n $attributes = [\n self::attribute('cloudevents.event_id', $event['id']),\n self::attribute('cloudevents.event_type', $event['type']),\n self::attribute('cloudevents.event_source', $event['source']),\n self::attribute('cloudevents.event_spec_version', '1.0'),\n self::attribute('cloudevents.event_data_content_type', 'application/json; charset=utf-8'),\n self::attribute('cloudevents.event_time', $event['time']),\n self::attribute('cloudevents.event_subject', ''),\n self::attribute('cloudevents.event_origin', self::SERVICE_NAME),\n self::attribute('cloudevents.event_object', 'event'),\n self::attribute('cloudevents.event_category', 'product'),\n self::attribute('cloudevents.event_signal', 'metric'),\n ];\n foreach ($event['data']['usage'] as $key => $value) {\n $attributes[] = self::attribute(\"cloudevents.event_data.usage.{$key}\", $value);\n }\n foreach ($event['data']['sdk'] as $key => $value) {\n $attributes[] = self::attribute(\"cloudevents.event_data.sdk.{$key}\", $value);\n }\n $spans[] = [\n 'traceId' => bin2hex(random_bytes(16)),\n 'spanId' => bin2hex(random_bytes(8)),\n 'name' => 'event.' . $event['type'],\n 'kind' => 1,\n 'startTimeUnixNano' => $timeUnixNano,\n 'endTimeUnixNano' => $timeUnixNano,\n 'attributes' => $attributes,\n ];\n }\n return [\n 'resourceSpans' => [\n [\n 'resource' => [\n 'attributes' => [\n self::attribute('service.name', self::SERVICE_NAME),\n self::attribute('service.version', self::GENERATOR_VERSION),\n ],\n ],\n 'scopeSpans' => [['scope' => ['name' => 'redocly-sdk-telemetry'], 'spans' => $spans]],\n ],\n ],\n ];\n }\n\n private static function attribute(string $key, string|int|float $value): array\n {\n if (is_string($value)) {\n return ['key' => $key, 'value' => ['stringValue' => $value]];\n }\n if (is_int($value)) {\n return ['key' => $key, 'value' => ['intValue' => $value]];\n }\n return ['key' => $key, 'value' => ['doubleValue' => $value]];\n }\n}\n";
2
+ export const PHP_TELEMETRY_SOURCE = "<?php\n\n// Usage telemetry for a generated PHP SDK, written beside the client by\n// `client.telemetry: on`. It counts calls per operation through the runtime's\n// `onSettled` hook and sends one event per operation and window. An event holds\n// only the operation id, the counts, the window, and the SDK identity.\n\ndeclare(strict_types=1);\n\nnamespace RedoclyClientRuntime;\n\n/**\n * Register with `new Config(onSettled: [new UsageTelemetry(...)])`. PHP has no timers:\n * a call that finds its window elapsed sends that window first, in the calling request,\n * and a shutdown function sends the open windows. `sink`, when set, receives the events\n * instead of a send; an exception it throws keeps the counts. Each event is a\n * `com.redocly.sdkUsage.aggregated` CloudEvent whose `data` holds the operation, then the SDK.\n * The OpenTelemetry collector sets its `env`.\n */\nfinal class UsageTelemetry\n{\n private const GENERATOR_VERSION = 'dev';\n private const DEFAULT_ENDPOINT = 'https://otel.cloud.redocly.com/v1/traces';\n private const EVENT_TYPE = 'com.redocly.sdkUsage.aggregated';\n private const SEND_TIMEOUT_MS = 3000;\n private const SERVICE_NAME = 'redocly-sdk';\n private const SDK_URN_PREFIX = 'urn:redocly:cli:sdk:php:';\n private const CROCKFORD_BASE32 = '0123456789abcdefghjkmnpqrstvwxyz';\n private const STATUS_CLASSES = ['2xx', '3xx', '4xx', '5xx', 'network_error', 'timeout', 'aborted'];\n private const LATENCY_BUCKETS = [\n 'lt_100ms' => 100,\n 'lt_300ms' => 300,\n 'lt_1s' => 1000,\n 'lt_3s' => 3000,\n 'lt_10s' => 10000,\n 'gte_10s' => PHP_INT_MAX,\n ];\n\n private bool $enabled;\n private array $sdk;\n private string $endpoint;\n private ?\\Closure $sink;\n /** @var array<int, self> The instances with an open window, by object id. */\n private static array $openWindows = [];\n private static bool $shutdownRegistered = false;\n /** @var array<int, self> The instances that `register` added. */\n private static array $registered = [];\n\n private array $counts = [];\n private float $windowStart = 0.0;\n private float $nextSendAt = 0.0;\n\n public function __construct(\n string $sdkName,\n string $sdkVersion,\n string $client,\n ?callable $sink = null,\n ?string $endpoint = null,\n private int $flushIntervalMs = 60_000,\n ) {\n $this->enabled = !self::disabled();\n $this->sdk = [\n 'id' => $sdkName,\n 'object' => 'sdk',\n 'uri' => self::SDK_URN_PREFIX . $sdkName,\n 'version' => $sdkVersion,\n 'generator_version' => self::GENERATOR_VERSION,\n 'language' => 'php',\n 'runtime' => 'php',\n 'runtime_version' => PHP_VERSION,\n 'client' => $client,\n ];\n $this->endpoint = $endpoint ?? self::DEFAULT_ENDPOINT;\n $this->sink = $sink === null ? null : \\Closure::fromCallable($sink);\n if ($this->enabled && !self::$shutdownRegistered) {\n self::$shutdownRegistered = true;\n // There is no later window at shutdown, so a failed send drops its counts.\n register_shutdown_function(static function (): void {\n foreach (self::$openWindows as $telemetry) {\n $telemetry->flushWindow(false);\n }\n });\n }\n }\n\n public function __invoke(array $call): void\n {\n if (!$this->enabled) {\n return;\n }\n $now = microtime(true);\n if ($this->counts !== [] && $now >= $this->nextSendAt) {\n $this->flushWindow(true);\n // The send can take up to SEND_TIMEOUT_MS, so the next window starts after it.\n $now = microtime(true);\n }\n if ($this->counts === []) {\n $this->windowStart = $now;\n $this->nextSendAt = $now + $this->flushIntervalMs / 1000;\n self::$openWindows[spl_object_id($this)] = $this;\n }\n $operationId = $call['operationId'];\n $operation = $this->counts[$operationId] ?? self::emptyCounts();\n $operation['calls'] += 1;\n $operation['attempts'] += $call['attempts'];\n $operation['durationSumMs'] += $call['durationMs'];\n $status = self::statusClass($call);\n $operation['status'][$status] = ($operation['status'][$status] ?? 0) + 1;\n foreach (self::LATENCY_BUCKETS as $bucket => $belowMs) {\n if ($call['durationMs'] < $belowMs) {\n $operation['latency'][$bucket] = ($operation['latency'][$bucket] ?? 0) + 1;\n break;\n }\n }\n $this->counts[$operationId] = $operation;\n }\n\n /** Send the open window now, for example before `exit` in a long-running worker. */\n public function flush(): void\n {\n $this->flushWindow(true);\n }\n\n /** Count the calls of every client of the namespace, also of a client created before. */\n public function register(): void\n {\n Config::$registeredOnSettled[] = $this;\n self::$registered[] = $this;\n }\n\n /** Flush every instance that `register` added, as `flush` does. */\n public static function flushRegistered(): void\n {\n foreach (self::$registered as $telemetry) {\n $telemetry->flush();\n }\n }\n\n private static function disabled(): bool\n {\n return getenv('REDOCLY_SDK_TELEMETRY') === 'off' || getenv('DO_NOT_TRACK') === '1';\n }\n\n private static function emptyCounts(): array\n {\n return ['calls' => 0, 'attempts' => 0, 'durationSumMs' => 0, 'status' => [], 'latency' => []];\n }\n\n private static function statusClass(array $call): string\n {\n if ($call['timedOut']) {\n return 'timeout';\n }\n $status = $call['status'];\n if ($status === 0) {\n return 'network_error';\n }\n if ($status >= 500) {\n return '5xx';\n }\n if ($status >= 400) {\n return '4xx';\n }\n if ($status >= 300) {\n return '3xx';\n }\n return '2xx';\n }\n\n private function flushWindow(bool $keepOnFailure): void\n {\n if ($this->counts === []) {\n return;\n }\n $sentCounts = $this->counts;\n $sentStart = $this->windowStart;\n $this->counts = [];\n unset(self::$openWindows[spl_object_id($this)]);\n if (self::disabled()) {\n return;\n }\n $events = $this->toEvents($sentCounts, $sentStart, microtime(true) - $sentStart);\n if ($this->deliver($events) !== 'keep' || !$keepOnFailure) {\n return;\n }\n // PHP is single-threaded, so no call was recorded during the send.\n $this->counts = $sentCounts;\n $this->windowStart = $sentStart;\n $this->nextSendAt = microtime(true) + $this->flushIntervalMs / 1000;\n self::$openWindows[spl_object_id($this)] = $this;\n }\n\n /** `sent`, or what to do with the counts after a failed send: `keep` or `drop`. */\n private function deliver(array $events): string\n {\n if ($this->sink !== null) {\n try {\n ($this->sink)($events);\n return 'sent';\n } catch (\\Throwable) {\n return 'keep';\n }\n }\n $handle = curl_init($this->endpoint);\n curl_setopt_array($handle, [\n CURLOPT_POST => true,\n CURLOPT_POSTFIELDS => json_encode(self::toOtlpRequest($events)),\n // One send per window, so the connection is never reused.\n CURLOPT_HTTPHEADER => ['Content-Type: application/json', 'Connection: close'],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT_MS => self::SEND_TIMEOUT_MS,\n ]);\n if (curl_exec($handle) === false) {\n // The endpoint can have stored the counts of a send that timed out.\n return curl_errno($handle) === CURLE_OPERATION_TIMEDOUT ? 'drop' : 'keep';\n }\n $status = (int) curl_getinfo($handle, CURLINFO_RESPONSE_CODE);\n if ($status >= 200 && $status < 300) {\n return 'sent';\n }\n return $status === 408 || $status === 429 || $status >= 500 ? 'keep' : 'drop';\n }\n\n private function toEvents(array $counts, float $windowStart, float $windowSeconds): array\n {\n $milliseconds = (int) (($windowStart - floor($windowStart)) * 1000);\n $time = gmdate('Y-m-d\\TH:i:s', (int) $windowStart) . sprintf('.%03dZ', $milliseconds);\n $events = [];\n foreach ($counts as $operationId => $operation) {\n $operationItem = [\n 'id' => (string) $operationId,\n 'object' => 'operation',\n 'uri' => $this->sdk['uri'] . ':operation:' . $operationId,\n 'window_ms' => (int) ($windowSeconds * 1000),\n 'calls' => $operation['calls'],\n 'attempts' => $operation['attempts'],\n 'duration_sum_ms' => $operation['durationSumMs'],\n ];\n foreach (self::STATUS_CLASSES as $status) {\n if (isset($operation['status'][$status])) {\n $operationItem[\"status_{$status}\"] = $operation['status'][$status];\n }\n }\n foreach (array_keys(self::LATENCY_BUCKETS) as $bucket) {\n if (isset($operation['latency'][$bucket])) {\n $operationItem[\"latency_{$bucket}\"] = $operation['latency'][$bucket];\n }\n }\n $events[] = [\n 'id' => self::eventId(),\n 'object' => 'event',\n 'specversion' => '1.0',\n 'datacontenttype' => 'application/json; charset=utf-8',\n 'type' => self::EVENT_TYPE,\n 'source' => 'urn:redocly:cli',\n 'time' => $time,\n 'origin' => 'redocly-sdk',\n 'category' => 'product',\n 'signal' => 'metric',\n 'data' => [$operationItem, $this->sdk],\n ];\n }\n return $events;\n }\n\n /** `evt_` and a lowercase ULID: 10 characters of the time in milliseconds, then 16 random ones. */\n private static function eventId(): string\n {\n $millis = (int) floor(microtime(true) * 1000);\n $id = '';\n for ($index = 0; $index < 10; $index++) {\n $id = self::CROCKFORD_BASE32[$millis % 32] . $id;\n $millis = intdiv($millis, 32);\n }\n foreach (str_split(random_bytes(16)) as $byte) {\n $id .= self::CROCKFORD_BASE32[ord($byte) % 32];\n }\n return 'evt_' . $id;\n }\n\n private static function toOtlpRequest(array $events): array\n {\n $spans = [];\n foreach ($events as $event) {\n $started = \\DateTimeImmutable::createFromFormat('Y-m-d\\TH:i:s.v\\Z', $event['time'], new \\DateTimeZone('UTC'));\n $timeUnixNano = $started->format('Uv') . '000000';\n // The attributes that processCloudEventAttributes of @redocly/cli-otel gives for the event.\n $attributes = [\n self::attribute('cloudevents.event_id', $event['id']),\n self::attribute('cloudevents.event_type', $event['type']),\n self::attribute('cloudevents.event_source', $event['source']),\n self::attribute('cloudevents.event_spec_version', $event['specversion']),\n self::attribute('cloudevents.event_data_content_type', $event['datacontenttype']),\n self::attribute('cloudevents.event_time', $event['time']),\n self::attribute('cloudevents.event_subject', $event['data'][0]['id']),\n self::attribute('cloudevents.event_origin', $event['origin']),\n self::attribute('cloudevents.event_object', $event['object']),\n self::attribute('cloudevents.event_category', $event['category']),\n self::attribute('cloudevents.event_signal', $event['signal']),\n self::attribute('cloudevents.event_request_id', ''),\n ];\n foreach ($event['data'] as $item) {\n foreach ($item as $key => $value) {\n $attributes[] = self::attribute(\"cloudevents.event_data.{$item['object']}.{$key}\", $value);\n }\n }\n foreach ($event['data'] as $item) {\n foreach (['id', 'object', 'uri'] as $key) {\n $attributes[] = self::attribute(\"cloudevents.event_subjects.{$item['object']}.{$key}\", $item[$key]);\n }\n }\n $spans[] = [\n 'traceId' => bin2hex(random_bytes(16)),\n 'spanId' => bin2hex(random_bytes(8)),\n 'name' => 'event.' . $event['type'],\n 'kind' => 1,\n 'startTimeUnixNano' => $timeUnixNano,\n 'endTimeUnixNano' => $timeUnixNano,\n 'attributes' => $attributes,\n ];\n }\n return [\n 'resourceSpans' => [\n [\n 'resource' => [\n 'attributes' => [\n self::attribute('service.name', self::SERVICE_NAME),\n self::attribute('service.version', self::GENERATOR_VERSION),\n ],\n ],\n 'scopeSpans' => [['scope' => ['name' => 'redocly-sdk-telemetry'], 'spans' => $spans]],\n ],\n ],\n ];\n }\n\n private static function attribute(string $key, string|int|float $value): array\n {\n if (is_string($value)) {\n return ['key' => $key, 'value' => ['stringValue' => $value]];\n }\n if (is_int($value)) {\n return ['key' => $key, 'value' => ['intValue' => $value]];\n }\n return ['key' => $key, 'value' => ['doubleValue' => $value]];\n }\n}\n";
3
3
  export const PHP_TELEMETRY_DECLARED_NAMES = ['UsageTelemetry'];
4
4
  //# sourceMappingURL=php-telemetry.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"php-telemetry.js","sourceRoot":"","sources":["../../src/runtime-sources/php-telemetry.ts"],"names":[],"mappings":"AAAA,iKAAiK;AACjK,MAAM,CAAC,MAAM,oBAAoB,GAC/B,6vYAA6vY,CAAC;AAEhwY,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,gBAAgB,CAAU,CAAC"}
1
+ {"version":3,"file":"php-telemetry.js","sourceRoot":"","sources":["../../src/runtime-sources/php-telemetry.ts"],"names":[],"mappings":"AAAA,iKAAiK;AACjK,MAAM,CAAC,MAAM,oBAAoB,GAC/B,w7bAAw7b,CAAC;AAE37b,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,gBAAgB,CAAU,CAAC"}
@@ -1,2 +1,2 @@
1
- export declare const PYTHON_TELEMETRY_SOURCE = "# Usage telemetry for a generated Python SDK, written beside the client by\n# `client.telemetry: on`. It counts calls per operation through the runtime's\n# on_settled hook and sends one event per operation and window. An event holds\n# only the operation id, the counts, the window, and the SDK identity.\nfrom __future__ import annotations\n\nimport asyncio\nimport atexit\nimport json\nimport math\nimport os\nimport platform\nimport secrets\nimport threading\nimport time\nfrom datetime import datetime, timezone\nfrom typing import Any, Callable, Dict, List, Optional, Set\n\nimport httpx\n\nGENERATOR_VERSION = \"dev\"\n_DEFAULT_ENDPOINT = \"https://otel.cloud.redocly.com/v1/traces\"\n_EVENT_TYPE = \"com.redocly.sdkUsage.aggregated\"\n_SEND_TIMEOUT_S = 3.0\n_SERVICE_NAME = \"redocly-sdk\"\n_STATUS_CLASSES = [\"2xx\", \"3xx\", \"4xx\", \"5xx\", \"network_error\", \"timeout\", \"aborted\"]\n_LATENCY_BUCKETS = [\n (\"lt_100ms\", 100),\n (\"lt_300ms\", 300),\n (\"lt_1s\", 1000),\n (\"lt_3s\", 3000),\n (\"lt_10s\", 10000),\n (\"gte_10s\", math.inf),\n]\n\nSdkUsageEvent = Dict[str, Any]\nSink = Callable[[List[SdkUsageEvent]], None]\n\n\nclass _RejectedSend(Exception):\n def __init__(self, status: int) -> None:\n super().__init__(f\"The telemetry endpoint answered {status}.\")\n self.status = status\n\n\ndef _disabled() -> bool:\n return os.environ.get(\"REDOCLY_SDK_TELEMETRY\") == \"off\" or os.environ.get(\"DO_NOT_TRACK\") == \"1\"\n\n\ndef _empty_counts() -> Dict[str, Any]:\n return {\"calls\": 0, \"attempts\": 0, \"duration_sum_ms\": 0, \"status\": {}, \"latency\": {}}\n\n\nclass UsageTelemetry:\n \"\"\"The middleware that `telemetry()` returns. Safe to share across threads and clients.\"\"\"\n\n def __init__(self, sdk: Dict[str, str], sink: Sink, flush_interval_ms: int, enabled: bool) -> None:\n self._enabled = enabled\n self._sdk = sdk\n self._sink = sink\n self._interval_s = flush_interval_ms / 1000\n self._lock = threading.Lock()\n self._counts: Dict[str, Dict[str, Any]] = {}\n self._window_start = 0.0\n self._timer: Optional[threading.Timer] = None\n\n def on_settled(self, context: Dict[str, Any], call: Dict[str, Any]) -> None:\n if not self._enabled:\n return\n with self._lock:\n if not self._counts:\n self._open_window()\n operation = self._counts.setdefault(context[\"operation\"][\"id\"], _empty_counts())\n duration_ms: int = call[\"duration_ms\"]\n operation[\"calls\"] += 1\n operation[\"attempts\"] += call[\"attempts\"]\n operation[\"duration_sum_ms\"] += duration_ms\n status = _status_class(call)\n operation[\"status\"][status] = operation[\"status\"].get(status, 0) + 1\n for bucket, below_ms in _LATENCY_BUCKETS:\n if duration_ms < below_ms:\n operation[\"latency\"][bucket] = operation[\"latency\"].get(bucket, 0) + 1\n break\n\n def flush(self, keep_on_failure: bool = True) -> None:\n timer = self._timer\n self._flush_window(keep_on_failure)\n # A timer that already fired may still be sending its window.\n if timer is not None:\n timer.join(_SEND_TIMEOUT_S + 1)\n\n def _open_window(self) -> None:\n self._window_start = time.time()\n self._timer = threading.Timer(self._interval_s, self._flush_window)\n self._timer.daemon = True\n self._timer.start()\n with _open_windows_lock:\n _open_windows.add(self)\n\n def _flush_window(self, keep_on_failure: bool = True) -> None:\n with self._lock:\n if not self._counts:\n return\n if self._timer is not None:\n self._timer.cancel()\n sent_counts = self._counts\n sent_start = self._window_start\n self._counts = {}\n try:\n if not _disabled():\n self._sink(_to_events(sent_counts, sent_start, time.time() - sent_start, self._sdk))\n except Exception as error:\n if keep_on_failure and _keep_after(error):\n with self._lock:\n if not self._counts:\n self._open_window()\n self._window_start = min(self._window_start, sent_start)\n for operation_id, sent in sent_counts.items():\n operation = self._counts.setdefault(operation_id, _empty_counts())\n for key in (\"calls\", \"attempts\", \"duration_sum_ms\"):\n operation[key] += sent[key]\n for group in (\"status\", \"latency\"):\n for key, count in sent[group].items():\n operation[group][key] = operation[group].get(key, 0) + count\n with self._lock:\n # A call during the send can open the next window.\n if not self._counts:\n with _open_windows_lock:\n _open_windows.discard(self)\n\n\n# The instances with an open window or a send in progress.\n_open_windows: Set[UsageTelemetry] = set()\n_open_windows_lock = threading.Lock()\n\n\ndef _open_windows_now() -> List[UsageTelemetry]:\n with _open_windows_lock:\n return list(_open_windows)\n\n\ndef telemetry(\n *,\n sdk_name: str,\n sdk_version: str,\n client: str,\n sink: Optional[Sink] = None,\n endpoint: Optional[str] = None,\n flush_interval_ms: int = 60_000,\n) -> UsageTelemetry:\n \"\"\"The usage telemetry middleware. REDOCLY_SDK_TELEMETRY=off or DO_NOT_TRACK=1 makes it record nothing.\"\"\"\n target = endpoint or _DEFAULT_ENDPOINT\n sdk = {\n \"name\": sdk_name,\n \"version\": sdk_version,\n \"generator_version\": GENERATOR_VERSION,\n \"language\": \"python\",\n \"runtime\": platform.python_implementation().lower(),\n \"runtime_version\": platform.python_version(),\n \"client\": client,\n }\n enabled = not _disabled()\n return UsageTelemetry(sdk, sink or (lambda events: _send_otlp(target, events)), flush_interval_ms, enabled)\n\n\ndef flush() -> None:\n \"\"\"Send every open window now and wait for the sends, for example before os._exit().\"\"\"\n for instance in _open_windows_now():\n instance.flush()\n\n\n@atexit.register\ndef _flush_at_exit() -> None:\n # There is no later window at exit, so a failed send drops its counts.\n for instance in _open_windows_now():\n instance.flush(keep_on_failure=False)\n\n\ndef _status_class(call: Dict[str, Any]) -> str:\n response: Optional[httpx.Response] = call.get(\"response\")\n if response is None:\n error = call.get(\"error\")\n # The runtime's own timeout error, matched by name: this module imports nothing from the client.\n if type(error).__name__ == \"ApiTimeoutError\":\n return \"timeout\"\n if isinstance(error, asyncio.CancelledError):\n return \"aborted\"\n return \"network_error\"\n if response.status_code >= 500:\n return \"5xx\"\n if response.status_code >= 400:\n return \"4xx\"\n if response.status_code >= 300:\n return \"3xx\"\n return \"2xx\"\n\n\ndef _keep_after(error: Exception) -> bool:\n # The endpoint can have stored the counts of a send that timed out.\n if isinstance(error, httpx.TimeoutException):\n return False\n if isinstance(error, _RejectedSend):\n return error.status in (408, 429) or error.status >= 500\n return True\n\n\ndef _to_events(\n counts: Dict[str, Dict[str, Any]], window_start: float, window_s: float, sdk: Dict[str, str]\n) -> List[SdkUsageEvent]:\n started = datetime.fromtimestamp(window_start, tz=timezone.utc)\n events: List[SdkUsageEvent] = []\n for operation_id, operation in counts.items():\n usage: Dict[str, Any] = {\n \"operation_id\": operation_id,\n \"window_ms\": int(window_s * 1000),\n \"calls\": operation[\"calls\"],\n \"attempts\": operation[\"attempts\"],\n \"duration_sum_ms\": operation[\"duration_sum_ms\"],\n }\n for status in _STATUS_CLASSES:\n if status in operation[\"status\"]:\n usage[f\"status_{status}\"] = operation[\"status\"][status]\n for bucket, _ in _LATENCY_BUCKETS:\n if bucket in operation[\"latency\"]:\n usage[f\"latency_{bucket}\"] = operation[\"latency\"][bucket]\n events.append(\n {\n \"id\": f\"evt_{secrets.token_hex(16)}\",\n \"type\": _EVENT_TYPE,\n \"source\": sdk[\"name\"],\n \"time\": started.isoformat(timespec=\"milliseconds\").replace(\"+00:00\", \"Z\"),\n \"data\": {\"usage\": usage, \"sdk\": sdk},\n }\n )\n return events\n\n\ndef _send_otlp(endpoint: str, events: List[SdkUsageEvent]) -> None:\n response = httpx.post(\n endpoint,\n content=json.dumps(_to_otlp_request(events)),\n # One send per window, so the connection is never reused.\n headers={\"Content-Type\": \"application/json\", \"Connection\": \"close\"},\n timeout=_SEND_TIMEOUT_S,\n )\n if not response.is_success:\n raise _RejectedSend(response.status_code)\n\n\ndef _to_otlp_request(events: List[SdkUsageEvent]) -> Dict[str, Any]:\n spans: List[Dict[str, Any]] = []\n for event in events:\n started = datetime.fromisoformat(event[\"time\"].replace(\"Z\", \"+00:00\"))\n time_unix_nano = f\"{int(started.timestamp() * 1000)}000000\"\n attributes = [\n _attribute(\"cloudevents.event_id\", event[\"id\"]),\n _attribute(\"cloudevents.event_type\", event[\"type\"]),\n _attribute(\"cloudevents.event_source\", event[\"source\"]),\n _attribute(\"cloudevents.event_spec_version\", \"1.0\"),\n _attribute(\"cloudevents.event_data_content_type\", \"application/json; charset=utf-8\"),\n _attribute(\"cloudevents.event_time\", event[\"time\"]),\n _attribute(\"cloudevents.event_subject\", \"\"),\n _attribute(\"cloudevents.event_origin\", _SERVICE_NAME),\n _attribute(\"cloudevents.event_object\", \"event\"),\n _attribute(\"cloudevents.event_category\", \"product\"),\n _attribute(\"cloudevents.event_signal\", \"metric\"),\n ]\n for key, value in event[\"data\"][\"usage\"].items():\n attributes.append(_attribute(f\"cloudevents.event_data.usage.{key}\", value))\n for key, value in event[\"data\"][\"sdk\"].items():\n attributes.append(_attribute(f\"cloudevents.event_data.sdk.{key}\", value))\n spans.append(\n {\n \"traceId\": secrets.token_hex(16),\n \"spanId\": secrets.token_hex(8),\n \"name\": f\"event.{event['type']}\",\n \"kind\": 1,\n \"startTimeUnixNano\": time_unix_nano,\n \"endTimeUnixNano\": time_unix_nano,\n \"attributes\": attributes,\n }\n )\n return {\n \"resourceSpans\": [\n {\n \"resource\": {\n \"attributes\": [\n _attribute(\"service.name\", _SERVICE_NAME),\n _attribute(\"service.version\", GENERATOR_VERSION),\n ]\n },\n \"scopeSpans\": [{\"scope\": {\"name\": \"redocly-sdk-telemetry\"}, \"spans\": spans}],\n }\n ]\n }\n\n\ndef _attribute(key: str, value: Any) -> Dict[str, Any]:\n if isinstance(value, str):\n return {\"key\": key, \"value\": {\"stringValue\": value}}\n if isinstance(value, int):\n return {\"key\": key, \"value\": {\"intValue\": value}}\n return {\"key\": key, \"value\": {\"doubleValue\": value}}\n";
1
+ export declare const PYTHON_TELEMETRY_SOURCE = "# Usage telemetry for a generated Python SDK, written beside the client by\n# `client.telemetry: on`. It counts calls per operation through the runtime's\n# on_settled hook and sends one event per operation and window. An event holds\n# only the operation id, the counts, the window, and the SDK identity.\nfrom __future__ import annotations\n\nimport asyncio\nimport atexit\nimport json\nimport math\nimport os\nimport platform\nimport secrets\nimport threading\nimport time\nfrom datetime import datetime, timezone\nfrom typing import Any, Callable, Dict, List, Optional, Set\n\nimport httpx\n\nGENERATOR_VERSION = \"dev\"\n_DEFAULT_ENDPOINT = \"https://otel.cloud.redocly.com/v1/traces\"\n_EVENT_TYPE = \"com.redocly.sdkUsage.aggregated\"\n_SEND_TIMEOUT_S = 3.0\n_SERVICE_NAME = \"redocly-sdk\"\n_SDK_URN_PREFIX = \"urn:redocly:cli:sdk:python:\"\n_CROCKFORD_BASE32 = \"0123456789abcdefghjkmnpqrstvwxyz\"\n_STATUS_CLASSES = [\"2xx\", \"3xx\", \"4xx\", \"5xx\", \"network_error\", \"timeout\", \"aborted\"]\n_LATENCY_BUCKETS = [\n (\"lt_100ms\", 100),\n (\"lt_300ms\", 300),\n (\"lt_1s\", 1000),\n (\"lt_3s\", 3000),\n (\"lt_10s\", 10000),\n (\"gte_10s\", math.inf),\n]\n\n# A com.redocly.sdkUsage.aggregated CloudEvent. Its \"data\" holds the operation, then the SDK.\n# The OpenTelemetry collector sets the \"env\" of the event.\nSdkUsageEvent = Dict[str, Any]\nSink = Callable[[List[SdkUsageEvent]], None]\n\n\nclass _RejectedSend(Exception):\n def __init__(self, status: int) -> None:\n super().__init__(f\"The telemetry endpoint answered {status}.\")\n self.status = status\n\n\ndef _disabled() -> bool:\n return os.environ.get(\"REDOCLY_SDK_TELEMETRY\") == \"off\" or os.environ.get(\"DO_NOT_TRACK\") == \"1\"\n\n\ndef _empty_counts() -> Dict[str, Any]:\n return {\"calls\": 0, \"attempts\": 0, \"duration_sum_ms\": 0, \"status\": {}, \"latency\": {}}\n\n\nclass UsageTelemetry:\n \"\"\"The middleware that `telemetry()` returns. Safe to share across threads and clients.\"\"\"\n\n def __init__(self, sdk: Dict[str, Any], sink: Sink, flush_interval_ms: int, enabled: bool) -> None:\n self._enabled = enabled\n self._sdk = sdk\n self._sink = sink\n self._interval_s = flush_interval_ms / 1000\n self._lock = threading.Lock()\n self._counts: Dict[str, Dict[str, Any]] = {}\n self._window_start = 0.0\n self._timer: Optional[threading.Timer] = None\n\n def on_settled(self, context: Dict[str, Any], call: Dict[str, Any]) -> None:\n if not self._enabled:\n return\n with self._lock:\n if not self._counts:\n self._open_window()\n operation = self._counts.setdefault(context[\"operation\"][\"id\"], _empty_counts())\n duration_ms: int = call[\"duration_ms\"]\n operation[\"calls\"] += 1\n operation[\"attempts\"] += call[\"attempts\"]\n operation[\"duration_sum_ms\"] += duration_ms\n status = _status_class(call)\n operation[\"status\"][status] = operation[\"status\"].get(status, 0) + 1\n for bucket, below_ms in _LATENCY_BUCKETS:\n if duration_ms < below_ms:\n operation[\"latency\"][bucket] = operation[\"latency\"].get(bucket, 0) + 1\n break\n\n def flush(self, keep_on_failure: bool = True) -> None:\n timer = self._timer\n self._flush_window(keep_on_failure)\n # A timer that already fired may still be sending its window.\n if timer is not None:\n timer.join(_SEND_TIMEOUT_S + 1)\n\n def _open_window(self) -> None:\n self._window_start = time.time()\n self._timer = threading.Timer(self._interval_s, self._flush_window)\n self._timer.daemon = True\n self._timer.start()\n with _open_windows_lock:\n _open_windows.add(self)\n\n def _flush_window(self, keep_on_failure: bool = True) -> None:\n with self._lock:\n if not self._counts:\n return\n if self._timer is not None:\n self._timer.cancel()\n sent_counts = self._counts\n sent_start = self._window_start\n self._counts = {}\n try:\n if not _disabled():\n self._sink(_to_events(sent_counts, sent_start, time.time() - sent_start, self._sdk))\n except Exception as error:\n if keep_on_failure and _keep_after(error):\n with self._lock:\n if not self._counts:\n self._open_window()\n self._window_start = min(self._window_start, sent_start)\n for operation_id, sent in sent_counts.items():\n operation = self._counts.setdefault(operation_id, _empty_counts())\n for key in (\"calls\", \"attempts\", \"duration_sum_ms\"):\n operation[key] += sent[key]\n for group in (\"status\", \"latency\"):\n for key, count in sent[group].items():\n operation[group][key] = operation[group].get(key, 0) + count\n with self._lock:\n # A call during the send can open the next window.\n if not self._counts:\n with _open_windows_lock:\n _open_windows.discard(self)\n\n\n# The instances with an open window or a send in progress.\n_open_windows: Set[UsageTelemetry] = set()\n_open_windows_lock = threading.Lock()\n\n\ndef _open_windows_now() -> List[UsageTelemetry]:\n with _open_windows_lock:\n return list(_open_windows)\n\n\ndef telemetry(\n *,\n sdk_name: str,\n sdk_version: str,\n client: str,\n sink: Optional[Sink] = None,\n endpoint: Optional[str] = None,\n flush_interval_ms: int = 60_000,\n) -> UsageTelemetry:\n \"\"\"The usage telemetry middleware. REDOCLY_SDK_TELEMETRY=off or DO_NOT_TRACK=1 makes it record nothing.\"\"\"\n target = endpoint or _DEFAULT_ENDPOINT\n sdk: Dict[str, Any] = {\n \"id\": sdk_name,\n \"object\": \"sdk\",\n \"uri\": f\"{_SDK_URN_PREFIX}{sdk_name}\",\n \"version\": sdk_version,\n \"generator_version\": GENERATOR_VERSION,\n \"language\": \"python\",\n \"runtime\": platform.python_implementation().lower(),\n \"runtime_version\": platform.python_version(),\n \"client\": client,\n }\n enabled = not _disabled()\n return UsageTelemetry(sdk, sink or (lambda events: _send_otlp(target, events)), flush_interval_ms, enabled)\n\n\ndef flush() -> None:\n \"\"\"Send every open window now and wait for the sends, for example before os._exit().\"\"\"\n for instance in _open_windows_now():\n instance.flush()\n\n\n@atexit.register\ndef _flush_at_exit() -> None:\n # There is no later window at exit, so a failed send drops its counts.\n for instance in _open_windows_now():\n instance.flush(keep_on_failure=False)\n\n\ndef _status_class(call: Dict[str, Any]) -> str:\n response: Optional[httpx.Response] = call.get(\"response\")\n if response is None:\n error = call.get(\"error\")\n # The runtime's own timeout error, matched by name: this module imports nothing from the client.\n if type(error).__name__ == \"ApiTimeoutError\":\n return \"timeout\"\n if isinstance(error, asyncio.CancelledError):\n return \"aborted\"\n return \"network_error\"\n if response.status_code >= 500:\n return \"5xx\"\n if response.status_code >= 400:\n return \"4xx\"\n if response.status_code >= 300:\n return \"3xx\"\n return \"2xx\"\n\n\ndef _keep_after(error: Exception) -> bool:\n # The endpoint can have stored the counts of a send that timed out.\n if isinstance(error, httpx.TimeoutException):\n return False\n if isinstance(error, _RejectedSend):\n return error.status in (408, 429) or error.status >= 500\n return True\n\n\ndef _to_events(\n counts: Dict[str, Dict[str, Any]], window_start: float, window_s: float, sdk: Dict[str, Any]\n) -> List[SdkUsageEvent]:\n started = datetime.fromtimestamp(window_start, tz=timezone.utc)\n events: List[SdkUsageEvent] = []\n for operation_id, operation in counts.items():\n operation_item: Dict[str, Any] = {\n \"id\": operation_id,\n \"object\": \"operation\",\n \"uri\": f\"{sdk['uri']}:operation:{operation_id}\",\n \"window_ms\": int(window_s * 1000),\n \"calls\": operation[\"calls\"],\n \"attempts\": operation[\"attempts\"],\n \"duration_sum_ms\": operation[\"duration_sum_ms\"],\n }\n for status in _STATUS_CLASSES:\n if status in operation[\"status\"]:\n operation_item[f\"status_{status}\"] = operation[\"status\"][status]\n for bucket, _ in _LATENCY_BUCKETS:\n if bucket in operation[\"latency\"]:\n operation_item[f\"latency_{bucket}\"] = operation[\"latency\"][bucket]\n events.append(\n {\n \"id\": _event_id(),\n \"object\": \"event\",\n \"specversion\": \"1.0\",\n \"datacontenttype\": \"application/json; charset=utf-8\",\n \"type\": _EVENT_TYPE,\n \"source\": \"urn:redocly:cli\",\n \"time\": started.isoformat(timespec=\"milliseconds\").replace(\"+00:00\", \"Z\"),\n \"origin\": \"redocly-sdk\",\n \"category\": \"product\",\n \"signal\": \"metric\",\n \"data\": [operation_item, sdk],\n }\n )\n return events\n\n\ndef _event_id() -> str:\n \"\"\"evt_ and a lowercase ULID: 10 characters of the time in milliseconds, then 16 random ones.\"\"\"\n millis = time.time_ns() // 1_000_000\n time_part = \"\"\n for _ in range(10):\n time_part = _CROCKFORD_BASE32[millis % 32] + time_part\n millis //= 32\n random_part = \"\"\n for byte in secrets.token_bytes(16):\n random_part += _CROCKFORD_BASE32[byte % 32]\n return f\"evt_{time_part}{random_part}\"\n\n\ndef _send_otlp(endpoint: str, events: List[SdkUsageEvent]) -> None:\n response = httpx.post(\n endpoint,\n content=json.dumps(_to_otlp_request(events)),\n # One send per window, so the connection is never reused.\n headers={\"Content-Type\": \"application/json\", \"Connection\": \"close\"},\n timeout=_SEND_TIMEOUT_S,\n )\n if not response.is_success:\n raise _RejectedSend(response.status_code)\n\n\ndef _to_otlp_request(events: List[SdkUsageEvent]) -> Dict[str, Any]:\n spans: List[Dict[str, Any]] = []\n for event in events:\n started = datetime.fromisoformat(event[\"time\"].replace(\"Z\", \"+00:00\"))\n time_unix_nano = f\"{int(started.timestamp() * 1000)}000000\"\n # The attributes that processCloudEventAttributes of @redocly/cli-otel gives for the event.\n attributes = [\n _attribute(\"cloudevents.event_id\", event[\"id\"]),\n _attribute(\"cloudevents.event_type\", event[\"type\"]),\n _attribute(\"cloudevents.event_source\", event[\"source\"]),\n _attribute(\"cloudevents.event_spec_version\", event[\"specversion\"]),\n _attribute(\"cloudevents.event_data_content_type\", event[\"datacontenttype\"]),\n _attribute(\"cloudevents.event_time\", event[\"time\"]),\n _attribute(\"cloudevents.event_subject\", event[\"data\"][0][\"id\"]),\n _attribute(\"cloudevents.event_origin\", event[\"origin\"]),\n _attribute(\"cloudevents.event_object\", event[\"object\"]),\n _attribute(\"cloudevents.event_category\", event[\"category\"]),\n _attribute(\"cloudevents.event_signal\", event[\"signal\"]),\n _attribute(\"cloudevents.event_request_id\", \"\"),\n ]\n for item in event[\"data\"]:\n for key, value in item.items():\n attributes.append(_attribute(f\"cloudevents.event_data.{item['object']}.{key}\", value))\n for item in event[\"data\"]:\n for key in (\"id\", \"object\", \"uri\"):\n attributes.append(_attribute(f\"cloudevents.event_subjects.{item['object']}.{key}\", item[key]))\n spans.append(\n {\n \"traceId\": secrets.token_hex(16),\n \"spanId\": secrets.token_hex(8),\n \"name\": f\"event.{event['type']}\",\n \"kind\": 1,\n \"startTimeUnixNano\": time_unix_nano,\n \"endTimeUnixNano\": time_unix_nano,\n \"attributes\": attributes,\n }\n )\n return {\n \"resourceSpans\": [\n {\n \"resource\": {\n \"attributes\": [\n _attribute(\"service.name\", _SERVICE_NAME),\n _attribute(\"service.version\", GENERATOR_VERSION),\n ]\n },\n \"scopeSpans\": [{\"scope\": {\"name\": \"redocly-sdk-telemetry\"}, \"spans\": spans}],\n }\n ]\n }\n\n\ndef _attribute(key: str, value: Any) -> Dict[str, Any]:\n if isinstance(value, str):\n return {\"key\": key, \"value\": {\"stringValue\": value}}\n if isinstance(value, int):\n return {\"key\": key, \"value\": {\"intValue\": value}}\n return {\"key\": key, \"value\": {\"doubleValue\": value}}\n";
2
2
  //# sourceMappingURL=python-telemetry.d.ts.map