Skip to content

Removed Loggly transport from @tryghost/logging#650

Merged
9larsons merged 1 commit into
mainfrom
remove-loggly
May 18, 2026
Merged

Removed Loggly transport from @tryghost/logging#650
9larsons merged 1 commit into
mainfrom
remove-loggly

Conversation

@9larsons
Copy link
Copy Markdown
Collaborator

@9larsons 9larsons commented May 18, 2026

Summary

  • Removed the loggly transport, the bunyan-loggly dependency, and the loggly-only match regex branch in log(). Any consumer passing transports: ['loggly'] now hits the existing invalid-transport error.
  • Removed the node-loggly-bulk workspace override (confirmed no other consumer via pnpm why). Left axios and fast-xml-parser overrides in place — they have non-loggly consumers.
  • Ported the two serialization tests that incidentally used Bunyan2Loggly to stub HttpStream.prototype.write instead.

The bunyan-logglynode-loggly-bulkaxios chain had become a recurring CVE surface and is unmaintained upstream.

Breaking change

Version bump deferred to pnpm ship:major after merge (4.2.15.0.0).

Known downstream consumers passing loggly: {...}:

  • TryGhost/Zuul
  • TryGhost/AppMonitor
  • TryGhost/Scheduler
  • TryGhost/UpdateCheck

They must pin @tryghost/logging@^4 or migrate to stdout + a log forwarder before adopting ^5.

Test plan

  • pnpm --filter @tryghost/logging test — 40/40 pass, lint clean
  • pnpm why bunyan-loggly and pnpm why node-loggly-bulk return nothing
  • Downstream service owners notified before ship:major

Drops the bunyan-loggly -> node-loggly-bulk -> axios chain, which had
become a recurring CVE surface and is no longer maintained upstream.

- Removed setLogglyStream(), the loggly option, and the loggly-only
  match regex branch in log()
- Removed the bunyan-loggly dependency
- Removed the node-loggly-bulk workspace override (no other consumer);
  left axios and fast-xml-parser overrides in place
- Ported the two serialization tests that incidentally used loggly to
  stub HttpStream.prototype.write instead

Breaking change. Version bump (4.2.1 -> 5.0.0) deferred to
'pnpm ship:major' after merge. Known downstream consumers passing
loggly config (Zuul, AppMonitor, Scheduler, UpdateCheck) must pin
@tryghost/logging@^4 or migrate to stdout + a log forwarder before
adopting ^5. See LOGGLY_MODERNIZATION.md for context.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 18, 2026

Review Change Stack

Walkthrough

This PR removes Loggly transport support from the logging package. The core implementation removes the setLogglyStream() method and loggly options binding from GhostLogger, simplifies the log() method by eliminating regex-based logger.match filtering, and updates JSDoc to clarify remaining supported transports. Dependencies on bunyan-loggly and node-loggly-bulk are removed from package.json and workspace overrides. Test coverage for the Loggly transport is deleted, and serialization tests are refactored to use the HTTP transport with HttpStream stubs instead.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title directly and clearly summarizes the main change: removal of the Loggly transport from the @tryghost/logging package, which is the primary objective of this pull request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The PR description clearly explains the removal of the loggly transport, dependency changes, test updates, and migration requirements for downstream consumers.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch remove-loggly

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.11%. Comparing base (48868e4) to head (7305b09).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #650      +/-   ##
==========================================
- Coverage   98.12%   98.11%   -0.01%     
==========================================
  Files          84       84              
  Lines        2771     2763       -8     
  Branches      510      507       -3     
==========================================
- Hits         2719     2711       -8     
  Misses         11       11              
  Partials       41       41              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@9larsons 9larsons merged commit e1c7785 into main May 18, 2026
4 checks passed
@9larsons 9larsons deleted the remove-loggly branch May 18, 2026 01:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants