From 7d7d4e644324cc3a13e821abb173f7cf918d1e22 Mon Sep 17 00:00:00 2001 From: Wei Zou Date: Wed, 13 Nov 2019 18:36:00 -0800 Subject: [PATCH 1/3] docs: remove 'shimProperties' from doc and add to CHANGELOG --- CHANGELOG.md | 20 +++++++++++++++++++- README.md | 24 ------------------------ 2 files changed, 19 insertions(+), 25 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 51c0551..1767f77 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,25 @@ This file documents all notable changes in `LogDNA Node.js Code Library`. The release numbering uses [semantic versioning](http://semver.org). ## Next Release [MAJOR] -- Breaking Change: Add support for custom properties by adding `shimProperties` option when creating an logger. In order to continue to see fields `appOverride`, `logSourceCRN`, and `saveServiceCopy` in the message, need to add those properties in `shimProperties`. +- Breaking Change: Add support for custom properties by adding `shimProperties` option when creating an logger. In order to continue to see fields `appOverride`, `logSourceCRN`, and `saveServiceCopy` in the message, need to add those properties in `shimProperties` like the following: +```javascript +const Logger = require('logdna'); +const options = { + hostname: myHostname, + ip: ipAddress, + mac: macAddress, + app: appName, + env: envName, + shimProperties: ['appOverride', 'logSourceCRN', 'saveServiceCopy'] +}; +const logger = Logger.createLogger(apikey, options); + +logger.log('My Sample Log Line', { + appOverride: true, + logSourceCRN: 'good', + saveServiceCopy: false +}); +``` ## v3.3.3 - September 20, 2019 - Add User Agent to the Request Header diff --git a/README.md b/README.md index 5d93187..7e62d23 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,6 @@ options.tags = ['logging', 'nodejs', 'logdna']; // or: options.tags = 'logging,nodejs,logdna'; -// Customized options that will be applied to message during `.log` call -options.shimProperties = ['prop1', 'prop2', 'prop3']; - // Create multiple loggers with different options var logger = Logger.createLogger(apikey, options); @@ -131,27 +128,6 @@ logger.log('My Sample Log Line', opts); ``` You will see the outputs in your LogDNA dashboard. -If customized options is needed in the message, `shimProperties` can be used: -```javascript -const Logger = require('logdna'); -const options = { - hostname: myHostname, - ip: ipAddress, - mac: macAddress, - app: appName, - env: envName, - shimProperties: ['prop1', 'prop2', 'prop3'] -}; -const logger = Logger.createLogger(apikey, options); - -logger.log('My Sample Log Line', { - prop1: true, - prop2: 'good', - prop4: false -}); -``` -You will see `prop1` and `prop2` be logged, but neither of `prop3` and `prop4` are logged. - ## API ### createLogger(key, [options]) From 00446a4fc819fe754797edc43c7bfee3506d8aa6 Mon Sep 17 00:00:00 2001 From: Wei Zou Date: Wed, 13 Nov 2019 22:47:28 -0800 Subject: [PATCH 2/3] docs: update CHANGELOG for 'shimProperties' feature --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1767f77..c72042a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ This file documents all notable changes in `LogDNA Node.js Code Library`. The release numbering uses [semantic versioning](http://semver.org). ## Next Release [MAJOR] -- Breaking Change: Add support for custom properties by adding `shimProperties` option when creating an logger. In order to continue to see fields `appOverride`, `logSourceCRN`, and `saveServiceCopy` in the message, need to add those properties in `shimProperties` like the following: +- Breaking Change: Add support for custom properties via the `shimProperties` option when creating an logger. To continue to see the fields `appOverride`, `logSourceCRN`, and `saveServiceCopy` in the message, they must be specified in `shimProperties`: ```javascript const Logger = require('logdna'); const options = { From 302732c22f85f5d36463c000574d811af8b48f65 Mon Sep 17 00:00:00 2001 From: Wei Zou Date: Thu, 14 Nov 2019 09:44:41 -0800 Subject: [PATCH 3/3] docs: remove 'Next Release' session from CHANGELOG.md --- CHANGELOG.md | 21 --------------------- 1 file changed, 21 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c72042a..3d0096d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,27 +2,6 @@ This file documents all notable changes in `LogDNA Node.js Code Library`. The release numbering uses [semantic versioning](http://semver.org). -## Next Release [MAJOR] -- Breaking Change: Add support for custom properties via the `shimProperties` option when creating an logger. To continue to see the fields `appOverride`, `logSourceCRN`, and `saveServiceCopy` in the message, they must be specified in `shimProperties`: -```javascript -const Logger = require('logdna'); -const options = { - hostname: myHostname, - ip: ipAddress, - mac: macAddress, - app: appName, - env: envName, - shimProperties: ['appOverride', 'logSourceCRN', 'saveServiceCopy'] -}; -const logger = Logger.createLogger(apikey, options); - -logger.log('My Sample Log Line', { - appOverride: true, - logSourceCRN: 'good', - saveServiceCopy: false -}); -``` - ## v3.3.3 - September 20, 2019 - Add User Agent to the Request Header