@elto/telemetry 0.1.0

package/LICENSE

@@ -0,0 +1,176 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Support. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,284 @@
+# @elto/telemetry
+
+OpenTelemetry integration for Effect with Node.js and browser support.
+
+## Features
+
+- **Node.js Support**: Full OpenTelemetry integration with traces, metrics, and logs
+- **Browser Support**: Web-optimized telemetry with traces and logs
+- **Dual Mode**: Browser apps can send telemetry directly to collector or proxy through server
+- **Effect Integration**: Built on top of `@effect/opentelemetry` for seamless Effect usage
+- **TypeScript**: Full type safety and excellent IDE support
+- **Simple API**: Clean, declarative configuration
+
+## Installation
+
+```bash
+pnpm add @elto/telemetry effect
+```
+
+## Quick Start
+
+### Node.js
+
+```typescript
+import { createNodeOtelLayer, createEndpoints } from "@elto/telemetry/node";
+
+const OtelLive = createNodeOtelLayer({
+  resource: {
+    serviceName: "api-server",
+    serviceVersion: "1.0.0",
+  },
+  endpoints: createEndpoints("http://localhost:4318"),
+});
+
+// Use with your Effect program
+const program = Effect.gen(function* () {
+  // Your telemetry-enabled code here
+}).pipe(Effect.provide(OtelLive));
+```
+
+### Browser
+
+```typescript
+import { createWebOtelLayer, createModeBasedEndpoints } from "@elto/telemetry/web";
+
+const OtelLive = createWebOtelLayer({
+  resource: {
+    serviceName: "web-client",
+    serviceVersion: "1.0.0",
+  },
+  endpoints: { traces: "", logs: "" }, // fallback
+  getEndpoints: createModeBasedEndpoints(
+    "http://localhost:4318",
+    { serverUrl: "https://api.example.com" }
+  ),
+});
+
+// Use with your Effect program or RPC client
+import { withOtel } from "@elto/telemetry/web";
+
+const ClientLive = withOtel(OtelLive, RpcClientLayer);
+```
+
+## Span Processing
+
+`@elto/telemetry` applies a built-in custom span processor by default. Both
+`createNodeOtelLayer` and `createWebOtelLayer` wrap the batch span processor
+with an opinionated sanitizer before export.
+
+Behavior:
+
+- Redacts `user.email`, `note.id`, and `profile.id` and adds `<key>_hash`
+- Redacts `db.connection_string` and adds `db.connection_string_redacted`
+- Shortens `db.statement` when it exceeds the internal length threshold
+- Strips query strings from `http.url`
+- Adds `http.status_category` when `http.status_code` is present
+- Adds `telemetry.redactions` and `telemetry.transformations` counters
+- Drops spans when `telemetry.drop` is `true` or `"true"`
+
+Not redacted or hashed: `user.id`, `cache.key`, `request.id`, `request.client_id`.
+
+To explicitly drop a span, annotate it:
+
+```typescript
+Effect.annotateCurrentSpan({
+  "telemetry.drop": true,
+  "telemetry.drop_reason": "debug-only",
+});
+```
+
+If you need full control, build your own OpenTelemetry layer using
+`@effect/opentelemetry` or wrap a processor with `createCustomSpanProcessor`
+from `@elto/telemetry`.
+
+### Browser Logger (Non-Effect)
+
+For browser contexts where Effect is not available:
+
+```typescript
+import { createBrowserLogger, getOtelMode } from "@elto/telemetry/web";
+
+const getEndpoint = () =>
+  getOtelMode() === "proxy"
+    ? "https://api.example.com/api/signals"
+    : "http://localhost:4318/v1/logs";
+
+const logger = createBrowserLogger({
+  resource: {
+    serviceName: "web-client",
+    serviceVersion: "1.0.0",
+  },
+  logsEndpoint: getEndpoint,
+});
+
+logger.info("User logged in", { userId: "123" });
+logger.error("Operation failed", { operation: "checkout", error: "timeout" });
+await logger.flush(); // Flush before page unload
+```
+
+## API Reference
+
+### Common (`@elto/telemetry`)
+
+#### `createCustomSpanProcessor(delegate: SpanProcessor)`
+
+Wraps a delegate span processor (for example, `BatchSpanProcessor`) with the
+sanitization rules described above.
+
+### Node.js (`@elto/telemetry/node`)
+
+#### `createNodeOtelLayer(config: NodeSdkConfig)`
+
+Creates an Effect Layer with OpenTelemetry configured for Node.js.
+
+**Config:**
+
+- `resource.serviceName` - Service name for telemetry
+- `resource.serviceVersion` - Service version
+- `endpoints` - Endpoint URLs (use `createEndpoints()` helper)
+- `metricExportIntervalMs` - Optional, default 10000ms
+
+**Returns:** Effect Layer for OpenTelemetry
+
+#### `createEndpoints(baseUrl: string)`
+
+Generates OTLP endpoint URLs for traces, logs, and metrics.
+
+**Example:**
+
+```typescript
+createEndpoints("http://localhost:4318")
+// Returns:
+// {
+//   traces: "http://localhost:4318/v1/traces",
+//   logs: "http://localhost:4318/v1/logs",
+//   metrics: "http://localhost:4318/v1/metrics"
+// }
+```
+
+#### `DEFAULT_OTEL_ENDPOINT`
+
+Default OpenTelemetry collector endpoint: `"http://localhost:4318"`
+
+### Browser (`@elto/telemetry/web`)
+
+#### `createWebOtelLayer(config: WebSdkConfig)`
+
+Creates an Effect Layer with OpenTelemetry configured for browsers.
+
+**Config:**
+
+- `resource.serviceName` - Service name for telemetry
+- `resource.serviceVersion` - Service version
+- `endpoints` - Fallback endpoint URLs
+- `getEndpoints` - Optional function to dynamically get endpoints (for mode switching)
+
+**Returns:** Effect Layer for OpenTelemetry
+
+#### `createDirectEndpoints(baseUrl: string)`
+
+Creates endpoints for direct connection to OpenTelemetry collector.
+
+#### `createProxyEndpoints(config: ProxyConfig)`
+
+Creates endpoints for proxy mode (telemetry sent through server).
+
+**Config:**
+
+- `serverUrl` - Your server URL
+- `tracesPath` - Optional, defaults to "/api/events"
+- `logsPath` - Optional, defaults to "/api/signals"
+
+#### `createModeBasedEndpoints(directUrl: string, proxyConfig: ProxyConfig)`
+
+Creates a function that returns endpoints based on the current mode.
+
+**Example:**
+
+```typescript
+const getEndpoints = createModeBasedEndpoints(
+  "http://localhost:4318",
+  { serverUrl: "https://api.example.com" }
+);
+```
+
+#### `getOtelMode(): OtelMode`
+
+Returns the current telemetry mode from localStorage ("direct" or "proxy").
+
+#### `setOtelMode(mode: OtelMode): void`
+
+Sets the telemetry mode in localStorage.
+
+#### `withOtel(otelLayer, layer)`
+
+Helper to merge OpenTelemetry layer with another layer.
+
+#### `createBrowserLogger(config: BrowserLoggerConfig)`
+
+Creates a standalone logger for non-Effect browser contexts.
+
+**Config:**
+
+- `resource.serviceName` - Service name
+- `resource.serviceVersion` - Service version
+- `logsEndpoint` - Endpoint URL or function that returns URL
+
+**Returns:** Logger instance with methods: `debug`, `info`, `warning`, `error`, `flush`
+
+## Proxy Mode
+
+Browser apps can send telemetry through your server instead of directly to the collector. This:
+
+- Hides OpenTelemetry infrastructure from the browser
+- Works around CORS restrictions
+- Provides obscured endpoint names (`/api/events`, `/api/signals`)
+
+### Implementation
+
+1. **Browser**: Use `createModeBasedEndpoints()` to support both modes
+2. **Server**: Add proxy endpoints that forward to your collector
+3. **User Control**: Use `setOtelMode("proxy")` to switch modes
+
+Example server proxy (Express):
+
+```typescript
+app.post("/api/events", async (req, res) => {
+  // Forward to OTLP collector traces endpoint
+  await fetch("http://localhost:4318/v1/traces", {
+    method: "POST",
+    headers: req.headers,
+    body: req.body,
+  });
+  res.sendStatus(200);
+});
+
+app.post("/api/signals", async (req, res) => {
+  // Forward to OTLP collector logs endpoint
+  await fetch("http://localhost:4318/v1/logs", {
+    method: "POST",
+    headers: req.headers,
+    body: req.body,
+  });
+  res.sendStatus(200);
+});
+```
+
+## TypeScript
+
+All types are exported from the main package and subpath exports:
+
+```typescript
+import type { ResourceConfig, EndpointConfig } from "@elto/telemetry";
+import type { NodeSdkConfig } from "@elto/telemetry/node";
+import type { WebSdkConfig, OtelMode, BrowserLogger } from "@elto/telemetry/web";
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+Apache-2.0

package/dist/index.cjs

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+module.exports = __toCommonJS(src_exports);
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * @elto/telemetry\n *\n * OpenTelemetry integration for Effect with Node.js and browser support.\n *\n * For Node.js usage: import from \"@elto/telemetry/node\"\n * For browser usage: import from \"@elto/telemetry/web\"\n *\n * @packageDocumentation\n */\nexport type {\n  ResourceConfig,\n  EndpointConfig,\n  NodeSdkConfig,\n  WebSdkConfig,\n  ProxyConfig,\n  OtelMode,\n  BrowserLoggerConfig,\n  LogLevel,\n  LogOptions,\n  BrowserLogger,\n} from \"./common/index.js\";\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,91 @@
+interface PIIConfig {
+    /**
+     * Set of span attribute keys whose values will be redacted.
+     */
+    piiAttributeKeys?: Set<string>;
+    /**
+     * Redacted value placeholder.
+     *
+     * @default "[redacted]"
+     */
+    redactedValue?: string;
+}
+/**
+ * Resource configuration for OpenTelemetry
+ */
+interface ResourceConfig {
+    serviceName: string;
+    serviceVersion: string;
+}
+/**
+ * Endpoint configuration for OpenTelemetry exporters
+ */
+interface EndpointConfig {
+    traces: string;
+    logs: string;
+    metrics?: string;
+}
+/**
+ * Configuration for Node.js OpenTelemetry SDK
+ */
+interface NodeSdkConfig {
+    resource: ResourceConfig;
+    endpoints: EndpointConfig;
+    metricExportIntervalMs?: number;
+    piiConfig?: PIIConfig;
+}
+/**
+ * Configuration for Web OpenTelemetry SDK
+ */
+interface WebSdkConfig {
+    resource: ResourceConfig;
+    endpoints: EndpointConfig;
+    getEndpoints?: () => EndpointConfig;
+    piiConfig?: PIIConfig;
+}
+/**
+ * Proxy mode configuration for browser telemetry
+ */
+interface ProxyConfig {
+    serverUrl: string;
+    tracesPath?: string;
+    logsPath?: string;
+}
+/**
+ * OTel mode for browser telemetry,
+ *
+ * - "direct": Send telemetry directly to the OpenTelemetry collector
+ * - "proxy": Send telemetry through your server
+ */
+type OtelMode = "direct" | "proxy";
+/**
+ * Configuration for browser logger
+ */
+interface BrowserLoggerConfig {
+    resource: ResourceConfig;
+    logsEndpoint: string | (() => string);
+}
+/**
+ * Log level for browser logger
+ */
+type LogLevel = "debug" | "info" | "warning" | "error";
+/**
+ * Options for logging
+ */
+interface LogOptions {
+    level: LogLevel;
+    message: string;
+    annotations?: Record<string, string | number | boolean>;
+}
+/**
+ * Browser logger interface
+ */
+interface BrowserLogger {
+    debug: (message: string, annotations?: Record<string, string | number | boolean>) => void;
+    info: (message: string, annotations?: Record<string, string | number | boolean>) => void;
+    warning: (message: string, annotations?: Record<string, string | number | boolean>) => void;
+    error: (message: string, annotations?: Record<string, string | number | boolean>) => void;
+    flush: () => Promise<void>;
+}
+
+export type { BrowserLogger, BrowserLoggerConfig, EndpointConfig, LogLevel, LogOptions, NodeSdkConfig, OtelMode, ProxyConfig, ResourceConfig, WebSdkConfig };

package/dist/index.d.ts

@@ -0,0 +1,91 @@
+interface PIIConfig {
+    /**
+     * Set of span attribute keys whose values will be redacted.
+     */
+    piiAttributeKeys?: Set<string>;
+    /**
+     * Redacted value placeholder.
+     *
+     * @default "[redacted]"
+     */
+    redactedValue?: string;
+}
+/**
+ * Resource configuration for OpenTelemetry
+ */
+interface ResourceConfig {
+    serviceName: string;
+    serviceVersion: string;
+}
+/**
+ * Endpoint configuration for OpenTelemetry exporters
+ */
+interface EndpointConfig {
+    traces: string;
+    logs: string;
+    metrics?: string;
+}
+/**
+ * Configuration for Node.js OpenTelemetry SDK
+ */
+interface NodeSdkConfig {
+    resource: ResourceConfig;
+    endpoints: EndpointConfig;
+    metricExportIntervalMs?: number;
+    piiConfig?: PIIConfig;
+}
+/**
+ * Configuration for Web OpenTelemetry SDK
+ */
+interface WebSdkConfig {
+    resource: ResourceConfig;
+    endpoints: EndpointConfig;
+    getEndpoints?: () => EndpointConfig;
+    piiConfig?: PIIConfig;
+}
+/**
+ * Proxy mode configuration for browser telemetry
+ */
+interface ProxyConfig {
+    serverUrl: string;
+    tracesPath?: string;
+    logsPath?: string;
+}
+/**
+ * OTel mode for browser telemetry,
+ *
+ * - "direct": Send telemetry directly to the OpenTelemetry collector
+ * - "proxy": Send telemetry through your server
+ */
+type OtelMode = "direct" | "proxy";
+/**
+ * Configuration for browser logger
+ */
+interface BrowserLoggerConfig {
+    resource: ResourceConfig;
+    logsEndpoint: string | (() => string);
+}
+/**
+ * Log level for browser logger
+ */
+type LogLevel = "debug" | "info" | "warning" | "error";
+/**
+ * Options for logging
+ */
+interface LogOptions {
+    level: LogLevel;
+    message: string;
+    annotations?: Record<string, string | number | boolean>;
+}
+/**
+ * Browser logger interface
+ */
+interface BrowserLogger {
+    debug: (message: string, annotations?: Record<string, string | number | boolean>) => void;
+    info: (message: string, annotations?: Record<string, string | number | boolean>) => void;
+    warning: (message: string, annotations?: Record<string, string | number | boolean>) => void;
+    error: (message: string, annotations?: Record<string, string | number | boolean>) => void;
+    flush: () => Promise<void>;
+}
+
+export type { BrowserLogger, BrowserLoggerConfig, EndpointConfig, LogLevel, LogOptions, NodeSdkConfig, OtelMode, ProxyConfig, ResourceConfig, WebSdkConfig };

package/dist/index.js

@@ -0,0 +1 @@
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}