hotelme-nuxt-logger 1.6.0 → 1.8.0

package/README.md

@@ -63,24 +63,20 @@ export default defineNuxtConfig({
   modules: ['@hotelme/nuxt-logger'],
 
   logger: {
-    // Назва проекту для логів
+    // Назва проекту для всіх записів (запити, помилки Nitro, SSR, клієнтські
+    // помилки, ручні logger.*). Без неї — env NUXT_PUBLIC_PROJECT_NAME на збірці,
+    // далі 'hotelme'. Env NUXT_PUBLIC_PROJECT_NAME на рантаймі перекриває її.
     projectName: 'my-project',
 
     // Увімкнути автоматичне логування запитів
     enableRequestLogging: true
-  },
-
-  // Назва потрапляє в runtimeConfig.public.projectName і використовується для всіх
-  // записів (запити, помилки Nitro, SSR, клієнтські помилки, ручні logger.*).
-  // Альтернативно через env
-  runtimeConfig: {
-    public: {
-      projectName: process.env.NUXT_PUBLIC_PROJECT_NAME || 'my-project'
-    }
   }
 })
 ```
 
+Назва лежить у приватному runtimeConfig (`logger.projectName`) і не потрапляє у
+`window.__NUXT__` (з 1.7.0). Дублювати її в `runtimeConfig.public` не треба: модуль звідти не читає.
+
 ## Використання
 
 ### Автоматичне логування запитів
@@ -164,6 +160,8 @@ logger: {
     ignorePaths: ['/nuxt_img/'],                 // + типові /_nuxt/, /_ipx/, /__nuxt, clientErrorEndpoint
     ignoreUserAgents: ['^Slackbot-LinkExpanding ', '^kube-probe/'],
     slowMs: 1000,                                // порятунок повільних, env OTEL_TRACES_SLOW_MS
+    clientSpanName: 'upstream',                  // лише якщо хостів тисячі, див. нижче
+    clientSpanPaths: ['^/api-json/[a-z_]+$'],    // шляхи, що лишаються в імені
   },
 }
 ```
@@ -194,8 +192,8 @@ OTEL_TRACES_SLOW_MS: "1000"
 
 - **Активний контекст на весь запит.** Плагін обгортає `nitroApp.h3App.handler`, тож middleware, handler'и та SSR-рендер виконуються всередині `context.with(serverSpan)` — span'и з коду застосунку стають дочірніми без обгорток.
 - **Server span** на кожен запит, батько — вхідний `traceparent`. Без нього trace id = `X-Request-ID` без дефісів (`2e285875-f20c-…` → `2e285875f20c…`, як у libwts3), якщо це UUID / 32 hex; інакше випадковий. У `event.context`: `otelSpan`; у відповіді — `X-Trace-Id`. 5xx → статус ERROR, 4xx — ні.
-- **Вихідні fetch** (native `fetch`, `$fetch`, ofetch на зовнішній URL) — `@opentelemetry/instrumentation-undici` через diagnostics_channel: CLIENT span `GET <host>` (повний URL — в `url.full`), `traceparent` і `X-Request-ID` сторінки, якщо виклик не поставив свій. Поза запитом span'и не пишуться.
-- **Внутрішні SSR-виклики** (`$fetch('/api/…')` → Nitro localFetch) ідуть у тому ж async-ланцюжку, тож span роуту стає дочірнім span'а сторінки, а logger-middleware бере reqid сторінки. Заголовки руками не потрібні.
+- **Вихідні fetch** (native `fetch`, `$fetch`, ofetch на зовнішній URL) — `@opentelemetry/instrumentation-undici` через diagnostics_channel: CLIENT span `GET <host>` (повний URL — в `url.full`; з `clientSpanName` — `GET upstream` або `GET /api-json/<module>` за `clientSpanPaths`, хост лишається в `server.address`: ім'я span'а — вимір span-метрик, а домени кобрендів дають окрему серію кожен), `traceparent` і `X-Request-ID` сторінки, якщо виклик не поставив свій. Поза запитом span'и не пишуться.
+- **Внутрішні SSR-виклики** (`$fetch('/api/…')` → Nitro localFetch) ідуть у тому ж async-ланцюжку, тож span роуту стає дочірнім span'а сторінки, а logger-middleware бере reqid сторінки. Заголовки руками не потрібні. Внутрішній підзапит на відфільтрований шлях (`/__nuxt_island/…`) span'а не отримує, але лишається в контексті сторінки — його `/api/…`-виклики стають прямими дітьми span'а сторінки.
 - **Назва span'а** — шаблон, ніколи сирий шлях (кожна назва — окремий stream у VictoriaTraces), визначається сама після роутингу:
   - сторінка → `route.name` з Vue Router без i18n-суфікса: `GET weather-citynameid`, `GET index` (аліаси теж). Локаль — в атрибуті `i18n.locale`;
   - Nitro-хендлер → шаблон з файлової структури: `GET /api/city_info`, `GET /record/**`;

package/dist/module.cjs

@@ -28,9 +28,8 @@ const module$1 = kit.defineNuxtModule({
   setup(options, nuxt) {
     const moduleDir = typeof __dirname !== "undefined" ? __dirname : path.dirname(url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('module.cjs', document.baseURI).href))));
     const resolver = kit.createResolver(moduleDir);
-    nuxt.options.runtimeConfig.public.projectName = options.projectName || process.env.NUXT_PUBLIC_PROJECT_NAME || "hotelme";
+    const projectName = options.projectName || process.env.NUXT_PUBLIC_PROJECT_NAME || "hotelme";
     const clientErrorEndpoint = options.clientErrorEndpoint || "/_logger/client-error";
-    nuxt.options.runtimeConfig.public.loggerClientErrorEndpoint = clientErrorEndpoint;
     kit.addImportsDir(resolver.resolve("./runtime"));
     kit.addServerImports([
       { name: "logger", from: resolver.resolve("./runtime/logger") },
@@ -40,6 +39,7 @@ const module$1 = kit.defineNuxtModule({
     const { enabled: otelEnabled, ignorePaths = [], ...otel } = options.otel ?? {};
     nuxt.options.runtimeConfig.logger = {
       ...nuxt.options.runtimeConfig.logger,
+      projectName,
       otel: { ...otel, ignorePaths: [.../* @__PURE__ */ new Set([...ignorePaths, clientErrorEndpoint])] }
     };
     if (options.enableRequestLogging) {
@@ -52,6 +52,11 @@ const module$1 = kit.defineNuxtModule({
       kit.addServerPlugin(resolver.resolve("./runtime/server/plugin"));
     }
     if (options.enableClientErrorLogging) {
+      kit.addTemplate({
+        filename: "hotelme-nuxt-logger.mjs",
+        getContents: () => `export const clientErrorEndpoint = ${JSON.stringify(clientErrorEndpoint)}
+`
+      });
       kit.addPlugin({
         src: resolver.resolve("./runtime/plugins/error"),
         mode: "all"

package/dist/module.d.cts

@@ -64,6 +64,19 @@ interface OtelOptions {
      * `OTEL_TRACES_SLOW_MS`. 0 — вимкнено.
      */
     slowMs?: number;
+    /**
+     * Замість hostname в імені вихідних span'ів (`GET upstream`). Ім'я span'а —
+     * вимір span-метрик: коли хостів тисячі (домени кобрендів), кожен дає окрему
+     * серію. Hostname лишається в `server.address`, URL — в `url.full`.
+     * Без опції — `GET <hostname>`.
+     */
+    clientSpanName?: string;
+    /**
+     * Regex-рядки шляхів, що лишаються в імені замість `clientSpanName`, напр.
+     * `'^/api-json/[a-z_]+$'` → `GET /api-json/hotel_info_json`. Лише обмежений
+     * набір, без id. Діє разом з `clientSpanName`.
+     */
+    clientSpanPaths?: string[];
 }
 declare const _default: any;
 

package/dist/module.d.mts

@@ -64,6 +64,19 @@ interface OtelOptions {
      * `OTEL_TRACES_SLOW_MS`. 0 — вимкнено.
      */
     slowMs?: number;
+    /**
+     * Замість hostname в імені вихідних span'ів (`GET upstream`). Ім'я span'а —
+     * вимір span-метрик: коли хостів тисячі (домени кобрендів), кожен дає окрему
+     * серію. Hostname лишається в `server.address`, URL — в `url.full`.
+     * Без опції — `GET <hostname>`.
+     */
+    clientSpanName?: string;
+    /**
+     * Regex-рядки шляхів, що лишаються в імені замість `clientSpanName`, напр.
+     * `'^/api-json/[a-z_]+$'` → `GET /api-json/hotel_info_json`. Лише обмежений
+     * набір, без id. Діє разом з `clientSpanName`.
+     */
+    clientSpanPaths?: string[];
 }
 declare const _default: any;
 

package/dist/module.d.ts

@@ -64,6 +64,19 @@ interface OtelOptions {
      * `OTEL_TRACES_SLOW_MS`. 0 — вимкнено.
      */
     slowMs?: number;
+    /**
+     * Замість hostname в імені вихідних span'ів (`GET upstream`). Ім'я span'а —
+     * вимір span-метрик: коли хостів тисячі (домени кобрендів), кожен дає окрему
+     * серію. Hostname лишається в `server.address`, URL — в `url.full`.
+     * Без опції — `GET <hostname>`.
+     */
+    clientSpanName?: string;
+    /**
+     * Regex-рядки шляхів, що лишаються в імені замість `clientSpanName`, напр.
+     * `'^/api-json/[a-z_]+$'` → `GET /api-json/hotel_info_json`. Лише обмежений
+     * набір, без id. Діє разом з `clientSpanName`.
+     */
+    clientSpanPaths?: string[];
 }
 declare const _default: any;
 

package/dist/module.json

@@ -4,7 +4,7 @@
   "compatibility": {
     "nuxt": "^3.0.0 || ^4.0.0"
   },
-  "version": "1.6.0",
+  "version": "1.8.0",
   "builder": {
     "@nuxt/module-builder": "0.8.4",
     "unbuild": "2.0.0"

package/dist/module.mjs

@@ -1,4 +1,4 @@
-import { defineNuxtModule, createResolver, addImportsDir, addServerImports, addServerHandler, addServerPlugin, addPlugin } from '@nuxt/kit';
+import { defineNuxtModule, createResolver, addImportsDir, addServerImports, addServerHandler, addServerPlugin, addTemplate, addPlugin } from '@nuxt/kit';
 import { fileURLToPath } from 'url';
 import { dirname } from 'path';
 
@@ -34,9 +34,8 @@ const module = defineNuxtModule({
   setup(options, nuxt) {
     const moduleDir = typeof __dirname !== "undefined" ? __dirname : dirname(fileURLToPath(import.meta.url));
     const resolver = createResolver(moduleDir);
-    nuxt.options.runtimeConfig.public.projectName = options.projectName || process.env.NUXT_PUBLIC_PROJECT_NAME || "hotelme";
+    const projectName = options.projectName || process.env.NUXT_PUBLIC_PROJECT_NAME || "hotelme";
     const clientErrorEndpoint = options.clientErrorEndpoint || "/_logger/client-error";
-    nuxt.options.runtimeConfig.public.loggerClientErrorEndpoint = clientErrorEndpoint;
     addImportsDir(resolver.resolve("./runtime"));
     addServerImports([
       { name: "logger", from: resolver.resolve("./runtime/logger") },
@@ -46,6 +45,7 @@ const module = defineNuxtModule({
     const { enabled: otelEnabled, ignorePaths = [], ...otel } = options.otel ?? {};
     nuxt.options.runtimeConfig.logger = {
       ...nuxt.options.runtimeConfig.logger,
+      projectName,
       otel: { ...otel, ignorePaths: [.../* @__PURE__ */ new Set([...ignorePaths, clientErrorEndpoint])] }
     };
     if (options.enableRequestLogging) {
@@ -58,6 +58,11 @@ const module = defineNuxtModule({
       addServerPlugin(resolver.resolve("./runtime/server/plugin"));
     }
     if (options.enableClientErrorLogging) {
+      addTemplate({
+        filename: "hotelme-nuxt-logger.mjs",
+        getContents: () => `export const clientErrorEndpoint = ${JSON.stringify(clientErrorEndpoint)}
+`
+      });
       addPlugin({
         src: resolver.resolve("./runtime/plugins/error"),
         mode: "all"

package/dist/runtime/middleware/logger.server.js

@@ -1,14 +1,13 @@
 import { defineEventHandler, getRequestURL } from "h3";
-import { useRuntimeConfig } from "#imports";
 import { logger, setProjectName } from "../logger.js";
+import { projectNameFromConfig } from "../server/projectName.js";
 import { v4 as uuidv4 } from "uuid";
 export default defineEventHandler(async (event) => {
   if (event.context.reqid) {
     return;
   }
   try {
-    const config = useRuntimeConfig();
-    const projectName = config.public.projectName || "hotelme";
+    const projectName = projectNameFromConfig();
     setProjectName(projectName);
     let reqid = event.node.req.headers["x-request-id"];
     if (!reqid) {

package/dist/runtime/plugins/error.js

@@ -1,9 +1,11 @@
-import { defineNuxtPlugin, useRequestEvent, useRuntimeConfig } from "#imports";
+import { defineNuxtPlugin, useRequestEvent } from "#imports";
+import { clientErrorEndpoint } from "#build/hotelme-nuxt-logger.mjs";
 import { logger, setProjectName } from "../logger.js";
+import { projectNameFromConfig } from "../server/projectName.js";
 import { isBrowserExtensionError } from "../browserExtensionFilter.js";
 export default defineNuxtPlugin((nuxtApp) => {
   if (import.meta.server) {
-    setProjectName(useRuntimeConfig().public.projectName);
+    setProjectName(projectNameFromConfig());
     const event = useRequestEvent();
     const reqid = event?.context?.reqid;
     const request = event?.path;
@@ -28,11 +30,10 @@ export default defineNuxtPlugin((nuxtApp) => {
     });
     return;
   }
-  const endpoint = useRuntimeConfig().public.loggerClientErrorEndpoint || "/_logger/client-error";
   const post = (msg, payload) => {
     if (isBrowserExtensionError(payload)) return;
     try {
-      fetch(endpoint, {
+      fetch(clientErrorEndpoint, {
         method: "POST",
         headers: { "content-type": "application/json" },
         body: JSON.stringify({

package/dist/runtime/server/otel/clientSpanName.d.ts

@@ -0,0 +1,26 @@
+/** Налаштування імені вихідних (CLIENT) span'ів, див. `clientSpanName`. */
+export interface ClientSpanNaming {
+    /**
+     * Замість hostname в імені: `GET upstream`. Без нього ім'я — `GET <hostname>`.
+     * Hostname лишається в `server.address`.
+     */
+    clientSpanName?: string;
+    /**
+     * Regex-рядки шляхів, які можна лишити в імені (`^/api-json/[a-z_]+$`) —
+     * лише обмежений набір, без id. Діє разом з `clientSpanName`; решта шляхів
+     * отримують `clientSpanName`.
+     */
+    clientSpanPaths?: string[];
+}
+/**
+ * Ім'я вихідного HTTP-span'а. Ім'я span'а — вимір span-метрик, тож hostname у
+ * ньому (домен кобренда в hotel-renderer) дає окрему серію на кожен домен.
+ *
+ * - без `clientSpanName` — `METHOD hostname`, як у 1.6.2;
+ * - шлях з `clientSpanPaths` — `METHOD /path`;
+ * - решта — `METHOD <clientSpanName>`.
+ *
+ * Чиста функція без `#imports`: нею користуються й проєкти, які самі відкривають
+ * CLIENT span (raw `node:http`).
+ */
+export declare function clientSpanName(method: string, origin: string, path: string, naming?: ClientSpanNaming): string;

package/dist/runtime/server/otel/clientSpanName.js

@@ -0,0 +1,15 @@
+const compiled = /* @__PURE__ */ new WeakMap();
+function patterns(paths) {
+  let regexps = compiled.get(paths);
+  if (!regexps) {
+    regexps = paths.map((path) => new RegExp(path));
+    compiled.set(paths, regexps);
+  }
+  return regexps;
+}
+export function clientSpanName(method, origin, path, naming = {}) {
+  const { clientSpanName: label, clientSpanPaths = [] } = naming;
+  if (!label) return `${method} ${new URL(origin).hostname}`;
+  const pathname = path.split("?")[0];
+  return `${method} ${patterns(clientSpanPaths).some((re) => re.test(pathname)) ? pathname : label}`;
+}

package/dist/runtime/server/otel/config.d.ts

@@ -1,6 +1,7 @@
 import { type Sampler } from '@opentelemetry/sdk-trace-base';
+import type { ClientSpanNaming } from './clientSpanName.js';
 /** Серіалізована форма `logger.otel` з nuxt.config (див. module.ts). */
-export interface OtelRuntimeConfig {
+export interface OtelRuntimeConfig extends ClientSpanNaming {
     ignorePaths?: string[];
     ignoreStaticAssets?: boolean;
     ignoreUserAgents?: string[];

package/dist/runtime/server/otel/plugin.js

@@ -1,5 +1,4 @@
 import { defineNitroPlugin } from "nitropack/runtime";
-import { useRuntimeConfig } from "#imports";
 import { context, diag, DiagLogLevel, propagation, trace } from "@opentelemetry/api";
 import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
 import { BatchSpanProcessor } from "@opentelemetry/sdk-trace-base";
@@ -9,9 +8,11 @@ import { registerInstrumentations } from "@opentelemetry/instrumentation";
 import { UndiciInstrumentation } from "@opentelemetry/instrumentation-undici";
 import { logger } from "../../logger.js";
 import { currentRequestEvent, requestIdOf } from "../requestContext.js";
+import { projectNameFromConfig } from "../projectName.js";
 import { serverSpanContext } from "./serverSpan.js";
 import { requestIdGenerator } from "./requestTraceId.js";
-import { envSampler, otelSampling } from "./config.js";
+import { envSampler, otelRuntimeConfig, otelSampling } from "./config.js";
+import { clientSpanName } from "./clientSpanName.js";
 import { ForceSampler, HeadSampler, SlowTraceSpanProcessor } from "./sampling.js";
 const diagLogger = {
   error: (message, ...args) => logger.error("otel_diag", { error: message, args }),
@@ -35,7 +36,7 @@ function undiciInstrumentation() {
   return new UndiciInstrumentation({
     requireParentforSpans: true,
     requestHook: (span, request) => {
-      span.updateName(`${request.method} ${new URL(request.origin).hostname}`);
+      span.updateName(clientSpanName(request.method, request.origin, request.path, otelRuntimeConfig()));
       const reqid = requestIdOf(currentRequestEvent());
       if (reqid && !hasHeader(request, "x-request-id")) request.addHeader("x-request-id", reqid);
     }
@@ -48,7 +49,7 @@ export default defineNitroPlugin((nitroApp) => {
     return;
   }
   diag.setLogger(diagLogger, DiagLogLevel.WARN);
-  const serviceName = process.env.OTEL_SERVICE_NAME || String(useRuntimeConfig().public.projectName || "hotelme");
+  const serviceName = process.env.OTEL_SERVICE_NAME || projectNameFromConfig();
   const batchProcessor = new BatchSpanProcessor(new OTLPTraceExporter(), {
     maxQueueSize: 2048,
     maxExportBatchSize: 512,

package/dist/runtime/server/otel/serverSpan.d.ts

@@ -19,6 +19,8 @@ declare module 'h3' {
  * невибраний контекст, а не просто відсутність span'а: інакше їхні внутрішні
  * /api-виклики, вихідні fetch і span'и бекенда стали б осиротілими
  * root-трейсами. Дочірні запити успадковують його через parent-based семплер.
+ * Виняток — внутрішній підзапит з локальним span'ом у контексті: він
+ * лишається в контексті сторінки без власного span'а.
  *
  * `?force_otel=1` (як у libwts3) — трейс вибраний попри фільтри, частку
  * семплера й вхідний `traceparent …-00`, root з `sampling.kept_by: "force"`.

package/dist/runtime/server/otel/serverSpan.js

@@ -26,6 +26,8 @@ export function serverSpanContext(event) {
   if (isTracingSuppressed(active)) return active;
   const forced = new URLSearchParams(query).get("force_otel") === "1";
   if (!forced && (settings.ignoreUserAgent?.test(userAgent) || settings.ignorePaths.some((prefix) => pathname.startsWith(prefix)) || settings.ignoreStaticAssets && STATIC_ASSET.test(pathname))) {
+    const parent = trace.getSpan(active)?.spanContext();
+    if (parent && !parent.isRemote && isSpanContextValid(parent)) return active;
     return unsampledContext(active);
   }
   const carrier = {};

package/dist/runtime/server/otel/tracing.d.ts

@@ -1,5 +1,6 @@
 import type { H3Event } from 'h3';
 import type { Span } from '@opentelemetry/api';
+export { clientSpanName, type ClientSpanNaming } from './clientSpanName.js';
 declare module 'h3' {
     interface H3EventContext {
         otelSpan?: Span;

package/dist/runtime/server/otel/tracing.js

@@ -1,4 +1,5 @@
 import { currentRequestEvent, requestIdOf } from "../requestContext.js";
+export { clientSpanName } from "./clientSpanName.js";
 export function traceHeaders(event = currentRequestEvent()) {
   const reqid = requestIdOf(event);
   return reqid ? { "X-Request-ID": reqid } : {};

package/dist/runtime/server/plugin.js

@@ -1,9 +1,9 @@
 import { defineNitroPlugin } from "nitropack/runtime";
-import { useRuntimeConfig } from "#imports";
 import { logger, setProjectName } from "../logger.js";
+import { projectNameFromConfig } from "./projectName.js";
 import { httpStatusOf, isClientError, errorText } from "../httpError.js";
 export default defineNitroPlugin((nitroApp) => {
-  setProjectName(useRuntimeConfig().public.projectName);
+  setProjectName(projectNameFromConfig());
   nitroApp.hooks.hook("error", (error, ctx) => {
     const event = ctx?.event;
     const req = event?.node?.req;

package/dist/runtime/server/projectName.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Назва проекту з nuxt.config (`logger.projectName`). Лежить у приватному
+ * runtimeConfig (`logger.projectName`), бо потрібна лише серверу: з
+ * `runtimeConfig.public` вона потрапляла у window.__NUXT__.
+ *
+ * Env `NUXT_PUBLIC_PROJECT_NAME` на рантаймі перекриває її, як і до 1.7.0, коли
+ * назва лежала в `runtimeConfig.public.projectName`.
+ */
+export declare function projectNameFromConfig(): string;

package/dist/runtime/server/projectName.js

@@ -0,0 +1,4 @@
+import { useRuntimeConfig } from "#imports";
+export function projectNameFromConfig() {
+  return process.env.NUXT_PUBLIC_PROJECT_NAME || useRuntimeConfig().logger?.projectName || "hotelme";
+}

package/dist/runtime/server/routes/client-error.post.js

@@ -1,7 +1,7 @@
 import { defineEventHandler, readBody } from "h3";
-import { useRuntimeConfig } from "#imports";
 import { logger } from "../../logger.js";
 import { isBrowserExtensionError } from "../../browserExtensionFilter.js";
+import { projectNameFromConfig } from "../projectName.js";
 export default defineEventHandler(async (event) => {
   const body = await readBody(event).catch(() => ({}));
   const { msg, ...rest } = body || {};
@@ -10,7 +10,7 @@ export default defineEventHandler(async (event) => {
   }
   logger.error(typeof msg === "string" && msg ? msg : "client_error", {
     reqid: event.context.reqid,
-    project: useRuntimeConfig().public.projectName,
+    project: projectNameFromConfig(),
     domain: event.node.req.headers.host,
     referer: event.node.req.headers.referer,
     user_agent: event.node.req.headers["user-agent"],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hotelme-nuxt-logger",
-  "version": "1.6.0",
+  "version": "1.8.0",
   "description": "Стандартний logger для Nuxt проектів з JSON виводом сумісним з бекенд-логами",
   "keywords": [
     "nuxt",