Référence d'API — nodefony/syslog

stable

Documentation › Référence d’API › nodefony › sous-chemin-syslog

Générée depuis les déclarations de types publiées de nodefony 10.0.0-beta.5 : exactement ce que reçoit une application qui l’installe. Cette page n’existe dans aucun dépôt — pour la corriger, on corrige le TSDoc du code.

nodefony/syslog#

import { … } from "nodefony/syslog" — 14 symboles.

Fonctions (9)#

accessStatusFamily#

function accessStatusFamily(status: number | null): number | null

La famille d’un statut d’accès, de 1 à 5 comme un statut HTTP — y compris pour un code de fermeture WebSocket (RFC 6455 §7.4), qui sinon passerait pour une erreur serveur à quatre chiffres.

consoleRequestIds#

function consoleRequestIds(lines: Iterable<IConsoleLine>): Set<string> | null

Les requêtes de la console présentes dans un lot de lignes : celles dont UNE ligne vise la console. Les autres lignes d’une requête ne portent que son requestId — c’est par lui qu’on les écarte avec elle.

frameIndexOf#

function frameIndexOf(id: string, connection: string): number | null

Le rang de la frame si id en est une de connection, sinon null — un identifiant qui ne fait que COMMENCER comme la connexion n’en est pas une.

parseAccessLine#

function parseAccessLine(pdu: Pick<IPduLike, "msgid" | "payload">): IAccessLine | null

Lit une ligne d’accès (msgid "req") : verbe, statut, chemin, durée — la seule lecture de ce format, que les Journaux de la console et la barre de débogage partagent.

pduFlowStep#

function pduFlowStep(pdu: FlowClassifiable): FlowStepId | null

Classe un Pdu en étape de cycle de vie (id stable) ou null si la ligne n’est pas un jalon (log applicatif libre, ex. DB-DEMO). PUR, isomorphe, 0 état — réutilisé par le filtre back (filterPdus) ET le rendu front (colonne « Étape » + sélecteur) → une SEULE logique, jamais de divergence.

pduIsConsoleRequest#

function pduIsConsoleRequest(line: IConsoleLine, ids: ReadonlySet<string> | null): boolean

Dit si une ligne appartient au trafic de la console : elle-même (cf pduIsConsoleTraffic), une ligne d’un appel marqué par l’outillage (isToolingRequestId), ou une ligne d’une requête de la console.

pduIsConsoleTraffic#

function pduIsConsoleTraffic(pdu: Pick<IPduLike, "msgid" | "payload" | "severity">): boolean

Dit si un Pdu est du trafic de la console d’administration — ce que l’exploitant ne cherche pas en lisant les journaux de son application : une ligne qui porte l’URL de la requête (ligne d’accès msgid "req", ou ligne URL : … du journal de requête, ouverture et fermeture WebSocket comprises) vers un chemin de la console, ou ce que le serveur Vite écrit sous le niveau WARNING (msgid "frontend" : démarrage, rechargement à chaud).

pduIsModuleExcluded#

function pduIsModuleExcluded(pdu: Pick<IPduLike, "moduleName" | "msgid" | "payload">, excludedLc: string | null): boolean

Dit si une ligne tombe sous l’exclusion d’un module (excludeModule) : même nom, sans tenir compte de la casse — sauf la ligne qui porte l’URL de la requête. Celle-ci appartient à l’application même quand le framework l’écrit (le journal d’accès est signé NODEFONY) : masquer le framework ne doit jamais masquer les requêtes, sans quoi la vue se vide entièrement.

pduProtocol#

function pduProtocol(pdu: Pick<IPduLike, "msgid">): LogProtocol

Classe un Pdu par protocole d’origine — "ws" ou "http" — de façon PURE, isomorphe et 0-alloc (une seule comparaison de msgid).

Constantes (1)#

FLOW_STEPS#

const FLOW_STEPS: Record<FlowStepId, FlowStepMeta>

Table des étapes — source unique de l’ordre et de l’appartenance protocole, partagée back (filtre) et front (sélecteur groupé HTTP / WebSocket / Commun).

Interfaces (2)#

FlowStepMeta#

interface FlowStepMeta

Métadonnée structurelle d’une étape (jamais de présentation : libellé FR et couleur vivent côté front, qui mappe l’id). order = rang logique dans le cycle de SON protocole ; protocol = où l’étape apparaît ("both" = session).

• order: number — Rang logique dans le cycle (tri du sélecteur d’étapes).
• protocol: LogProtocol | "both" — Protocole d’appartenance — pilote le sélecteur adaptatif côté Studio.

IAccessLine#

interface IAccessLine

Une ligne d’accès lue : ce qu’il faut voir d’une requête d’un coup d’œil.

• method: string — GET, POST… ou WS pour une connexion WebSocket.
• status: number | null — Statut HTTP, ou code de fermeture WebSocket (1000…) sur une ligne WS ; null quand la ligne n’en porte pas (---).
• path: string — Chemin et requête (/api/users?page=2), sans schéma ni hôte.
• url: string — L’URL telle qu’écrite (wss://h/socket), schéma et hôte compris.
• duration: string | null — Durée telle qu’écrite (3.21ms), null si absente.
• ip: string | null — Adresse du client, null si absente.

Types (2)#

FlowStepId#

type FlowStepId = "request-in" | "body-received" | "route-matched" | "kernel-dispatch" | "response" | "request-end" | "finish" | "ws-open" | "ws-message" | "ws-close" | "session" | "session-saved"

Étape logique du cycle de vie d’une requête / connexion — identifiant STABLE (clé de filtre côté back ET clé de mapping libellé/couleur côté front).

LogProtocol#

type LogProtocol = "ws" | "http"

Protocole d’origine d’un enregistrement de log.

← Toutes les références d’API