Allow host to be overridden in httpServer instrumentation (openzipkin…

…#236)
rcoedo · Jul 10, 2018 · b6d7ee6 · b6d7ee6
1 parent 5ec1c8d
commit b6d7ee6
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 4 deletions.
diff --git a/packages/zipkin/src/instrumentation/httpServer.js b/packages/zipkin/src/instrumentation/httpServer.js
@@ -1,8 +1,9 @@
+const Annotation = require('../annotation');
 const Header = require('../httpHeaders');
-const {Some, None} = require('../option');
+const InetAddress = require('../InetAddress');
 const TraceId = require('../tracer/TraceId');
-const Annotation = require('../annotation');
 const parseRequestUrl = require('../parseUrl');
+const {Some, None} = require('../option');
 
 function stringToBoolean(str) {
   return str === '1' || str === 'true';
@@ -28,10 +29,12 @@ class HttpServerInstrumentation {
   constructor({
     tracer = requiredArg('tracer'),
     serviceName = tracer.localEndpoint.serviceName,
-    port = requiredArg('port')
+    host,
+    port = requiredArg('port'),
   }) {
     this.tracer = tracer;
     this.serviceName = serviceName;
+    this.host = host && new InetAddress(host);
     this.port = port;
   }
 
@@ -78,7 +81,7 @@ class HttpServerInstrumentation {
     this.tracer.recordRpc(method.toUpperCase());
     this.tracer.recordBinary('http.path', path);
     this.tracer.recordAnnotation(new Annotation.ServerRecv());
-    this.tracer.recordAnnotation(new Annotation.LocalAddr({port: this.port}));
+    this.tracer.recordAnnotation(new Annotation.LocalAddr({host: this.host, port: this.port}));
 
     return id;
   }

diff --git a/packages/zipkin/test/httpServerInstrumentation.test.js b/packages/zipkin/test/httpServerInstrumentation.test.js
@@ -248,4 +248,51 @@ describe('Http Server Instrumentation', () => {
       });
     });
   });
+
+  it('should allow the host to be overridden', () => {
+    const record = sinon.spy();
+    const recorder = {record};
+    const ctxImpl = new ExplicitContext();
+    const tracer = new Tracer({recorder, ctxImpl});
+    const instrumentation = new HttpServer({
+      tracer,
+      serviceName: 'service-a',
+      host: '1.1.1.1',
+      port: 80
+    });
+
+    ctxImpl.scoped(() => {
+      const id = instrumentation.recordRequest('POST', '/test-url', () => None);
+      instrumentation.recordResponse(id, 202);
+    });
+
+    const localAddr = record.args
+                              .map(args => args[0].annotation)
+                              .find(annotation => annotation.annotationType === 'LocalAddr');
+
+    expect(localAddr.host.addr).to.equal('1.1.1.1');
+  });
+
+  it('should work if the host option is not defined', () => {
+    const record = sinon.spy();
+    const recorder = {record};
+    const ctxImpl = new ExplicitContext();
+    const tracer = new Tracer({recorder, ctxImpl});
+    const instrumentation = new HttpServer({
+      tracer,
+      serviceName: 'service-a',
+      port: 80
+    });
+
+    ctxImpl.scoped(() => {
+      const id = instrumentation.recordRequest('POST', '/test-url', () => None);
+      instrumentation.recordResponse(id, 202);
+    });
+
+    const localAddr = record.args
+                              .map(args => args[0].annotation)
+                              .find(annotation => annotation.annotationType === 'LocalAddr');
+
+    expect(localAddr.host.addr).not.to.equal(undefined);
+  });
 });