canon-signal 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+All notable changes to canon-signal will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Initial release of canon-signal — opinionated OpenTelemetry toolkit for Node.js/TypeScript
+- `createSignal<T>()` factory with closure-based state, fully typed against the user's `AppAttributes` interface
+- Full `signal.*` API: `attr`, `attrs`, `getAttr`, `traceId`, `span`, `trace`, `link`, `event`, `error`, `keep`, `log`, `systemLog`, `meter`, `schema`, `shutdown`
+- Framework middleware for Hono, Express, Fastify, and Next.js
+- Auto-instrumentation via `@opentelemetry/auto-instrumentations-node` (37 instrumentations)
+- Custom tail-sampling SpanProcessor with deterministic hashing
+- DB summary SpanProcessor that auto-computes `app.db.total_duration_ms` and `app.db.query_count`
+- Pretty-console exporter for dev waterfall rendering
+- File, console, OTLP, and ring-buffer exporters
+- Logger bridges for Pino and Winston
+- Test harness with typed assertions
+- CLI: `create`, `install-docs`, `tutorial`, `inspect`, `report-issue`
+- Single-file HTML tutorial at `resources/tutorial/canon-signal-tutorial.html`
+- Agent documentation suite at `resources/` (CONSTITUTION, PLAYBOOK, API, PATTERNS, ANTI_PATTERNS, TROUBLESHOOTING)
+- Telemetry constitution documenting trace-first observability principles
+- Environment variable overrides: `OTEL_SERVICE_NAME`, `OTEL_RESOURCE_ATTRIBUTES`, `OTEL_EXPORTER_OTLP_ENDPOINT`, `OTEL_EXPORTER_OTLP_HEADERS`, `CANON_SIGNAL_SAMPLE_RATE`, `CANON_SIGNAL_DEBUG`
+- Discriminated union for `ExporterConfig` so the type system enforces required fields per exporter kind
+- 64 unit tests covering the full public API
+
+[Unreleased]: https://github.com/derekurban/canon-signal/compare/v0.1.0...HEAD

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 canon-signal contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.