no longer exclude "content-length" and "user-agent" from headers fields"

Author: trentm

helpers/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+- Change `formatHttpRequest` and `formatHttpResponse` to no longer exclude
+  the "content-length" and "user-agent" headers for "http.request.headers"
+  and "http.response.headers", even though their info also rendered to
+  other specialized fields.
 - Update ECS version to "1.6.0". Relevant [ECS changes](https://github.com/elastic/ecs/blob/master/CHANGELOG.md#160):
   - "span.id" - This field is included by the loggers when integrating with APM.
   - "Deprecate guidance to lowercase http.request.method."

helpers/lib/http-formatters.js

@@ -90,18 +90,17 @@ function formatHttpRequest (ecs, req) {
 
   const hasHeaders = Object.keys(headers).length > 0
   if (hasHeaders === true) {
-    ecs.http.request.headers = ecs.http.request.headers || {}
-    for (const header in headers) {
-      if (header === 'content-length') {
-        ecs.http.request.body = ecs.http.request.body || {}
-        ecs.http.request.body.bytes = Number(headers[header])
-      } else if (header === 'user-agent') {
-        ecs.user_agent = ecs.user_agent || {}
-        ecs.user_agent.original = headers[header]
-      } else {
-        // `http.response.headers` is not standardized
-        ecs.http.request.headers[header] = headers[header]
-      }
+    // See https://github.com/elastic/ecs/issues/232 for discussion of
+    // specifying headers in ECS.
+    ecs.http.request.headers = Object.assign(ecs.http.request.headers || {}, headers)
+    const cLen = Number(headers['content-length'])
+    if (!isNaN(cLen)) {
+      ecs.http.request.body = ecs.http.request.body || {}
+      ecs.http.request.body.bytes = cLen
+    }
+    if (headers['user-agent']) {
+      ecs.user_agent = ecs.user_agent || {}
+      ecs.user_agent.original = headers['user-agent']
     }
   }
 }
@@ -121,15 +120,13 @@ function formatHttpResponse (ecs, res) {
   const headers = res.getHeaders()
   const hasHeaders = Object.keys(headers).length > 0
   if (hasHeaders === true) {
-    ecs.http.response.headers = ecs.http.response.headers || {}
-    for (const header in headers) {
-      if (header === 'content-length') {
-        ecs.http.response.body = ecs.http.response.body || {}
-        ecs.http.response.body.bytes = Number(headers[header])
-      } else {
-        // `http.response.headers` is not standardized
-        ecs.http.response.headers[header] = headers[header]
-      }
+    // See https://github.com/elastic/ecs/issues/232 for discussion of
+    // specifying headers in ECS.
+    ecs.http.response.headers = Object.assign(ecs.http.response.headers || {}, headers)
+    const cLen = Number(headers['content-length'])
+    if (!isNaN(cLen)) {
+      ecs.http.response.body = ecs.http.response.body || {}
+      ecs.http.response.body.bytes = cLen
     }
   }
 }

helpers/test/basic.test.js

@@ -163,15 +163,20 @@ test('formatHttpRequest and formatHttpResponse should return a valid ecs object'
       request: {
         method: 'POST',
         headers: {
+          'user-agent': 'cool-agent',
           'content-type': 'application/json',
+          'content-length': '17',
           host: `localhost:${server.address().port}`,
           connection: 'close'
         },
         body: { bytes: 17 }
       },
       response: {
         status_code: 200,
-        headers: { 'content-type': 'text/plain' },
+        headers: {
+          'content-type': 'text/plain',
+          'content-length': '2'
+        },
         body: { bytes: contentLen }
       }
     })

helpers/test/express.test.js

@@ -52,6 +52,7 @@ test('express res/req serialization', t => {
       request: {
         method: 'GET',
         headers: {
+          'user-agent': 'cool-agent',
           host: `localhost:${server.address().port}`,
           connection: 'close'
         }

helpers/test/hapi.test.js

@@ -61,6 +61,7 @@ test('hapi res/req serialization', testOpts, t => {
       request: {
         method: 'GET',
         headers: {
+          'user-agent': 'cool-agent',
           host: `localhost:${server.info.port}`,
           connection: 'close'
         }
@@ -71,6 +72,7 @@ test('hapi res/req serialization', testOpts, t => {
           foo: 'Bar',
           'content-type': 'text/html; charset=utf-8',
           'cache-control': 'no-cache',
+          'content-length': '2',
           'accept-ranges': 'bytes'
         },
         body: {