@abyss-project/monitor

中文文档
23.5.0发布于 2026/11/08ISCTypeScriptESM + CJS近 30 天下载 6066

Core package to interact with Abyss-Monitor

原始使用文档
文档目录5 节
  1. Installation
  2. Liens
  3. Usage
  4. Livraison fiable des logs
  5. Support

Abyss Monitor

@abyss-project/monitor

Supervision applicative : logs, événements, alertes, Sentinels et Cron Tasks.

Application monitoring: logs, events, alerts, Sentinels and Cron Tasks.

Installation

npm install @abyss-project/monitor
# or
pnpm add @abyss-project/monitor

Liens

Usage

Voir la documentation produit pour les guides d'utilisation, la configuration du Core, les exemples d'appel et la référence des permissions.

Livraison fiable des logs

Depuis la version portant le pipeline de logs fiable (SP-1), le Logger n'envoie plus un POST par ligne : les logs sont mis en file, regroupés en lots (100 lignes ou 1 Mo, toutes les 500 ms) puis envoyés à POST /application-log/:applicationId/bulk. En cas de coupure réseau ou de crash du process, les lots en attente sont conservés sur disque et rejoués, et un lot rejoué est dédupliqué côté serveur par clientLogId. Ce qui peut encore se perdre est borné : les lignes jetées par une file saturée (10 000 lignes ou 32 Mo en mémoire), évincées d'un spool plein (64 Mo) ou refusées définitivement par le serveur sont comptées, et ce nombre est remonté au serveur avec le lot suivant ; les lignes encore en mémoire quand le process est tué sans arrêt propre (SIGKILL, OOM) — celles émises depuis le dernier flush, 500 ms d'ordinaire, davantage pendant un envoi en cours — meurent avec lui sans être comptées.

AbyssMonitorCore.setConfig({
  // ... vos options habituelles
  shipper: {
    spoolDirectory: '/var/lib/my-app/abyss-monitor-spool', // ou ABYSS_MONITOR_SPOOL_DIR
  },
});

Sur Kubernetes/k3s, le répertoire par défaut (le répertoire temporaire du système) ne survit pas à un redémarrage de conteneur : montez un volume sur le chemin donné à ABYSS_MONITOR_SPOOL_DIR pour que les logs en attente survivent au redémarrage. Un emptyDir survit au redémarrage d'un conteneur, pas au remplacement du pod (déploiement, drain d'un nœud) : seul un volume persistant couvre ce cas. Chaque application écrit dans son propre sous-dossier, <ABYSS_MONITOR_SPOOL_DIR>/<applicationId>/.

Dans les tests d'un service consommateur, désactivez le spool — shipper: { spoolDirectory: null } — ou pointez ABYSS_MONITOR_SPOOL_DIR vers un répertoire temporaire propre au run : sinon les tests écrivent dans le spool réel de la machine. Un process qui n'appelle jamais setConfig avec un applicationId et un secretPublishToken garde ses logs en mémoire, jusqu'à 10 000 lignes ou 32 Mo, en attendant une identité qui ne vient pas.

Détails complets — options du shipper, contrat de l'endpoint bulk, ce que la fiabilisation garantit et ne garantit pas — dans la documentation du Logger.

Support

Pour toute demande, ouvrir un ticket depuis l'application Abyss.

版本与发布记录

@abyss-project/monitor 共发布 153 个版本,首次发布于 2024/09/25;过去 12 个月发布了 122 个版本。

版本发布日期距今
23.5.0latest2026/11/08今天
23.4.02026/11/07今天
23.3.02026/11/07今天
23.2.02026/11/061 天前
23.1.02026/11/061 天前
23.0.02026/11/043 天前

其他发布通道:demo-662 → 16.7.0,release-21 → 21.3.0。

关于 @abyss-project/monitor 的常见问题

@abyss-project/monitor 是什么?

Core package to interact with Abyss-Monitor

如何安装 @abyss-project/monitor?

在项目目录运行 npm install @abyss-project/monitor,或使用 pnpm add / yarn add / bun add。

@abyss-project/monitor 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@abyss-project/monitor 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@abyss-project/monitor 可以商用吗?

@abyss-project/monitor 使用 ISC 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@abyss-project/monitor 的下载量有多少?

根据 npm 官方下载统计,@abyss-project/monitor 在 2026/10/05 – 2026/11/03 这 30 天内被下载 6,066 次,日均约 202 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@abyss-project/monitor 还在维护吗?

最新版本 23.5.0 发布于 2026/11/08(今天);至今共发布 153 个版本,其中过去 12 个月发布了 122 个;首次发布于 2024/09/25。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。