@dxos/observability 0.8.4-main.c4373fc → 0.8.4-main.c85a9c8dae

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 (311) hide show
  1. package/README.md +14 -11
  2. package/dist/lib/browser/chunk-J5LGTIGS.mjs +10 -0
  3. package/dist/lib/browser/chunk-K4VFBKST.mjs +13 -0
  4. package/dist/lib/browser/chunk-K4VFBKST.mjs.map +7 -0
  5. package/dist/lib/browser/index.mjs +1005 -34
  6. package/dist/lib/browser/index.mjs.map +4 -4
  7. package/dist/lib/browser/log-processor-FDLTDQEM.mjs +45 -0
  8. package/dist/lib/browser/log-processor-FDLTDQEM.mjs.map +7 -0
  9. package/dist/lib/browser/logs-ATTRIUTL.mjs +113 -0
  10. package/dist/lib/browser/logs-ATTRIUTL.mjs.map +7 -0
  11. package/dist/lib/browser/meta.json +1 -1
  12. package/dist/lib/browser/metrics-PKTV6IGF.mjs +130 -0
  13. package/dist/lib/browser/metrics-PKTV6IGF.mjs.map +7 -0
  14. package/dist/lib/browser/traces-browser-5DQUYGQ7.mjs +68 -0
  15. package/dist/lib/browser/traces-browser-5DQUYGQ7.mjs.map +7 -0
  16. package/dist/lib/node-esm/chunk-FEVP3MK4.mjs +15 -0
  17. package/dist/lib/node-esm/chunk-FEVP3MK4.mjs.map +7 -0
  18. package/dist/lib/node-esm/chunk-HSLMI22Q.mjs +11 -0
  19. package/dist/lib/node-esm/index.mjs +1009 -34
  20. package/dist/lib/node-esm/index.mjs.map +4 -4
  21. package/dist/lib/node-esm/log-processor-TKJVJJSJ.mjs +46 -0
  22. package/dist/lib/node-esm/log-processor-TKJVJJSJ.mjs.map +7 -0
  23. package/dist/lib/node-esm/logs-7J45KLM7.mjs +114 -0
  24. package/dist/lib/node-esm/logs-7J45KLM7.mjs.map +7 -0
  25. package/dist/lib/node-esm/meta.json +1 -1
  26. package/dist/lib/node-esm/metrics-H7DDLYSG.mjs +131 -0
  27. package/dist/lib/node-esm/metrics-H7DDLYSG.mjs.map +7 -0
  28. package/dist/lib/node-esm/traces-KMTHMYFX.mjs +44 -0
  29. package/dist/lib/node-esm/traces-KMTHMYFX.mjs.map +7 -0
  30. package/dist/types/src/cli-observability-secrets.json +3 -4
  31. package/dist/types/src/extensions/index.d.ts +3 -0
  32. package/dist/types/src/extensions/index.d.ts.map +1 -0
  33. package/dist/types/src/extensions/index.js +6 -0
  34. package/dist/types/src/extensions/index.js.map +1 -0
  35. package/dist/types/src/extensions/otel/extension.d.ts +23 -0
  36. package/dist/types/src/extensions/otel/extension.d.ts.map +1 -0
  37. package/dist/types/src/extensions/otel/extension.js +124 -0
  38. package/dist/types/src/extensions/otel/extension.js.map +1 -0
  39. package/dist/types/src/extensions/otel/index.d.ts +2 -0
  40. package/dist/types/src/extensions/otel/index.d.ts.map +1 -0
  41. package/dist/types/src/extensions/otel/index.js +5 -0
  42. package/dist/types/src/extensions/otel/index.js.map +1 -0
  43. package/dist/types/src/{otel → extensions/otel}/logs.d.ts +4 -3
  44. package/dist/types/src/extensions/otel/logs.d.ts.map +1 -0
  45. package/dist/types/src/{otel → extensions/otel}/logs.js +48 -18
  46. package/dist/types/src/extensions/otel/logs.js.map +1 -0
  47. package/dist/types/src/extensions/otel/metrics.d.ts.map +1 -0
  48. package/dist/types/src/{otel → extensions/otel}/metrics.js +2 -10
  49. package/dist/types/src/extensions/otel/metrics.js.map +1 -0
  50. package/dist/types/src/{otel → extensions/otel}/otel.d.ts +3 -3
  51. package/dist/types/src/extensions/otel/otel.d.ts.map +1 -0
  52. package/dist/types/src/extensions/otel/otel.js.map +1 -0
  53. package/dist/types/src/extensions/otel/traces-browser.d.ts.map +1 -0
  54. package/dist/types/src/{otel → extensions/otel}/traces-browser.js +13 -16
  55. package/dist/types/src/extensions/otel/traces-browser.js.map +1 -0
  56. package/dist/types/src/extensions/otel/traces.d.ts.map +1 -0
  57. package/dist/types/src/{otel → extensions/otel}/traces.js +5 -13
  58. package/dist/types/src/extensions/otel/traces.js.map +1 -0
  59. package/dist/types/src/extensions/posthog/extension.d.ts +18 -0
  60. package/dist/types/src/extensions/posthog/extension.d.ts.map +1 -0
  61. package/dist/types/src/extensions/posthog/extension.js +142 -0
  62. package/dist/types/src/extensions/posthog/extension.js.map +1 -0
  63. package/dist/types/src/extensions/posthog/index.d.ts +2 -0
  64. package/dist/types/src/extensions/posthog/index.d.ts.map +1 -0
  65. package/dist/types/src/extensions/posthog/index.js +5 -0
  66. package/dist/types/src/extensions/posthog/index.js.map +1 -0
  67. package/dist/types/src/extensions/posthog/log-processor.d.ts +3 -0
  68. package/dist/types/src/extensions/posthog/log-processor.d.ts.map +1 -0
  69. package/dist/types/src/extensions/posthog/log-processor.js +45 -0
  70. package/dist/types/src/extensions/posthog/log-processor.js.map +1 -0
  71. package/dist/types/src/extensions/posthog/log-processor.test.d.ts +2 -0
  72. package/dist/types/src/extensions/posthog/log-processor.test.d.ts.map +1 -0
  73. package/dist/types/src/extensions/posthog/log-processor.test.js +146 -0
  74. package/dist/types/src/extensions/posthog/log-processor.test.js.map +1 -0
  75. package/dist/types/src/extensions/stub.d.ts +3 -0
  76. package/dist/types/src/extensions/stub.d.ts.map +1 -0
  77. package/dist/types/src/extensions/stub.js +16 -0
  78. package/dist/types/src/extensions/stub.js.map +1 -0
  79. package/dist/types/src/index.d.ts +3 -2
  80. package/dist/types/src/index.d.ts.map +1 -1
  81. package/dist/types/src/index.js +4 -3
  82. package/dist/types/src/index.js.map +1 -1
  83. package/dist/types/src/observability-extension.d.ts +74 -0
  84. package/dist/types/src/observability-extension.d.ts.map +1 -0
  85. package/dist/types/src/observability-extension.js +5 -0
  86. package/dist/types/src/observability-extension.js.map +1 -0
  87. package/dist/types/src/observability.d.ts +32 -110
  88. package/dist/types/src/observability.d.ts.map +1 -1
  89. package/dist/types/src/observability.js +177 -465
  90. package/dist/types/src/observability.js.map +1 -1
  91. package/dist/types/src/observability.test.d.ts +2 -0
  92. package/dist/types/src/observability.test.d.ts.map +1 -0
  93. package/dist/types/src/observability.test.js +312 -0
  94. package/dist/types/src/observability.test.js.map +1 -0
  95. package/dist/types/src/providers/client-observability.d.ts +11 -0
  96. package/dist/types/src/providers/client-observability.d.ts.map +1 -0
  97. package/dist/types/src/providers/client-observability.js +200 -0
  98. package/dist/types/src/providers/client-observability.js.map +1 -0
  99. package/dist/types/src/providers/index.d.ts +4 -0
  100. package/dist/types/src/providers/index.d.ts.map +1 -0
  101. package/dist/types/src/providers/index.js +7 -0
  102. package/dist/types/src/providers/index.js.map +1 -0
  103. package/dist/types/src/providers/ip-data.d.ts +5 -0
  104. package/dist/types/src/providers/ip-data.d.ts.map +1 -0
  105. package/dist/types/src/providers/ip-data.js +57 -0
  106. package/dist/types/src/providers/ip-data.js.map +1 -0
  107. package/dist/types/src/providers/storage.d.ts +3 -0
  108. package/dist/types/src/providers/storage.d.ts.map +1 -0
  109. package/dist/types/src/providers/storage.js +19 -0
  110. package/dist/types/src/providers/storage.js.map +1 -0
  111. package/dist/types/src/storage/browser.d.ts +19 -0
  112. package/dist/types/src/storage/browser.d.ts.map +1 -0
  113. package/dist/types/src/storage/browser.js +58 -0
  114. package/dist/types/src/storage/browser.js.map +1 -0
  115. package/dist/types/src/storage/index.d.ts +2 -0
  116. package/dist/types/src/storage/index.d.ts.map +1 -0
  117. package/dist/types/src/storage/index.js.map +1 -0
  118. package/dist/types/src/storage/node.d.ts +26 -0
  119. package/dist/types/src/storage/node.d.ts.map +1 -0
  120. package/dist/types/src/{helpers/node-observability.js → storage/node.js} +37 -42
  121. package/dist/types/src/storage/node.js.map +1 -0
  122. package/dist/types/src/storage/node.test.d.ts +2 -0
  123. package/dist/types/src/storage/node.test.d.ts.map +1 -0
  124. package/dist/types/src/storage/node.test.js +103 -0
  125. package/dist/types/src/storage/node.test.js.map +1 -0
  126. package/dist/types/tsconfig.tsbuildinfo +1 -1
  127. package/package.json +30 -51
  128. package/src/cli-observability-secrets.json +3 -4
  129. package/src/extensions/index.ts +6 -0
  130. package/src/extensions/otel/extension.ts +178 -0
  131. package/src/extensions/otel/index.ts +5 -0
  132. package/src/{otel → extensions/otel}/logs.ts +55 -23
  133. package/src/{otel → extensions/otel}/metrics.ts +2 -12
  134. package/src/{otel → extensions/otel}/otel.ts +3 -3
  135. package/src/{otel → extensions/otel}/traces-browser.ts +20 -19
  136. package/src/{otel → extensions/otel}/traces.ts +10 -21
  137. package/src/extensions/posthog/extension.ts +174 -0
  138. package/src/extensions/posthog/index.ts +5 -0
  139. package/src/extensions/posthog/log-processor.test.ts +185 -0
  140. package/src/extensions/posthog/log-processor.ts +54 -0
  141. package/src/extensions/stub.ts +19 -0
  142. package/src/index.ts +4 -3
  143. package/src/observability-extension.ts +94 -0
  144. package/src/observability.test.ts +531 -0
  145. package/src/observability.ts +236 -577
  146. package/src/providers/client-observability.ts +253 -0
  147. package/src/providers/index.ts +7 -0
  148. package/src/providers/ip-data.ts +91 -0
  149. package/src/providers/storage.ts +23 -0
  150. package/src/storage/browser.ts +61 -0
  151. package/src/{segment → storage}/index.ts +0 -1
  152. package/src/storage/node.test.ts +130 -0
  153. package/src/{helpers/node-observability.ts → storage/node.ts} +40 -69
  154. package/dist/lib/browser/chunk-5ICT2XF2.mjs +0 -1
  155. package/dist/lib/browser/chunk-CZBWMGUZ.mjs +0 -1025
  156. package/dist/lib/browser/chunk-CZBWMGUZ.mjs.map +0 -7
  157. package/dist/lib/browser/chunk-JWOLOB5N.mjs +0 -161
  158. package/dist/lib/browser/chunk-JWOLOB5N.mjs.map +0 -7
  159. package/dist/lib/browser/chunk-ZI3ZS3PA.mjs +0 -164
  160. package/dist/lib/browser/chunk-ZI3ZS3PA.mjs.map +0 -7
  161. package/dist/lib/browser/observability-NLOCHCE7.mjs +0 -10
  162. package/dist/lib/browser/otel-6FVBNA5F.mjs +0 -327
  163. package/dist/lib/browser/otel-6FVBNA5F.mjs.map +0 -7
  164. package/dist/lib/browser/segment/index.mjs +0 -11
  165. package/dist/lib/browser/segment/index.mjs.map +0 -7
  166. package/dist/lib/browser/sentry/index.mjs +0 -24
  167. package/dist/lib/browser/sentry/index.mjs.map +0 -7
  168. package/dist/lib/browser/sentry-log-processor-F4JCYJ2E.mjs +0 -162
  169. package/dist/lib/browser/sentry-log-processor-F4JCYJ2E.mjs.map +0 -7
  170. package/dist/lib/node-esm/chunk-24NMRR4E.mjs +0 -229
  171. package/dist/lib/node-esm/chunk-24NMRR4E.mjs.map +0 -7
  172. package/dist/lib/node-esm/chunk-4EWQFQ2F.mjs +0 -1026
  173. package/dist/lib/node-esm/chunk-4EWQFQ2F.mjs.map +0 -7
  174. package/dist/lib/node-esm/chunk-QK5IUYVA.mjs +0 -135
  175. package/dist/lib/node-esm/chunk-QK5IUYVA.mjs.map +0 -7
  176. package/dist/lib/node-esm/chunk-QUZL7LKE.mjs +0 -2
  177. package/dist/lib/node-esm/chunk-QUZL7LKE.mjs.map +0 -7
  178. package/dist/lib/node-esm/observability-DHNVVRC7.mjs +0 -11
  179. package/dist/lib/node-esm/observability-DHNVVRC7.mjs.map +0 -7
  180. package/dist/lib/node-esm/otel-KHSGBROB.mjs +0 -310
  181. package/dist/lib/node-esm/otel-KHSGBROB.mjs.map +0 -7
  182. package/dist/lib/node-esm/segment/index.mjs +0 -12
  183. package/dist/lib/node-esm/segment/index.mjs.map +0 -7
  184. package/dist/lib/node-esm/sentry/index.mjs +0 -25
  185. package/dist/lib/node-esm/sentry/index.mjs.map +0 -7
  186. package/dist/lib/node-esm/sentry-log-processor-3BDS4BB4.mjs +0 -163
  187. package/dist/lib/node-esm/sentry-log-processor-3BDS4BB4.mjs.map +0 -7
  188. package/dist/types/src/helpers/browser-observability.d.ts +0 -17
  189. package/dist/types/src/helpers/browser-observability.d.ts.map +0 -1
  190. package/dist/types/src/helpers/browser-observability.js +0 -138
  191. package/dist/types/src/helpers/browser-observability.js.map +0 -1
  192. package/dist/types/src/helpers/common.d.ts +0 -12
  193. package/dist/types/src/helpers/common.d.ts.map +0 -1
  194. package/dist/types/src/helpers/common.js +0 -23
  195. package/dist/types/src/helpers/common.js.map +0 -1
  196. package/dist/types/src/helpers/index.d.ts +0 -6
  197. package/dist/types/src/helpers/index.d.ts.map +0 -1
  198. package/dist/types/src/helpers/index.js +0 -9
  199. package/dist/types/src/helpers/index.js.map +0 -1
  200. package/dist/types/src/helpers/map-spaces.d.ts +0 -18
  201. package/dist/types/src/helpers/map-spaces.d.ts.map +0 -1
  202. package/dist/types/src/helpers/map-spaces.js +0 -36
  203. package/dist/types/src/helpers/map-spaces.js.map +0 -1
  204. package/dist/types/src/helpers/node-observability.d.ts +0 -24
  205. package/dist/types/src/helpers/node-observability.d.ts.map +0 -1
  206. package/dist/types/src/helpers/node-observability.js.map +0 -1
  207. package/dist/types/src/helpers/setup-telemetry-listeners.d.ts +0 -4
  208. package/dist/types/src/helpers/setup-telemetry-listeners.d.ts.map +0 -1
  209. package/dist/types/src/helpers/setup-telemetry-listeners.js +0 -94
  210. package/dist/types/src/helpers/setup-telemetry-listeners.js.map +0 -1
  211. package/dist/types/src/otel/index.d.ts +0 -5
  212. package/dist/types/src/otel/index.d.ts.map +0 -1
  213. package/dist/types/src/otel/index.js +0 -8
  214. package/dist/types/src/otel/index.js.map +0 -1
  215. package/dist/types/src/otel/logs.d.ts.map +0 -1
  216. package/dist/types/src/otel/logs.js.map +0 -1
  217. package/dist/types/src/otel/metrics.d.ts.map +0 -1
  218. package/dist/types/src/otel/metrics.js.map +0 -1
  219. package/dist/types/src/otel/otel.d.ts.map +0 -1
  220. package/dist/types/src/otel/otel.js.map +0 -1
  221. package/dist/types/src/otel/traces-browser.d.ts.map +0 -1
  222. package/dist/types/src/otel/traces-browser.js.map +0 -1
  223. package/dist/types/src/otel/traces.d.ts.map +0 -1
  224. package/dist/types/src/otel/traces.js.map +0 -1
  225. package/dist/types/src/segment/base.d.ts +0 -15
  226. package/dist/types/src/segment/base.d.ts.map +0 -1
  227. package/dist/types/src/segment/base.js +0 -51
  228. package/dist/types/src/segment/base.js.map +0 -1
  229. package/dist/types/src/segment/browser.d.ts +0 -15
  230. package/dist/types/src/segment/browser.d.ts.map +0 -1
  231. package/dist/types/src/segment/browser.js +0 -63
  232. package/dist/types/src/segment/browser.js.map +0 -1
  233. package/dist/types/src/segment/index.d.ts +0 -3
  234. package/dist/types/src/segment/index.d.ts.map +0 -1
  235. package/dist/types/src/segment/index.js +0 -6
  236. package/dist/types/src/segment/index.js.map +0 -1
  237. package/dist/types/src/segment/node.d.ts +0 -16
  238. package/dist/types/src/segment/node.d.ts.map +0 -1
  239. package/dist/types/src/segment/node.js +0 -84
  240. package/dist/types/src/segment/node.js.map +0 -1
  241. package/dist/types/src/segment/types.d.ts +0 -52
  242. package/dist/types/src/segment/types.d.ts.map +0 -1
  243. package/dist/types/src/segment/types.js +0 -18
  244. package/dist/types/src/segment/types.js.map +0 -1
  245. package/dist/types/src/sentry/browser.d.ts +0 -32
  246. package/dist/types/src/sentry/browser.d.ts.map +0 -1
  247. package/dist/types/src/sentry/browser.js +0 -110
  248. package/dist/types/src/sentry/browser.js.map +0 -1
  249. package/dist/types/src/sentry/index.d.ts +0 -3
  250. package/dist/types/src/sentry/index.d.ts.map +0 -1
  251. package/dist/types/src/sentry/index.js.map +0 -1
  252. package/dist/types/src/sentry/node.d.ts +0 -32
  253. package/dist/types/src/sentry/node.d.ts.map +0 -1
  254. package/dist/types/src/sentry/node.js +0 -106
  255. package/dist/types/src/sentry/node.js.map +0 -1
  256. package/dist/types/src/sentry/node.node.test.d.ts +0 -2
  257. package/dist/types/src/sentry/node.node.test.d.ts.map +0 -1
  258. package/dist/types/src/sentry/node.node.test.js +0 -32
  259. package/dist/types/src/sentry/node.node.test.js.map +0 -1
  260. package/dist/types/src/sentry/sentry-log-processor.d.ts +0 -9
  261. package/dist/types/src/sentry/sentry-log-processor.d.ts.map +0 -1
  262. package/dist/types/src/sentry/sentry-log-processor.js +0 -144
  263. package/dist/types/src/sentry/sentry-log-processor.js.map +0 -1
  264. package/dist/types/src/sentry/sentry.node.test.d.ts +0 -2
  265. package/dist/types/src/sentry/sentry.node.test.d.ts.map +0 -1
  266. package/dist/types/src/sentry/sentry.node.test.js +0 -28
  267. package/dist/types/src/sentry/sentry.node.test.js.map +0 -1
  268. package/dist/types/src/sentry/types.d.ts +0 -18
  269. package/dist/types/src/sentry/types.d.ts.map +0 -1
  270. package/dist/types/src/sentry/types.js +0 -4
  271. package/dist/types/src/sentry/types.js.map +0 -1
  272. package/dist/types/src/testing/index.d.ts +0 -2
  273. package/dist/types/src/testing/index.d.ts.map +0 -1
  274. package/dist/types/src/testing/index.js +0 -5
  275. package/dist/types/src/testing/index.js.map +0 -1
  276. package/dist/types/src/testing/testkit/browser.d.ts +0 -2
  277. package/dist/types/src/testing/testkit/browser.d.ts.map +0 -1
  278. package/dist/types/src/testing/testkit/browser.js +0 -7
  279. package/dist/types/src/testing/testkit/browser.js.map +0 -1
  280. package/dist/types/src/testing/testkit/index.d.ts +0 -2
  281. package/dist/types/src/testing/testkit/index.d.ts.map +0 -1
  282. package/dist/types/src/testing/testkit/index.js +0 -6
  283. package/dist/types/src/testing/testkit/index.js.map +0 -1
  284. package/src/helpers/browser-observability.ts +0 -178
  285. package/src/helpers/common.ts +0 -38
  286. package/src/helpers/index.ts +0 -9
  287. package/src/helpers/map-spaces.ts +0 -48
  288. package/src/helpers/setup-telemetry-listeners.ts +0 -109
  289. package/src/otel/index.ts +0 -8
  290. package/src/segment/base.ts +0 -69
  291. package/src/segment/browser.ts +0 -69
  292. package/src/segment/node.ts +0 -95
  293. package/src/segment/types.ts +0 -57
  294. package/src/sentry/browser.ts +0 -133
  295. package/src/sentry/index.ts +0 -6
  296. package/src/sentry/node.node.test.ts +0 -40
  297. package/src/sentry/node.ts +0 -126
  298. package/src/sentry/sentry-log-processor.ts +0 -174
  299. package/src/sentry/sentry.node.test.ts +0 -35
  300. package/src/sentry/types.ts +0 -22
  301. package/src/testing/index.ts +0 -5
  302. package/src/testing/testkit/browser.ts +0 -8
  303. package/src/testing/testkit/index.ts +0 -7
  304. package/src/testing/testkit/shims.d.ts +0 -5
  305. /package/dist/lib/browser/{chunk-5ICT2XF2.mjs.map → chunk-J5LGTIGS.mjs.map} +0 -0
  306. /package/dist/lib/{browser/observability-NLOCHCE7.mjs.map → node-esm/chunk-HSLMI22Q.mjs.map} +0 -0
  307. /package/dist/types/src/{otel → extensions/otel}/metrics.d.ts +0 -0
  308. /package/dist/types/src/{otel → extensions/otel}/otel.js +0 -0
  309. /package/dist/types/src/{otel → extensions/otel}/traces-browser.d.ts +0 -0
  310. /package/dist/types/src/{otel → extensions/otel}/traces.d.ts +0 -0
  311. /package/dist/types/src/{sentry → storage}/index.js +0 -0
@@ -0,0 +1,74 @@
1
+ import type * as Effect from 'effect/Effect';
2
+ export * from './extensions';
3
+ /**
4
+ * Kind of observability extension.
5
+ *
6
+ * - errors: Error tracking (e.g., PostHog)
7
+ * - events: Product usage event tracking (e.g., PostHog)
8
+ * - feedback: User feedback submission (e.g., PostHog)
9
+ * - logs: Structured logging (e.g., OTEL)
10
+ * - metrics: Metric data (e.g., OTEL)
11
+ * - traces: Distributed tracing (e.g., OTEL)
12
+ */
13
+ export type Kind = 'errors' | 'events' | 'feedback' | 'logs' | 'metrics' | 'traces';
14
+ /**
15
+ * Base for every extension API variant. All kinds implement availability the same way.
16
+ */
17
+ export type ExtensionApiBase<K extends Kind = Kind> = {
18
+ kind: K;
19
+ isAvailable(): Effect.Effect<boolean>;
20
+ };
21
+ /**
22
+ * Metrics extension API (kind-specific methods only).
23
+ */
24
+ export type Metrics = {
25
+ gauge(name: string, value: number, tags?: Attributes): void;
26
+ increment(name: string, value?: number, tags?: Attributes): void;
27
+ distribution(name: string, value: number, tags?: Attributes): void;
28
+ };
29
+ /**
30
+ * Errors extension API (kind-specific methods only).
31
+ */
32
+ export type Errors = {
33
+ captureException(error: Error, attributes?: Attributes): void;
34
+ };
35
+ /**
36
+ * Events extension API (kind-specific methods only).
37
+ */
38
+ export type Events = {
39
+ captureEvent(event: string, attributes?: Attributes): void;
40
+ };
41
+ /**
42
+ * Feedback extension API (kind-specific methods only).
43
+ */
44
+ export type Feedback = {
45
+ captureUserFeedback(form: FeedbackForm): void;
46
+ };
47
+ export type ExtensionApi = (ExtensionApiBase<'errors'> & Errors) | (ExtensionApiBase<'events'> & Events) | (ExtensionApiBase<'feedback'> & Feedback) | ExtensionApiBase<'logs'> | (ExtensionApiBase<'metrics'> & Metrics) | ExtensionApiBase<'traces'>;
48
+ /**
49
+ * Feedback form to be captured by the feedback extension.
50
+ */
51
+ export type FeedbackForm = {
52
+ message: string;
53
+ includeLogs?: boolean;
54
+ };
55
+ /**
56
+ * Attributes to be attached to observability events.
57
+ */
58
+ export type Attributes = Record<string, string | number | boolean | undefined>;
59
+ /**
60
+ * Implementation of an observability extension API.
61
+ */
62
+ export type Extension = {
63
+ initialize?(): Effect.Effect<void, Error>;
64
+ close?(): Effect.Effect<void>;
65
+ enable?(): Effect.Effect<void>;
66
+ disable?(): Effect.Effect<void>;
67
+ flush?(): Effect.Effect<void>;
68
+ identify?(distinctId: string, attributes?: Attributes, setOnceAttributes?: Attributes): void;
69
+ alias?(distinctId: string, previousId?: string): void;
70
+ setTags?(tags: Record<string, string>): void;
71
+ enabled: boolean;
72
+ apis: ExtensionApi[];
73
+ };
74
+ //# sourceMappingURL=observability-extension.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"observability-extension.d.ts","sourceRoot":"","sources":["../../../src/observability-extension.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAE7C,cAAc,cAAc,CAAC;AAE7B;;;;;;;;;GASG;AACH,MAAM,MAAM,IAAI,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEpF;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI,IAAI;IACpD,IAAI,EAAE,CAAC,CAAC;IACR,WAAW,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAC5D,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IACjE,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;CACpE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,gBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;CAC/D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;CAC5D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,mBAAmB,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,YAAY,GACpB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,GACrC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,GACrC,CAAC,gBAAgB,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC,GAEzC,gBAAgB,CAAC,MAAM,CAAC,GACxB,CAAC,gBAAgB,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,GAEvC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;AAE/B;;GAEG;AAEH,MAAM,MAAM,YAAY,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,UAAU,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC1C,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC9B,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/B,OAAO,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAChC,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC9B,QAAQ,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,EAAE,iBAAiB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAC7F,KAAK,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtD,OAAO,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IAC7C,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,YAAY,EAAE,CAAC;CACtB,CAAC"}
@@ -0,0 +1,5 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+ export * from './extensions';
5
+ //# sourceMappingURL=observability-extension.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"observability-extension.js","sourceRoot":"","sources":["../../../src/observability-extension.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAIF,cAAc,cAAc,CAAC"}
@@ -1,112 +1,34 @@
1
- import { type Client, type Config } from '@dxos/client';
2
- import { type ClientServices } from '@dxos/client-protocol';
3
- import { type IPData } from './helpers';
4
- import { type PageOptions, type TrackOptions } from './segment';
5
- import { type InitOptions } from './sentry';
6
- export type ObservabilitySecrets = {
7
- DX_ENVIRONMENT: string | null;
8
- DX_RELEASE: string | null;
9
- SENTRY_DESTINATION: string | null;
10
- TELEMETRY_API_KEY: string | null;
11
- IPDATA_API_KEY: string | null;
12
- OTEL_ENDPOINT: string | null;
13
- OTEL_AUTHORIZATION: string | null;
14
- };
15
- export type TagScope = 'errors' | 'telemetry' | 'metrics' | 'all';
16
- /** Gathering mode. */
17
- export type Mode = 'basic' | 'full' | 'disabled';
18
- export type ObservabilityOptions = {
19
- mode: Mode;
20
- /** Environment. */
21
- environment?: string;
22
- /** Application namespace. */
23
- namespace: string;
24
- /** Application release. */
25
- release?: string;
26
- /** User group. */
27
- group?: string;
28
- config?: Config;
29
- secrets?: Record<string, string>;
30
- telemetry?: {
31
- batchSize?: number;
32
- };
33
- errorLog?: {
34
- sentryInitOptions?: InitOptions;
35
- };
36
- };
37
- export declare class Observability {
38
- private _mode;
39
- private readonly _namespace;
40
- private readonly _config?;
41
- private readonly _group?;
42
- private readonly _secrets;
43
- private readonly _tags;
44
- private _otelMetrics?;
45
- private _otelTraces?;
46
- private _telemetryBatchSize;
47
- private _telemetry?;
48
- private _sentryLogProcessor?;
49
- private _otelLogs?;
50
- private _errorReportingOptions?;
51
- private _captureException?;
52
- private _captureUserFeedback?;
53
- private _lastNetworkStatus?;
54
- private _ctx;
55
- constructor({ mode, namespace, environment, release, config, group, secrets, telemetry, errorLog, }: ObservabilityOptions);
56
- get mode(): Mode;
57
- get group(): string | undefined;
58
- get enabled(): boolean;
59
- private _loadSecrets;
60
- initialize(): Promise<void>;
61
- close(): Promise<void>;
62
- setMode(mode: Mode): void;
63
- /** Callback (e.g., to share tags with Sentry.) */
64
- private _setTag?;
65
- /**
66
- * camelCase keys are converted to snake_case in Segment.
67
- */
68
- setTag(key: string, value: string | undefined, scope?: TagScope): void;
69
- getTag(key: string): {
70
- value: string;
71
- scope: TagScope;
72
- } | undefined;
73
- setIdentityTags(clientServices: Partial<ClientServices>): Promise<void>;
74
- setIPDataTelemetryTags: (ipData: IPData) => void;
75
- private _initLogs;
76
- private _initMetrics;
77
- /**
78
- * Gauge metric.
79
- *
80
- * The default implementation uses OpenTelemetry
81
- */
82
- gauge(name: string, value: number | any, extraTags?: any): void;
83
- startNetworkMetrics(clientServices: Partial<ClientServices>): void;
84
- startSpacesMetrics(client: Client, namespace: string): void;
85
- startRuntimeMetrics(client: Client, frequency?: number): Promise<void>;
86
- private _initTelemetry;
87
- /**
88
- * Submit telemetry page view.
89
- * The default implementation uses Segment.
90
- */
91
- page(options: PageOptions): void;
92
- /**
93
- * Submit telemetry user action.
94
- * The default implementation uses Segment.
95
- */
96
- track(options: TrackOptions): void;
97
- private _initErrorLogs;
98
- startErrorLogs(): void;
99
- startTraces(): void;
100
- private _initTraces;
101
- /**
102
- * Manually capture an exception.
103
- * The default implementation uses Sentry.
104
- */
105
- captureException(err: any): void;
106
- /**
107
- * Manually capture user feedback.
108
- * The default implementation uses Sentry.
109
- */
110
- captureUserFeedback(message: string): void;
1
+ import * as Effect from 'effect/Effect';
2
+ import { type CleanupFn } from '@dxos/async';
3
+ import { type Attributes, type Errors, type Events, type Extension, type Feedback, type Kind, type Metrics } from './observability-extension';
4
+ export * from './storage';
5
+ /**
6
+ * Provider of observability data.
7
+ */
8
+ export type DataProvider = (observability: Observability) => Effect.Effect<CleanupFn | void, Error>;
9
+ /**
10
+ * Extensible observability provider.
11
+ */
12
+ export interface Observability {
13
+ initialize(): Effect.Effect<void>;
14
+ close(): Effect.Effect<void>;
15
+ enable(): Effect.Effect<void>;
16
+ disable(): Effect.Effect<void>;
17
+ flush(): Effect.Effect<void>;
18
+ addDataProvider(dataProvider: DataProvider): Effect.Effect<void, Error>;
19
+ identify(distinctId: string, attributes?: Attributes, setOnceAttributes?: Attributes): void;
20
+ alias(distinctId: string, previousId?: string): void;
21
+ setTags(tags: Attributes, kind?: Kind): void;
22
+ enabled: boolean;
23
+ errors: Errors;
24
+ events: Events;
25
+ feedback: Feedback;
26
+ /** True if at least one extension of the given kind reports as available. */
27
+ isAvailable(kind: Kind): Effect.Effect<boolean>;
28
+ metrics: Metrics;
111
29
  }
30
+ export declare const make: () => Effect.Effect<Observability>;
31
+ export declare const addExtension: (_extension: Effect.Effect<Extension>) => (_observability: Effect.Effect<Observability, never, never>) => Effect.Effect<Observability & Record<"_addExtension", unknown>, never, never>;
32
+ export declare const addDataProvider: (dataProvider: DataProvider) => (_observability: Effect.Effect<Observability, never, never>) => Effect.Effect<Observability & Record<"_addDataProvider", unknown>, never, never>;
33
+ export declare const initialize: (_observability: Effect.Effect<Observability, never, never>) => Effect.Effect<Observability, never, never>;
112
34
  //# sourceMappingURL=observability.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"observability.d.ts","sourceRoot":"","sources":["../../../src/observability.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,MAAM,EAAa,MAAM,cAAc,CAAC;AACnE,OAAO,EAAE,KAAK,cAAc,EAAc,MAAM,uBAAuB,CAAC;AASxE,OAAO,EAAE,KAAK,MAAM,EAAmC,MAAM,WAAW,CAAC;AAEzE,OAAO,EAAE,KAAK,WAAW,EAAyC,KAAK,YAAY,EAAE,MAAM,WAAW,CAAC;AACvG,OAAO,EAAE,KAAK,WAAW,EAAmD,MAAM,UAAU,CAAC;AAS7F,MAAM,MAAM,oBAAoB,GAAG;IACjC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,GAAG,KAAK,CAAC;AAElE,sBAAsB;AACtB,MAAM,MAAM,IAAI,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,CAAC;AAEjD,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,IAAI,CAAC;IAEX,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAC;IAElB,2BAA2B;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,kBAAkB;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC,SAAS,CAAC,EAAE;QACV,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IAEF,QAAQ,CAAC,EAAE;QACT,iBAAiB,CAAC,EAAE,WAAW,CAAC;KACjC,CAAC;CACH,CAAC;AAyBF,qBAAa,aAAa;IACxB,OAAO,CAAC,KAAK,CAAO;IACpB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAuB;IAChD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAyD;IAG/E,OAAO,CAAC,YAAY,CAAC,CAAc;IACnC,OAAO,CAAC,WAAW,CAAC,CAAa;IAEjC,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,UAAU,CAAC,CAAmB;IAEtC,OAAO,CAAC,mBAAmB,CAAC,CAAqB;IACjD,OAAO,CAAC,SAAS,CAAC,CAAW;IAC7B,OAAO,CAAC,sBAAsB,CAAC,CAAc;IAC7C,OAAO,CAAC,iBAAiB,CAAC,CAAgC;IAC1D,OAAO,CAAC,oBAAoB,CAAC,CAAqC;IAClE,OAAO,CAAC,kBAAkB,CAAC,CAAgB;IAE3C,OAAO,CAAC,IAAI,CAAiB;gBAGjB,EACV,IAAI,EACJ,SAAS,EACT,WAAW,EACX,OAAO,EACP,MAAM,EACN,KAAK,EACL,OAAO,EACP,SAAS,EACT,QAAQ,GACT,EAAE,oBAAoB;IAmBvB,IAAI,IAAI,SAEP;IAED,IAAI,KAAK,uBAER;IAED,IAAI,OAAO,YAEV;IAED,OAAO,CAAC,YAAY;IA+Bd,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAS3B,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAW5B,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAQzB,kDAAkD;IAClD,OAAO,CAAC,OAAO,CAAC,CAAuC;IAEvD;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,CAAC,EAAE,QAAQ,GAAG,IAAI;IActE,MAAM,CAAC,GAAG,EAAE,MAAM;eA3IgC,MAAM;eAAS,QAAQ;;IAgJnE,eAAe,CAAC,cAAc,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAmC7E,sBAAsB,GAAI,QAAQ,MAAM,UAMtC;YAMY,SAAS;YA8BT,YAAY;IAuB1B;;;;OAIG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,GAAG,EAAE,SAAS,CAAC,EAAE,GAAG,GAAG,IAAI;IAM/D,mBAAmB,CAAC,cAAc,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,IAAI;IAoDlE,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAuDrD,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,GAAE,MAAqC,GAAG,OAAO,CAAC,IAAI,CAAC;YA8C5F,cAAc;IAoB5B;;;OAGG;IACH,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAIhC;;;OAGG;IACH,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;YAQpB,cAAc;IAiC5B,cAAc,IAAI,IAAI;IAItB,WAAW,IAAI,IAAI;YAKL,WAAW;IAoBzB;;;OAGG;IACH,gBAAgB,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAMhC;;;OAGG;IACH,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;CAW3C"}
1
+ {"version":3,"file":"observability.d.ts","sourceRoot":"","sources":["../../../src/observability.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAGxC,OAAO,EAAE,KAAK,SAAS,EAAoB,MAAM,aAAa,CAAC;AAI/D,OAAO,EACL,KAAK,UAAU,EACf,KAAK,MAAM,EACX,KAAK,MAAM,EACX,KAAK,SAAS,EAEd,KAAK,QAAQ,EACb,KAAK,IAAI,EACT,KAAK,OAAO,EACb,MAAM,2BAA2B,CAAC;AAEnC,cAAc,WAAW,CAAC;AAM1B;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,aAAa,EAAE,aAAa,KAAK,MAAM,CAAC,MAAM,CAAC,SAAS,GAAG,IAAI,EAAE,KAAK,CAAC,CAAC;AAEpG;;GAEG;AAEH,MAAM,WAAW,aAAa;IAC5B,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAClC,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7B,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC9B,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/B,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7B,eAAe,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACxE,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,EAAE,iBAAiB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAC5F,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrD,OAAO,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAC7C,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,6EAA6E;IAC7E,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAChD,OAAO,EAAE,OAAO,CAAC;CAClB;AAsND,eAAO,MAAM,IAAI,QAAO,MAAM,CAAC,MAAM,CAAC,aAAa,CAA4C,CAAC;AAEhG,eAAO,MAAM,YAAY,GAAI,YAAY,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,kJAO7D,CAAC;AAEL,eAAO,MAAM,eAAe,GAAI,cAAc,YAAY,qJAMtD,CAAC;AAEL,eAAO,MAAM,UAAU,4GAIrB,CAAC"}