feat(opentelemetry-exporter-jaeger): http sender

packages/opentelemetry-exporter-jaeger/src/jaeger.ts

@@ -21,6 +21,7 @@ import { ReadableSpan, SpanExporter } from '@opentelemetry/tracing';
 import { Socket } from 'dgram';
 import { spanToThrift } from './transform';
 import * as jaegerTypes from './types';
+import { OT_REQUEST_HEADER } from './utils';
 
 /**
  * Format and sends span information to Jaeger Exporter.
@@ -38,8 +39,21 @@ export class JaegerExporter implements SpanExporter {
       typeof config.flushTimeout === 'number' ? config.flushTimeout : 2000;
 
     config.host = config.host || process.env.JAEGER_AGENT_HOST;
+    config.endpoint = config.endpoint || process.env.JAEGER_ENDPOINT;
+    config.username = config.username || process.env.JAEGER_USER;
+    config.password = config.password || process.env.JAEGER_PASSWORD;
+    // https://github.com/jaegertracing/jaeger-client-node#environment-variables
+    // By default, the client sends traces via UDP to the agent at localhost:6832. Use JAEGER_AGENT_HOST and
+    // JAEGER_AGENT_PORT to send UDP traces to a different host:port. If JAEGER_ENDPOINT is set, the client sends traces
+    // to the endpoint via HTTP, making the JAEGER_AGENT_HOST and JAEGER_AGENT_PORT unused. If JAEGER_ENDPOINT is secured,
+    // HTTP basic authentication can be performed by setting the JAEGER_USER and JAEGER_PASSWORD environment variables.
+    if (config.endpoint) {
+      this._sender = new jaegerTypes.HTTPSender(config);
+      this._sender._httpOptions.headers[OT_REQUEST_HEADER] = 1;
+    } else {
+      this._sender = config.endpoint = new jaegerTypes.UDPSender(config);
+    }
 
-    this._sender = new jaegerTypes.UDPSender(config);
     if (this._sender._client instanceof Socket) {
       // unref socket to prevent it from keeping the process running
       this._sender._client.unref();

packages/opentelemetry-exporter-jaeger/src/types.ts

@@ -28,6 +28,13 @@ export interface ExporterConfig {
   maxPacketSize?: number; // default: 65000
   /** Time to wait for an onShutdown flush to finish before closing the sender */
   flushTimeout?: number; // default: 2000
+  //The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces
+  //If setten will override host and port
+  endpoint?: string;
+  //Username to send as part of "Basic" authentication to the collector endpoint
+  username?: string;
+  //Password to send as part of "Basic" authentication to the collector endpoint
+  password?: string;
 }
 
 // Below require is needed as jaeger-client types does not expose the thrift,
@@ -41,6 +48,9 @@ export const Utils = require('jaeger-client/dist/src/util').default;
 // tslint:disable-next-line:variable-name
 export const ThriftUtils = require('jaeger-client/dist/src/thrift').default;
 
+export const HTTPSender = require('jaeger-client/dist/src/reporters/http_sender')
+  .default;
+
 export type TagValue = string | number | boolean;
 
 export interface Tag {

packages/opentelemetry-exporter-jaeger/src/utils.ts

@@ -0,0 +1,17 @@
+/*!
+ * Copyright 2020, OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export const OT_REQUEST_HEADER = 'x-opentelemetry-outgoing-request';

packages/opentelemetry-exporter-jaeger/test/jaeger.test.ts

@@ -23,6 +23,7 @@ import { ReadableSpan } from '@opentelemetry/tracing';
 import { ExportResult } from '@opentelemetry/base';
 import { TraceFlags } from '@opentelemetry/api';
 import { Resource } from '@opentelemetry/resources';
+import { OT_REQUEST_HEADER } from '../src/utils';
 
 describe('JaegerExporter', () => {
   describe('constructor', () => {
@@ -150,5 +151,17 @@ describe('JaegerExporter', () => {
         assert.strictEqual(result, ExportResult.SUCCESS);
       });
     });
+
+    it('should use httpSender if config.endpoint is setten and set x-opentelemetry-outgoing-request header', () => {
+      const exporter = new JaegerExporter({
+        serviceName: 'opentelemetry',
+        endpoint: 'http://testendpoint',
+      });
+      assert.strictEqual(exporter['_sender'].constructor.name, 'HTTPSender');
+      assert.strictEqual(
+        exporter['_sender']._httpOptions.headers[OT_REQUEST_HEADER],
+        1
+      );
+    });
   });
 });