Skip to content

CHANGELOG.md

Latest commit

 

History

History
122 lines (95 loc) · 6.16 KB

CHANGELOG.md

File metadata and controls

122 lines (95 loc) · 6.16 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.6.0] - 2026-02-28

Added

  • OTLP Span Events: Breadcrumbs are now automatically converted to OTLP Span Events, providing a detailed timeline of events within the trace viewer.
  • Child Spans API: New startChildSpan() and finishChildSpan() APIs in @logtide/core to create hierarchical spans for operations like DB queries or external API calls.
  • Rich Span Attributes: Added standardized attributes to request spans across all frameworks:
    • http.user_agent, net.peer.ip, http.query_string (at start)
    • http.status_code, duration_ms, http.route (at finish)
  • Express Error Handler: Exported logtideErrorHandler to capture unhandled errors and associate them with the current request scope.

Changed

  • Enriched Breadcrumbs: Request/Response breadcrumbs now include more metadata (method, url, status, duration_ms) by default.
  • Improved Nuxt Tracing: Nitro plugin now accurately captures response status codes and durations.
  • Improved Angular Tracing: LogtideHttpInterceptor now captures status codes for both successful and failed outgoing requests.

Fixed

  • Fixed a bug in Nuxt Nitro plugin where spans were always marked as 'ok' regardless of the actual response status.

0.5.6 - 2026-02-08

Changed

DSN Simplified

  • Removed redundant projectId from DSN format — the API key already embeds the project ID
  • New DSN format: https://lp_APIKEY@host (legacy format with path still accepted for backward compatibility)
  • Added apiUrl + apiKey as alternative to DSN string (backward compatible with @logtide/sdk-node config format)
  • Added resolveDSN() helper that accepts either dsn or apiUrl + apiKey
  • Removed projectId field from DSN interface (@logtide/types)
  • Removed X-Project-Id header from LogtideHttpTransport and OtlpHttpTransport (@logtide/core)

Dynamic Service Name

  • service in ClientOptions is now optional — each framework package defaults to its own name ('express', 'fastify', 'hono', 'elysia', 'nextjs', 'sveltekit', 'nuxt', 'angular')
  • Added service?: string field and setService() method to Scope — allows overriding service name per-request or per-module
  • Service resolution chain: scope.service → options.service → framework default → 'unknown'

Mock Server

  • Removed X-Project-Id from CORS headers and request tracking

Documentation

  • Updated DSN format examples across all package READMEs

0.5.5 - 2026-02-07

Added

Monorepo Structure

  • Restructured as pnpm monorepo with 9 packages under packages/*
  • Unified versioning across all packages (0.5.5)
  • Version bump script (pnpm version:set <version>)

Core (@logtide/core)

  • LogtideClient — capture logs, errors, breadcrumbs, and spans
  • Hub — global singleton for convenient access
  • Scope — per-request context isolation with tags, extras, and breadcrumbs
  • SpanManager — distributed tracing with W3C Trace Context (traceparent)
  • BatchTransport — automatic batching with retry logic and circuit breaker
  • LogtideHttpTransport and OtlpHttpTransport for log and span delivery
  • ConsoleIntegration — intercepts console methods, records breadcrumbs
  • GlobalErrorIntegration — captures unhandled rejections and uncaught exceptions
  • DSN parsing, error serialization, trace ID generation

Types (@logtide/types)

  • Shared TypeScript interfaces: LogEntry, Span, Breadcrumb, Transport, Integration, ClientOptions

Node.js SDK (@logtide/sdk-node)

  • Standalone Node.js client with batching, retry, circuit breaker, query API, live streaming
  • Express middleware and Fastify plugin for auto-logging HTTP requests

Next.js (@logtide/nextjs)

  • Server-side: registerLogtide() for instrumentation.ts, captureRequestError for onRequestError
  • Client-side: initLogtide(), trackNavigation() for SPA breadcrumbs
  • instrumentRequest() / finishRequest() for manual request tracing
  • App Router and Pages Router support

Nuxt (@logtide/nuxt)

  • Nuxt 3 module with zero-config setup via nuxt.config.ts
  • Nitro server plugin: request tracing, error capture via lifecycle hooks
  • Vue client plugin: errorHandler, navigation breadcrumbs
  • Runtime config injection (server + public)

SvelteKit (@logtide/sveltekit)

  • logtideHandle() — request spans, trace context propagation, scope in event.locals
  • logtideHandleError() — unexpected error capture
  • logtideHandleFetch() — traceparent propagation on server-side fetches
  • initLogtide() for client-side error handling

Hono (@logtide/hono)

  • Middleware for automatic request tracing, error capture, breadcrumbs
  • Scope accessible via c.get('logtideScope')
  • Works on Node.js, Bun, Deno, Cloudflare Workers

Angular (@logtide/angular)

  • LogtideErrorHandler — captures all uncaught Angular errors
  • LogtideHttpInterceptor — traces outgoing HTTP, injects traceparent, captures HTTP errors
  • provideLogtide() for standalone apps (Angular 17+)
  • getLogtideProviders() for NgModule-based apps

Elysia (@logtide/elysia)

  • Plugin with onRequest, onAfterHandle, onError lifecycle hooks
  • Automatic request spans, error capture, traceparent propagation
  • Registered as global plugin (.as('global'))

CI/CD

  • GitHub Actions CI: build, typecheck, test on push/PR to main/develop
  • GitHub Actions publish: npm publish on tag v*.*.*, GitHub Release, or manual dispatch
  • Publish order: types → core → all framework packages
  • Branch model: develop → main, hotfix directly to main

Documentation

  • README for every package with badges, quick start, API reference
  • Root README with package table, architecture diagram, development guide
  • Branch protection documentation (.github/BRANCH_PROTECTION.md)