@helyx/module-logging
v1.1.14
Published
Configurable Discord activity logging for Helyx.
Downloads
2,156
Maintainers
Readme
Logging module
An official Helyx Insights module that posts customer-visible activity records from other enabled Helyx modules.
Behaviour
Server managers choose one text or announcement channel for Helyx activity records. Modules declare a bounded catalogue of safe logging events through the SDK. Logging accepts only declared events, renders event summaries and details as plain text, and disables all implicit Discord mentions.
Each source module exposes a Logging dashboard tab. If Logging is not installed, the tab explains that it is unavailable. If Logging is installed but disabled, the tab offers an Enable Logging action. When enabled, the tab lets a server manager turn each declared event on or off. Events use their declared default until an override is saved.
The Logging module is disabled by default. Enabling it without choosing a destination does not discard or queue activity; events remain undelivered until valid configuration exists.
Data boundaries
The module stores no copies of Discord messages, feedback text, suggestion text, usernames, or activity payloads in PostgreSQL. Discord owns the delivered log messages. Core platform persistence stores only per-server event switches with optimistic versions because those switches coordinate several independent modules.
Operational application logs remain separate from customer-visible activity records. Disabling this module stops customer-visible delivery but does not suppress Helyx's security, error, audit, or operational telemetry.
Package and deployment boundaries
The package imports only approved Helyx contracts. It never imports Discord.js, a database driver, application-private code, or hosted-only infrastructure. Discord delivery and policy persistence are supplied by the bot's SDK adapter, so the same module package can run in hosted and future self-hosted compositions.
The package includes compiled output, its manifest, README, and proprietary notice in its npm allowlist. Publication is restricted to the repository's explicit release plan, clean-tree checks, tarball inspection, and registry verification.
Required Discord access
Helyx needs VIEW_CHANNEL and SEND_MESSAGES in the configured destination. Logging does not need Message Content, Presence, or any additional privileged gateway intent.
