====== 3DM Publisher Logging ====== 3DM Publisher offers 3 levels of optional activity logging, configurable from the Console System page : * No logging * File logging * Database logging Security audit logging is mandatory and remains active at every level, including ''No logging''. See [[#security_audit_events|Security Audit Events]] below. Usage pages in the Console are only available when at least File logging is active. Some logging events can only be stored in a database, so need ''Database Logging'' to work. * Viewer Report a Problem * Viewer Photo Annotations Sidebar * Viewer Telemetry Viewer Telemetry needs to be explicitly enabled from the Console System page. ===== Global conventions ===== Unknown identities use user ID ''-1'' and an empty username; the built-in administrator uses ID ''0''. ===== Server Uptime ===== Table: ''log_publisher_up_time'' Logs the uptime of the server, every 5 minutes. ===== Server Throughput ===== Table: ''log_publisher_throughput'' Logs the amount of data that passed through the server (HTTP and WebSocket traffic combined) in bytes. A record is logged every 5 minutes. ===== Publication Monitoring Events ===== Table: ''log_publisher_publication_events'' This table contains events that are valuable to an administrator. * Failure to Create Guest session due to publication limit reached * Failure to Create Guest session due to server limit reached * Login failure due to Wrong credentials * Login failure due to No permission * Publication session threshold warning reached * Server session threshold warning reached Session threshold warnings can be configured in the Console System page. ===== Publication Logins ===== Table: ''log_publisher_publication_logins'' On Publication login, a record is saved here with Publication and User context. Also includes the guest session pressure at login time (on server level and publication level). ===== Publication Sessions ===== Table: ''log_publisher_publication_sessions'' On session close, a record is saved here with conclusive information on the session that just completed. Includes session context information like username, IP, publication. ===== Viewer Report a Problem Reports ===== Table: ''log_publisher_report'' When a user sends a problem report on a photo the server, it is stored here. ===== Viewer Photo Annotation Sidebar ===== Table: ''log_publisher_photo_annotation'' When the user interacts with the Photo Annotation sidebar and creates or edits annotations, they end up in this table. ===== Viewer Telemetry ===== Table: ''log_publisher_telemetry_events'' Since version 26.2.0, you can enable Viewer Telemetry logging from the Console.\\ Once enabled, viewers that open after the setting was set to true, will post the following information : * Open Workspace Timing * Open Resource Timing ===== Security Audit Events ===== Table: ''log_publisher_security_events'' Records security-sensitive authentication and account-security events. This audit trail is separate from optional activity logging and Publication Monitoring Events. It cannot be disabled by selecting ''No logging'' or excluding the table from optional logging. === Recorded Events === * Authenticator enrolment, replacement and removal. * Recovery-code regeneration and successful use of a saved recovery code. * Administrator issuance of an assisted-recovery authorisation and its redemption. * Enabling or disabling the policy that allows first-time authenticator enrolment. * Rejected security operations, including password and authenticator verification failures, invalid or expired security contexts and rate-limit rejections. This is not a complete log of every authentication step: ordinary successful password and authenticator-code verification do not create security audit rows. Initial recovery-code creation is included in the authenticator enrolment or replacement event, rather than a separate regeneration event. === Record Contents === ^ Fields ^ Description ^ | ''id'' | Record identifier within the storage table. | | ''timestamp'', ''date_time'' | Event time as Unix milliseconds and an ISO 8601 UTC date-time. | | ''action'', ''outcome'' | Attempted operation and result: ''success'' or ''rejected''. | | ''actor_user_id'', ''actor_username'' | Verified identity of the person performing the operation, when known. | | ''target_user_id'', ''target_user_name'' | Resolved account affected by the operation, when known. | | ''ip_address'' | Originating request IP address, when available. | | ''purpose'' | Validated workflow: ''login'', ''security'' or ''recovery''; otherwise empty. | | ''factor_type'' | Credential classification: ''password'', ''totp'', ''recovery_code'' or ''authorization_code''; otherwise empty. | | ''reason_code'' | Machine-readable rejection classification, when applicable. | | ''reason'' | Administrator's identity-verification reason for assisted recovery, when applicable. | === Storage and Availability === In ''File logging'' mode, security events are written to ''logs/log_publisher_security_events.log'' beneath the Publisher service data directory. With ''No logging'' selected, mandatory security events still use the configured destination even though optional activity logging is disabled. In ''Database logging'' mode, Publisher uses the configured database and falls back to the local security log if database delivery fails. Database and local files may therefore contain different portions of the audit history: inspect and retain both. The local fallback remains available for security events even when optional tables are configured not to fall back to files. === Offline Operator Log === Offline operator factor resets are recorded separately in ''security-private/operator-audit.log'' beneath the Publisher service data directory, not in ''log_publisher_security_events''. The operator tool's ''list-log'' command reads this separate per-account reset history only; it does not read the online security table or runtime logs.