Skip to content

Commit b8cf294

Browse files
eric-martineric-martin
committed
Merge pull request #1 from alexk-blackops/dev2
Initial request
2 parents 29e05fa + 22960e9 commit b8cf294

File tree

12 files changed

+1124
-3
lines changed

12 files changed

+1124
-3
lines changed

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
npm-debug.log

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md‎

Lines changed: 116 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,117 @@
1-
stackify-log-nodejs
2-
===================
1+
#Stackify Log API for Node.js
32

4-
Stackify Log API for Node.js
3+
Errors and Logs Overview:
4+
5+
http://docs.stackify.com/m/7787/l/189767
6+
7+
Sign Up for a Trial:
8+
9+
http://www.stackify.com/sign-up/
10+
11+
## Installation
12+
```bash
13+
$ npm install stackify-logger
14+
```
15+
16+
## Usage
17+
18+
```js
19+
var stackify = require(‘stackify-logger’);
20+
```
21+
Start sending logs:
22+
```js
23+
// this should be executed only once in the app
24+
stackify.start(options);
25+
```
26+
The following options could be passed. 'apiKey' is the only one that required:
27+
* __apiKey:__ client license key
28+
* __env:__ environment name
29+
* __exitOnError:__ boolean flag indicating whether to shutdown the server after logging an uncaught exception, defaults to false
30+
* __proxy:__ proxy server if you want to send requests via proxy.
31+
32+
*Notice:* stackify-logger sends synchronous requests if you call `process.exit()`. Sending via proxy wouldn't be possible in this case.
33+
34+
#### Using with Winston
35+
36+
```bash
37+
$ npm install winston
38+
$ npm install winston-stackify
39+
```
40+
41+
If you are already using Winston you should add the stackify transport module to your instance of Winston:
42+
```js
43+
require('winston-stackify').Stackify;
44+
winston.add(winston.transports.Stackify(options));
45+
```
46+
47+
All the details could be found here - [Winston Transport for Stackify](https://github.com/stackify/stackify-log-winston)
48+
49+
#### Using direct logger
50+
51+
If you are not using Winston logger you can use default Stackify logger. It has 5 levels of messages: `trace`, `debug`, `info`, `warn` and `error`. To send the message to Stackify API you should run one of the following methods in any place of your code where you want to track some information:
52+
```js
53+
stackify.log(level, message [, meta1, ... , metaN])
54+
stackify.trace(message [, meta1, ... , metaN])
55+
stackify.debug(message [, meta1, ... , metaN])
56+
stackify.info(message [, meta1, ... , metaN])
57+
stackify.warn(message [, meta1, ... , metaN])
58+
stackify.error(message [, meta1, ... , metaN])
59+
```
60+
61+
**Message** must be a string.
62+
63+
**meta1 ... metaN** - a list of additional parameters of any type.
64+
65+
Examples of usage:
66+
```js
67+
// Add the module to all the script files where you want to log any messages.
68+
var stackify = require('stackify-logger');
69+
70+
stackify.log('info', 'hey!');
71+
stackify.debug('any message');
72+
stackify.info('any message', {anything: 'this is metadata'});
73+
stackify.warn('attention');
74+
stackify.log('error', {error : new Error()});
75+
```
76+
When logging an error message you can pass an Error object in metadata like in the last example, so the exception details would be available.
77+
78+
#### Exception handling
79+
By executing `stackify.start()` you set a handler for uncaught exceptions.
80+
Make sure you run it before any methods that set exception handlers.
81+
82+
##### Using with Express
83+
Global handler doesn't work inside Express route methods.
84+
You should use error-handling middleware function `stackify.expressExceptionHandler`. Since middleware is executed serially, it's order of inclusion is important. Make sure you add it before any other error-handling middleware.
85+
86+
```js
87+
var express = require('express');
88+
var app = express();
89+
90+
/*
91+
*** block of route handlers ***
92+
*** *** **** **** **** **** ***
93+
*/
94+
95+
app.use(stackify.expressExceptionHandler);
96+
```
97+
98+
To handle exceptions correctly put this right after all route handlers.
99+
100+
## Troubleshooting
101+
When request to Stackify fails for some reason, an error message is being printed to your `process.stderr` stream
102+
103+
## License
104+
105+
Copyright 2014 Stackify, LLC.
106+
107+
Licensed under the Apache License, Version 2.0 (the "License");
108+
you may not use this file except in compliance with the License.
109+
You may obtain a copy of the License at
110+
111+
http://www.apache.org/licenses/LICENSE-2.0
112+
113+
Unless required by applicable law or agreed to in writing, software
114+
distributed under the License is distributed on an "AS IS" BASIS,
115+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
116+
See the License for the specific language governing permissions and
117+
limitations under the License.

‎config/config.js‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
module.exports = {
2+
PROTOCOL : 'https',
3+
HOST : 'dev.stackify.com',
4+
PORT : 443,
5+
IDENTIFY_PATH : '/API/Metrics/IdentifyApp',
6+
LOG_SAVE_PATH : '/API/Log/Save',
7+
DELAY: { // possible delay values in millis
8+
ONE_SECOND_DELAY : 1000,
9+
FIVE_SECONDS_DELAY : 5000,
10+
ONE_MINUTE_DELAY : 60000,
11+
FIVE_MINUTES_DELAY : 300000,
12+
},
13+
MSG: {
14+
QUEUE_CAP : 10000,
15+
MIN_BATCH_SIZE : 10,
16+
MAX_BATCH_SIZE : 100,
17+
MAX_DUP_ERROR_PER_MINUTE: 100, // number of instances of a unique error that are allowed to be sent in one minute
18+
19+
},
20+
IDENTIFY_DELAY: 300000, // 5 minutes delay if identifyApp call failed
21+
COOKIE_MASK: 'X-MASKED-X', // cookie headers and values mask
22+
LOGGER_VERSION: 'Node.js Stackify v.1.0',
23+
X_STACKIFY_PV: 'V1'
24+
};

‎index.js‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
var api = require('./lib/api'), // wrappers for API calls
2+
exception = require('./lib/exception'), // exception handler module
3+
logger = require('./lib/logger'); // logging methods module
4+
5+
module.exports = {
6+
// start sending logs
7+
start: function (options) {
8+
api.methods.identifyApp(options);
9+
exception.catchException(options.exitOnError || false);
10+
exception.gracefulExitHandler();
11+
},
12+
13+
log: logger.methods.log,
14+
trace: logger.methods.trace,
15+
debug: logger.methods.debug,
16+
info: logger.methods.info,
17+
warn: logger.methods.warn,
18+
error: logger.methods.error,
19+
20+
//common method for handling logged messages
21+
push: logger.methods.push,
22+
23+
expressExceptionHandler: exception.expressExceptionHandler
24+
};

0 commit comments

Comments
 (0)