10000 chore: added loggly deprecation warning · xyz-data/log4js-node@42249dc · GitHub
[go: up one dir, main page]

Skip to content

Commit 42249dc

Browse files
author
Gareth Jones
committed
chore: added loggly deprecation warning
1 parent 9700cf5 commit 42249dc

File tree

4 files changed

+9
-38
lines changed

4 files changed

+9
-38
lines changed

docs/appenders.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ The following appenders are included with log4js. Some require extra dependencie
2727
* [hipchat](hipchat.md)
2828
* [logFaces-HTTP](logFaces-HTTP.md)
2929
* [logFaces-UDP](logFaces-UDP.md)
30-
* [loggly](loggly.md)
3130
* [logLevelFilter](logLevelFilter.md)
3231
* [logstashHTTP](logstashHTTP.md)
3332
* [logstashUDP](logstashUDP.md)
@@ -47,6 +46,7 @@ The following appenders are included with log4js. Some require extra dependencie
4746
The following appenders are supported by log4js, but will issue deprecation warnings from version 2.6 onwards - they will be removed from the log4js core in version 3. If you are using these appenders, you should alter your dependencies to include them explicitly.
4847

4948
* [gelf](https://github.com/log4js-node/gelf)
49+
* [loggly](https://github.com/log4js-node/loggly)
5050

5151
For example, if you were previously using the gelf appender (`type: 'gelf'`) then you should add `@log4js-node/gelf` to your dependencies and change the type to `type: '@log4js-node/gelf'`.
5252

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ There have been a few changes between log4js 1.x and 2.x (and 0.x too). You shou
1313
* [file appender](file.md), with configurable log rolling based on file size or [date](dateFile.md)
1414
* [SMTP appender](smtp.md)
1515
* [GELF appender](https://github.com/log4js-node/gelf)
16-
* [Loggly appender](loggly.md)
16+
* [Loggly appender](https://github.com/log4js-node/loggly)
1717
* [Logstash UDP appender](logstashUDP.md)
1818
* logFaces ([UDP](logFaces-UDP.md) and [HTTP](logFaces-HTTP.md)) appender
1919
* [multiprocess appender](multiprocess.md) (useful when you've got multiple servers but want to centralise logging)

docs/loggly.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

lib/appenders/loggly.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
'use strict';
44

5+
/**
6+
* This appender has been deprecated.
7+
* Updates and bug fixes should be made against https://github.com/log4js-node/loggly
8+
*/
59
const debug = require('debug')('log4js:loggly');
610
const loggly = require('loggly');
711
const os = require('os');
@@ -105,6 +109,9 @@ function logglyAppender(config, layout) {
105109
}
106110
};
107111

112+
// trigger a deprecation warning, with a pointer to the replacement lib
113+
app.deprecated = '@log4js-node/loggly';
114+
108115
return app;
109116
}
110117

0 commit comments

Comments
 (0)
0