Logging Section Migration by Ethan-Arrowood · Pull Request #450 · HarperFast/documentation

Ethan-Arrowood · 2026-03-03T18:46:57Z

Logging Section Migration

Summary

Migration of Logging documentation from versioned_docs/ into the new v4 consolidated reference structure.

Files Created

reference_versioned_docs/version-v4/logging/overview.md
reference_versioned_docs/version-v4/logging/configuration.md
reference_versioned_docs/version-v4/logging/api.md
reference_versioned_docs/version-v4/logging/operations.md

Source Files Used

`logging/overview.md`

versioned_docs/version-4.7/administration/logging/index.md (primary)
versioned_docs/version-4.7/administration/logging/standard-logging.md (log format, levels, threads, stdStreams, rotation)
release-notes/v4-tucker/4.1.0.md (confirmed logging consolidated into hdb.log)
release-notes/v4-tucker/4.6.0.md (confirmed per-component logging, Node.js Console API basis)

`logging/configuration.md`

versioned_docs/version-4.7/deployments/configuration.md (logging section, lines 858–1065, primary)
versioned_docs/version-4.7/administration/logging/standard-logging.md (rotation, stdStreams, clustering)
release-notes/v4-tucker/4.2.0.md (confirmed auditAuthEvents.logFailed/logSuccessful added)
release-notes/v4-tucker/4.6.0.md (confirmed per-component logging, dynamic reload, HTTP logging)

`logging/api.md`

versioned_docs/version-4.7/reference/globals.md (logger global, primary)
versioned_docs/version-4.7/administration/logging/standard-logging.md (context)
release-notes/v4-tucker/4.6.0.md (confirmed Node.js Console API basis)

`logging/operations.md`

versioned_docs/version-4.7/developers/operations-api/logs.md (primary — read_log operation)
versioned_docs/version-4.7/administration/logging/standard-logging.md (context)

Version Annotations Added

High Confidence (Confirmed via release notes)

Logging consolidated into hdb.log: v4.1.0
auditAuthEvents.logFailed / logSuccessful: v4.2.0
Per-component logging (logging.external, etc.): v4.6.0
Dynamic logging reload without restart: v4.6.0
Logger based on Node.js Console API: v4.6.0
Standard streams no longer include timestamps: v4.6.0

Needs Verification

logger global availability: Listed as available since v4.1.0 (when components were introduced) but the Node.js Console API basis was confirmed in v4.6.0. The exact version the logger global was first available may need verification.

Scope Decision

Audit logging and transaction logging operations (read_audit_log, read_transaction_log, delete_audit_logs_before, delete_transaction_logs_before) are not included here — they belong in the Database / Transaction Logging section as planned. The logging/operations.md page covers only read_log (standard Harper log). The logging/configuration.md page covers logging.auditLog: true/false but redirects readers to the database section for audit log details.

Link Placeholders Created

See migration-context/link-placeholders/logging-link-placeholders.md for complete list.

Summary:

4 placeholders to database/transaction.md
2 placeholders to configuration/overview.md
1 placeholder to http/configuration.md (already exists — can be resolved now)
1 placeholder to operations-api/overview.md

Images/Assets Noted

None — Logging docs contain no images.

Conflicts & Questions for Human Review

Content Notes

logging.level default: The configuration docs say warn, but the standard-logging.md page says error ("We try to keep logging to a minimum by default, to do this the default log level is error"). The configuration docs are more authoritative and recent — using warn. Human reviewer should confirm.
logging.console default: Listed as true in the section header description but the 4.6.0 release notes say "console logging does not get logged to the log files by default." Used false as the default. Human reviewer should verify.

Migration Map Status

Updated all four logging pages to "In Progress"

Checklist for Human Reviewer

Confirm logging.level default (warn vs error — conflicting in source)
Confirm logging.console default (true vs false — conflicting signals)
Verify exact version when logger global was first available
Resolve http/configuration.md link placeholder (file already exists)
Review content accuracy and completeness
Update migration-map.md status to "Complete" after merge

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

github-actions · 2026-03-03T21:42:31Z

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-450

This preview will update automatically when you push new commits.

github-actions · 2026-03-03T22:54:17Z

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-450

This preview will update automatically when you push new commits.

github-actions · 2026-03-03T23:08:06Z

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-450

This preview will update automatically when you push new commits.

github-actions · 2026-03-03T23:46:19Z

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-450

This preview will update automatically when you push new commits.

kriszyp

This looks great! Just a few comments. I don't know that they necessarily need to be addressed.

kriszyp · 2026-03-04T17:24:18Z

reference_versioned_docs/version-v4/logging/configuration.md

+
+Type: `boolean`
+
+Default: `false`


This is correct (I know AI felt unsure). However, we do default this to true in Fabric: https://github.com/HarperFast/host-manager/blob/main/src/templates/compose.yaml#L64
(not sure if this should be mentioned here)

Not worth mentioning the difference on Fabric. I think it is important to treat this reference as what comes "out of the box" from our core package (i.e. npm i harperdb)

kriszyp · 2026-03-04T17:30:03Z

reference_versioned_docs/version-v4/logging/configuration.md

+  auditLog: false
+```
+
+### `logging.auditRetention`


I will note that we did move the audit operations into a separate operation (because audit/transaction log is totally different than app logging), but we still have in here. However, I think it would be too contrived to try to have this in a different config section, so I think we should leave this as is.
(And we should consider migrating transaction/audit log to a different configuration section).

Yeah I noticed that too. I think its good to think about for future v5 and beyond changes.

kriszyp · 2026-03-04T17:35:17Z

reference_versioned_docs/version-v4/logging/api.md

+
+```typescript
+interface MainLogger {
+	trace(message: any, ...args: any[]): void;


All the arguments are basically treated the same (the actual implementation uses warn(...args)); does this adequately communicate this?

I guess technically we support no args right now and this typing doesn't explicitly make that clear. I can fix it.

github-actions · 2026-03-04T17:49:49Z

🧹 Preview Cleanup

The preview deployment for this PR has been removed.

docs: migrate Logging section to v4 consolidated reference

dce94a7

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

This was referenced Mar 3, 2026

Docs -> Reference (Major version consolidation) Base #436

Draft

Analytics Section Migration #451

Open

github-actions bot temporarily deployed to pr-450 March 3, 2026 21:42 Inactive

fixup! docs: migrate Logging section to v4 consolidated reference

fafbac4

Ethan-Arrowood marked this pull request as ready for review March 3, 2026 22:52

Ethan-Arrowood requested a review from a team as a code owner March 3, 2026 22:52

github-actions bot temporarily deployed to pr-450 March 3, 2026 22:54 Inactive

fixup! docs: migrate Logging section to v4 consolidated reference

0ce0f74

github-actions bot temporarily deployed to pr-450 March 3, 2026 23:08 Inactive

fixup! docs: migrate Logging section to v4 consolidated reference

6cc4108

github-actions bot temporarily deployed to pr-450 March 3, 2026 23:46 Inactive

dawsontoth approved these changes Mar 4, 2026

View reviewed changes

kriszyp approved these changes Mar 4, 2026

View reviewed changes

fixup! docs: migrate Logging section to v4 consolidated reference

86fb025

Ethan-Arrowood merged commit 5271417 into major-version-reorg Mar 4, 2026
6 of 7 checks passed

Ethan-Arrowood deleted the migration/logging branch March 4, 2026 17:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Logging Section Migration#450

Logging Section Migration#450
Ethan-Arrowood merged 5 commits intomajor-version-reorgfrom
migration/logging

Ethan-Arrowood commented Mar 3, 2026

Uh oh!

github-actions bot commented Mar 3, 2026

Uh oh!

github-actions bot commented Mar 3, 2026

Uh oh!

github-actions bot commented Mar 3, 2026

Uh oh!

github-actions bot commented Mar 3, 2026

Uh oh!

kriszyp left a comment

Uh oh!

kriszyp Mar 4, 2026

Uh oh!

Ethan-Arrowood Mar 4, 2026

Uh oh!

kriszyp Mar 4, 2026

Uh oh!

Ethan-Arrowood Mar 4, 2026

Uh oh!

kriszyp Mar 4, 2026

Uh oh!

Ethan-Arrowood Mar 4, 2026

Uh oh!

Uh oh!

github-actions bot commented Mar 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants


		Type: `boolean`

		Default: `false`

Conversation

Ethan-Arrowood commented Mar 3, 2026

Logging Section Migration

Summary

Files Created

Source Files Used

logging/overview.md

logging/configuration.md

logging/api.md

logging/operations.md

Version Annotations Added

High Confidence (Confirmed via release notes)

Needs Verification

Scope Decision

Link Placeholders Created

Images/Assets Noted

Conflicts & Questions for Human Review

Content Notes

Migration Map Status

Checklist for Human Reviewer

Uh oh!

github-actions bot commented Mar 3, 2026

🚀 Preview Deployment

Uh oh!

github-actions bot commented Mar 3, 2026

🚀 Preview Deployment

Uh oh!

github-actions bot commented Mar 3, 2026

🚀 Preview Deployment

Uh oh!

github-actions bot commented Mar 3, 2026

🚀 Preview Deployment

Uh oh!

kriszyp left a comment

Choose a reason for hiding this comment

Uh oh!

kriszyp Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Ethan-Arrowood Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

kriszyp Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Ethan-Arrowood Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

kriszyp Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Ethan-Arrowood Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Mar 4, 2026

🧹 Preview Cleanup

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

`logging/overview.md`

`logging/configuration.md`

`logging/api.md`

`logging/operations.md`