Skip to content

Commit db19e73

Browse files
delvedordelvedor
authored
Add morgan support (#2)
Add morgan support
2 parents 12f2ad8 + 0185600 commit db19e73

14 files changed

+502
-97
lines changed

‎helper/README.md

Whitespace-only changes.

‎helper/http-formatters.js

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
'use strict'
2+
3+
function formatHttpRequest (ecs, req) {
4+
const {
5+
id,
6+
method,
7+
url,
8+
remoteAddress,
9+
remotePort,
10+
headers,
11+
hostname,
12+
httpVersion
13+
} = req
14+
15+
if (id) {
16+
ecs.event = ecs.event || {}
17+
ecs.event.id = id
18+
}
19+
20+
ecs.http = ecs.http || {}
21+
ecs.http.version = httpVersion
22+
ecs.http.request = ecs.http.request || {}
23+
ecs.http.request.method = method.toLowerCase()
24+
25+
ecs.url = ecs.url || {}
26+
ecs.url.full = url
27+
var hasQuery = url.indexOf('?')
28+
var hasAnchor = url.indexOf('#')
29+
if (hasQuery > -1 && hasAnchor > -1) {
30+
ecs.url.path = url.slice(0, hasQuery)
31+
ecs.url.query = url.slice(hasQuery + 1, hasAnchor)
32+
ecs.url.fragment = url.slice(hasAnchor + 1)
33+
} else if (hasQuery > -1) {
34+
ecs.url.path = url.slice(0, hasQuery)
35+
ecs.url.query = url.slice(hasQuery + 1)
36+
} else if (hasAnchor > -1) {
37+
ecs.url.path = url.slice(0, hasAnchor)
38+
ecs.url.fragment = url.slice(hasAnchor + 1)
39+
} else {
40+
ecs.url.path = url
41+
}
42+
43+
if (hostname) {
44+
const [host, port] = hostname.split(':')
45+
ecs.url.domain = host
46+
if (port) ecs.url.port = Number(port)
47+
}
48+
49+
if (remoteAddress || remotePort) {
50+
ecs.client = ecs.client || {}
51+
ecs.client.address = remoteAddress
52+
ecs.client.port = remotePort
53+
}
54+
55+
if (headers) {
56+
if (headers['user-agent']) {
57+
ecs.user_agent = ecs.user_agent || {}
58+
ecs.user_agent.original = headers['user-agent']
59+
delete headers['user-agent']
60+
}
61+
if (headers['content-length']) {
62+
ecs.http.request.body = ecs.http.request.body || {}
63+
ecs.http.request.body.bytes = Number(headers['content-length'])
64+
delete headers['content-length']
65+
}
66+
67+
if (Object.keys(headers).length) {
68+
// `http.request.headers` is not standardized
69+
ecs.http.request.headers = headers
70+
}
71+
}
72+
}
73+
74+
function formatHttpResponse (ecs, res) {
75+
const { statusCode, headers } = res
76+
ecs.http = ecs.http || {}
77+
ecs.http.response = ecs.http.response || {}
78+
ecs.http.response.status_code = statusCode
79+
80+
if (headers) {
81+
if (headers['content-length']) {
82+
ecs.http.response.body = ecs.http.response.body || {}
83+
ecs.http.response.body.bytes = Number(headers['content-length'])
84+
delete headers['content-length']
85+
}
86+
87+
if (Object.keys(headers).length) {
88+
// `http.response.headers` is not standardized
89+
ecs.http.response.headers = headers
90+
}
91+
}
92+
}
93+
94+
module.exports = { formatHttpRequest, formatHttpResponse }

‎helper/index.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
'use strict'
2+
3+
const stringify = require('./serializer')
4+
const httpFormatters = require('./http-formatters')
5+
6+
module.exports = {
7+
stringify,
8+
...httpFormatters
9+
}

‎helper/package.json

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"name": "@elastic/ecs-helper",
3+
"version": "0.1.0",
4+
"description": "ECS loggers helper",
5+
"main": "index.js",
6+
"repository": {
7+
"type": "git",
8+
"url": "git+https://github.com/elastic/ecs-logging-js.git"
9+
},
10+
"author": "Tomas Della Vedova",
11+
"license": "Apache-2.0",
12+
"bugs": {
13+
"url": "https://github.com/elastic/ecs-logging-js/issues"
14+
},
15+
"homepage": "https://github.com/elastic/ecs-logging-js/blob/master/helper/README.md",
16+
"scripts": {
17+
"test": "ava"
18+
},
19+
"dependencies": {
20+
"fast-json-stringify": "^1.16.1"
21+
},
22+
"devDependencies": {
23+
"ava": "^3.1.0",
24+
"is-my-json-valid": "^2.20.0",
25+
"standard": "^14.3.1"
26+
}
27+
}

‎loggers/winston/serializer.js renamed to ‎helper/serializer.js

File renamed without changes.

‎helper/test.js

Whitespace-only changes.

‎loggers/morgan/LICENSE

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

‎loggers/morgan/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# @elastic/morgan-ecs-format
2+
3+
A formatter for the [morgan](https://www.npmjs.com/package/morgan) logger compatible with [Elastic Common Schema](https://www.elastic.co/guide/en/ecs/current/index.html).
4+
5+
## Install
6+
```sh
7+
npm i @elastic/morgan-ecs-format
8+
```
9+
10+
## Usage
11+
```js
12+
const app = require('express')()
13+
const morgan = require('morgan')
14+
const ecsFormat = require('@elastic/morgan-ecs-format')()
15+
16+
app.use(morgan(ecsFormat))
17+
18+
app.get('/', function (req, res) {
19+
res.send('hello, world!')
20+
})
21+
22+
app.listen(3000, () => {
23+
console.log('Listening')
24+
})
25+
26+
```
27+
28+
## License
29+
[Apache 2.0](./LICENSE)

‎loggers/morgan/example.js

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
'use strict'
2+
3+
const app = require('express')()
4+
const morgan = require('morgan')
5+
const ecsFormat = require('./')()
6+
7+
app.use(morgan(ecsFormat))
8+
9+
app.get('/', function (req, res) {
10+
res.send('hello, world!')
11+
})
12+
13+
app.listen(3000, () => {
14+
console.log('Listening')
15+
})

0 commit comments

Comments
 (0)