Merge branch 'main' into fix/instrument-grpc-client

.github/workflows/label-releases.yml

@@ -0,0 +1,12 @@
+on:
+  pull_request_target:
+    branches:
+      - main
+
+jobs:
+  label-release:
+    if: ${{ startsWith(github.event.pull_request.title, 'release:') }}
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo this is a release PR
+      - run: gh pr edit ${{ github.event.pull_request.number }} --add-label release

.github/workflows/peer-api.yml

@@ -11,7 +11,7 @@ jobs:
   peer-api-check:
     runs-on: ubuntu-latest
     container:
-      image: node:18
+      image: node:20
     steps:
       - name: Checkout
         uses: actions/checkout@v3

CHANGELOG.md

@@ -11,6 +11,8 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/
 
 ### :rocket: (Enhancement)
 
+* feat(SpanExpoter): Add optional forceFlush to SpanExporter interface [#3753](https://github.com/open-telemetry/opentelemetry-js/pull/3753/) @sgracias1 @JacksonWeber
+
 ### :bug: (Bug Fix)
 
 ### :books: (Refine Doc)

experimental/CHANGELOG.md

@@ -6,12 +6,19 @@ All notable changes to experimental packages in this project will be documented
 
 ### :boom: Breaking Change
 
+* fix(exporter-logs-otlp-grpc): change OTLPLogsExporter to OTLPLogExporter [#3819](https://github.com/open-telemetry/opentelemetry-js/pull/3819) @fuaiyi
+
 ### :rocket: (Enhancement)
 
 * feat(instrumentation): add ESM support for instrumentation. [#3698](https://github.com/open-telemetry/opentelemetry-js/pull/3698) @JamieDanielson, @pkanal, @vmarchaud, @lizthegrey, @bengl
+* feat(otlp-trace-exporters): Add User-Agent header to OTLP trace exporters. [#3790](https://github.com/open-telemetry/opentelemetry-js/pull/3790) @JamieDanielson
+* feat(otlp-metric-exporters): Add User-Agent header to OTLP metric exporters. [#3806](https://github.com/open-telemetry/opentelemetry-js/pull/3806) @JamieDanielson
 
 ### :bug: (Bug Fix)
 
+* fix(sdk-node): use resource interface instead of concrete class [#3803](https://github.com/open-telemetry/opentelemetry-js/pull/3803) @blumamir
+* fix(sdk-logs): remove includeTraceContext configuration and use LogRecord context when available  [#3817](https://github.com/open-telemetry/opentelemetry-js/pull/3817) @hectorhdzg
+
 ### :books: (Refine Doc)
 
 ### :house: (Internal)
@@ -31,6 +38,7 @@ All notable changes to experimental packages in this project will be documented
 * feat(exporter-logs-otlp-grpc): otlp-grpc exporter for logs. [#3712](https://github.com/open-telemetry/opentelemetry-js/pull/3712/) @llc1123
 * feat(otlp-grpc-exporter-base): use statically generated protobuf code [#3705](https://github.com/open-telemetry/opentelemetry-js/pull/3705) @pichlermarc
 * refactor(otlp-transformer): refine metric transformers. [#3770](https://github.com/open-telemetry/opentelemetry-js/pull/3770/) @llc1123
+* feat(api-logs): add `ObservedTimestamp` to `LogRecord`. [#3787](https://github.com/open-telemetry/opentelemetry-js/pull/3787/) @llc1123
 
 ### :bug: (Bug Fix)
 

experimental/packages/api-logs/src/types/LogRecord.ts

@@ -50,6 +50,11 @@ export interface LogRecord {
    */
   timestamp?: number;
 
+  /**
+   * Time when the event was observed by the collection system.
+   */
+  observedTimestamp?: number;
+
   /**
    * Numerical value of the severity.
    */

experimental/packages/exporter-logs-otlp-grpc/README.md

@@ -22,22 +22,22 @@ To see documentation and sample code for the metric exporter, see the [exporter-
 
 ## Logs in Node - GRPC
 
-The OTLPLogsExporter in Node expects the URL to only be the hostname. It will not work with `/v1/logs`. All
+The OTLPLogExporter in Node expects the URL to only be the hostname. It will not work with `/v1/logs`. All
 options that work with trace also work with logs.
 
 ```js
 import {
   LoggerProvider,
   BatchLogRecordProcessor,
 } from '@opentelemetry/sdk-logs';
-import { OTLPLogsExporter } from '@opentelemetry/exporter-logs-otlp-grpc';
+import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-grpc';
 
 const collectorOptions = {
   // url is optional and can be omitted - default is http://localhost:4317
   url: 'http://<collector-hostname>:<port>',
 };
 
-const loggerExporter = new OTLPLogsExporter(collectorOptions);
+const loggerExporter = new OTLPLogExporter(collectorOptions);
 const loggerProvider = new LoggerProvider();
 
 loggerProvider.addLogRecordProcessor(

experimental/packages/exporter-logs-otlp-grpc/src/OTLPLogsExporter.ts → experimental/packages/exporter-logs-otlp-grpc/src/OTLPLogExporter.ts

@@ -32,7 +32,7 @@ import {
 /**
  * OTLP Logs Exporter for Node
  */
-export class OTLPLogsExporter
+export class OTLPLogExporter
   extends OTLPGRPCExporterNodeBase<ReadableLogRecord, IExportLogsServiceRequest>
   implements LogRecordExporter
 {

experimental/packages/exporter-logs-otlp-grpc/src/index.ts

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 
-export * from './OTLPLogsExporter';
+export * from './OTLPLogExporter';

experimental/packages/exporter-logs-otlp-grpc/test/OTLPLogsExporter.test.ts → experimental/packages/exporter-logs-otlp-grpc/test/OTLPLogExporter.test.ts

@@ -22,7 +22,7 @@ import * as fs from 'fs';
 import * as grpc from '@grpc/grpc-js';
 import * as path from 'path';
 import * as sinon from 'sinon';
-import { OTLPLogsExporter } from '../src';
+import { OTLPLogExporter } from '../src';
 
 import {
   ensureExportedLogRecordIsCorrect,
@@ -55,10 +55,10 @@ const metadata = new grpc.Metadata();
 metadata.set('k', 'v');
 
 const testCollectorExporter = (params: TestParams) =>
-  describe(`OTLPLogsExporter - node ${
-    params.useTLS ? 'with' : 'without'
-  } TLS, ${params.metadata ? 'with' : 'without'} metadata`, () => {
-    let collectorExporter: OTLPLogsExporter;
+  describe(`OTLPLogExporter - node ${params.useTLS ? 'with' : 'without'} TLS, ${
+    params.metadata ? 'with' : 'without'
+  } metadata`, () => {
+    let collectorExporter: OTLPLogExporter;
     let server: grpc.Server;
     let exportedData: IResourceLogs | undefined;
     let reqMetadata: grpc.Metadata | undefined;
@@ -122,7 +122,7 @@ const testCollectorExporter = (params: TestParams) =>
             fs.readFileSync('./test/certs/client.crt')
           )
         : grpc.credentials.createInsecure();
-      collectorExporter = new OTLPLogsExporter({
+      collectorExporter = new OTLPLogExporter({
         url: 'https://' + address,
         credentials,
         metadata: params.metadata,
@@ -140,7 +140,7 @@ const testCollectorExporter = (params: TestParams) =>
       it('should warn about headers when using grpc', () => {
         // Need to stub/spy on the underlying logger as the 'diag' instance is global
         const spyLoggerWarn = sinon.stub(diag, 'warn');
-        collectorExporter = new OTLPLogsExporter({
+        collectorExporter = new OTLPLogExporter({
           url: `http://${address}`,
           headers: {
             foo: 'bar',
@@ -151,7 +151,7 @@ const testCollectorExporter = (params: TestParams) =>
       });
       it('should warn about path in url', () => {
         const spyLoggerWarn = sinon.stub(diag, 'warn');
-        collectorExporter = new OTLPLogsExporter({
+        collectorExporter = new OTLPLogExporter({
           url: `http://${address}/v1/logs`,
         });
         const args = spyLoggerWarn.args[0];
@@ -198,7 +198,7 @@ const testCollectorExporter = (params: TestParams) =>
             )
           : grpc.credentials.createInsecure();
 
-        const collectorExporterWithTimeout = new OTLPLogsExporter({
+        const collectorExporterWithTimeout = new OTLPLogExporter({
           url: 'grpcs://' + address,
           credentials,
           metadata: params.metadata,
@@ -229,7 +229,7 @@ const testCollectorExporter = (params: TestParams) =>
               fs.readFileSync('./test/certs/client.crt')
             )
           : grpc.credentials.createInsecure();
-        collectorExporter = new OTLPLogsExporter({
+        collectorExporter = new OTLPLogExporter({
           url: 'https://' + address,
           credentials,
           metadata: params.metadata,
@@ -272,7 +272,7 @@ const testCollectorExporter = (params: TestParams) =>
           : grpc.credentials.createInsecure();
 
         envSource.OTEL_EXPORTER_OTLP_COMPRESSION = 'gzip';
-        collectorExporter = new OTLPLogsExporter({
+        collectorExporter = new OTLPLogExporter({
           url: 'https://' + address,
           credentials,
           metadata: params.metadata,
@@ -286,17 +286,17 @@ const testCollectorExporter = (params: TestParams) =>
     });
   });
 
-describe('OTLPLogsExporter - node (getDefaultUrl)', () => {
+describe('OTLPLogExporter - node (getDefaultUrl)', () => {
   it('should default to localhost', done => {
-    const collectorExporter = new OTLPLogsExporter({});
+    const collectorExporter = new OTLPLogExporter({});
     setTimeout(() => {
       assert.strictEqual(collectorExporter['url'], 'localhost:4317');
       done();
     });
   });
   it('should keep the URL if included', done => {
     const url = 'http://foo.bar.com';
-    const collectorExporter = new OTLPLogsExporter({ url });
+    const collectorExporter = new OTLPLogExporter({ url });
     setTimeout(() => {
       assert.strictEqual(collectorExporter['url'], 'foo.bar.com');
       done();
@@ -308,21 +308,21 @@ describe('when configuring via environment', () => {
   const envSource = process.env;
   it('should use url defined in env', () => {
     envSource.OTEL_EXPORTER_OTLP_ENDPOINT = 'http://foo.bar';
-    const collectorExporter = new OTLPLogsExporter();
+    const collectorExporter = new OTLPLogExporter();
     assert.strictEqual(collectorExporter.url, 'foo.bar');
     envSource.OTEL_EXPORTER_OTLP_ENDPOINT = '';
   });
   it('should override global exporter url with signal url defined in env', () => {
     envSource.OTEL_EXPORTER_OTLP_ENDPOINT = 'http://foo.bar';
     envSource.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT = 'http://foo.logs';
-    const collectorExporter = new OTLPLogsExporter();
+    const collectorExporter = new OTLPLogExporter();
     assert.strictEqual(collectorExporter.url, 'foo.logs');
     envSource.OTEL_EXPORTER_OTLP_ENDPOINT = '';
     envSource.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT = '';
   });
   it('should use headers defined via env', () => {
     envSource.OTEL_EXPORTER_OTLP_HEADERS = 'foo=bar';
-    const collectorExporter = new OTLPLogsExporter();
+    const collectorExporter = new OTLPLogExporter();
     assert.deepStrictEqual(collectorExporter.metadata?.get('foo'), ['bar']);
     envSource.OTEL_EXPORTER_OTLP_HEADERS = '';
   });
@@ -332,7 +332,7 @@ describe('when configuring via environment', () => {
     metadata.set('goo', 'lol');
     envSource.OTEL_EXPORTER_OTLP_HEADERS = 'foo=jar,bar=foo';
     envSource.OTEL_EXPORTER_OTLP_LOGS_HEADERS = 'foo=boo';
-    const collectorExporter = new OTLPLogsExporter({ metadata });
+    const collectorExporter = new OTLPLogExporter({ metadata });
     assert.deepStrictEqual(collectorExporter.metadata?.get('foo'), ['boo']);
     assert.deepStrictEqual(collectorExporter.metadata?.get('bar'), ['foo']);
     assert.deepStrictEqual(collectorExporter.metadata?.get('goo'), ['lol']);

experimental/packages/exporter-logs-otlp-grpc/test/logsHelper.ts

@@ -45,6 +45,7 @@ export const mockedReadableLogRecord: ReadableLogRecord = {
     schemaUrl: 'http://url.to.schema',
   },
   hrTime: [1680253513, 123241635] as HrTime,
+  hrTimeObserved: [1683526948, 965142784] as HrTime,
   attributes: {
     'some-attribute': 'some attribute value',
   },
@@ -92,7 +93,7 @@ export function ensureExportedLogRecordIsCorrect(logRecord: ILogRecord) {
   );
   assert.strictEqual(
     logRecord.observedTimeUnixNano,
-    '1680253513123241728',
+    '1683526948965142784',
     'observedTimeUnixNano is wrong'
   );
   assert.strictEqual(

experimental/packages/exporter-trace-otlp-grpc/src/OTLPTraceExporter.ts

@@ -28,6 +28,11 @@ import {
   createExportTraceServiceRequest,
   IExportTraceServiceRequest,
 } from '@opentelemetry/otlp-transformer';
+import { VERSION } from './version';
+
+const USER_AGENT = {
+  'User-Agent': `OTel-OTLP-Exporter-JavaScript/${VERSION}`,
+};
 
 /**
  * OTLP Trace Exporter for Node
@@ -38,9 +43,12 @@ export class OTLPTraceExporter
 {
   constructor(config: OTLPGRPCExporterConfigNode = {}) {
     super(config);
-    const headers = baggageUtils.parseKeyPairsIntoRecord(
-      getEnv().OTEL_EXPORTER_OTLP_TRACES_HEADERS
-    );
+    const headers = {
+      ...USER_AGENT,
+      ...baggageUtils.parseKeyPairsIntoRecord(
+        getEnv().OTEL_EXPORTER_OTLP_TRACES_HEADERS
+      ),
+    };
     this.metadata ||= new Metadata();
     for (const [k, v] of Object.entries(headers)) {
       this.metadata.set(k, v);

experimental/packages/exporter-trace-otlp-grpc/test/OTLPTraceExporter.test.ts

@@ -27,6 +27,7 @@ import * as grpc from '@grpc/grpc-js';
 import * as path from 'path';
 import * as sinon from 'sinon';
 import { OTLPTraceExporter } from '../src';
+import { VERSION } from '../src/version';
 
 import {
   ensureExportedSpanIsCorrect,
@@ -336,6 +337,12 @@ describe('when configuring via environment', () => {
     assert.deepStrictEqual(collectorExporter.metadata?.get('foo'), ['bar']);
     envSource.OTEL_EXPORTER_OTLP_HEADERS = '';
   });
+  it('should include user agent in header', () => {
+    const collectorExporter = new OTLPTraceExporter();
+    assert.deepStrictEqual(collectorExporter.metadata?.get('User-Agent'), [
+      `OTel-OTLP-Exporter-JavaScript/${VERSION}`,
+    ]);
+  });
   it('should override global headers config with signal headers defined via env', () => {
     const metadata = new grpc.Metadata();
     metadata.set('foo', 'bar');

experimental/packages/exporter-trace-otlp-http/src/platform/node/OTLPTraceExporter.ts

@@ -26,9 +26,13 @@ import {
   createExportTraceServiceRequest,
   IExportTraceServiceRequest,
 } from '@opentelemetry/otlp-transformer';
+import { VERSION } from '../../version';
 
 const DEFAULT_COLLECTOR_RESOURCE_PATH = 'v1/traces';
 const DEFAULT_COLLECTOR_URL = `http://localhost:4318/${DEFAULT_COLLECTOR_RESOURCE_PATH}`;
+const USER_AGENT = {
+  'User-Agent': `OTel-OTLP-Exporter-JavaScript/${VERSION}`,
+};
 
 /**
  * Collector Trace Exporter for Node
@@ -39,12 +43,13 @@ export class OTLPTraceExporter
 {
   constructor(config: OTLPExporterNodeConfigBase = {}) {
     super(config);
-    this.headers = Object.assign(
-      this.headers,
-      baggageUtils.parseKeyPairsIntoRecord(
+    this.headers = {
+      ...this.headers,
+      ...USER_AGENT,
+      ...baggageUtils.parseKeyPairsIntoRecord(
         getEnv().OTEL_EXPORTER_OTLP_TRACES_HEADERS
-      )
-    );
+      ),
+    };
   }
 
   convert(spans: ReadableSpan[]): IExportTraceServiceRequest {

experimental/packages/exporter-trace-otlp-http/test/node/CollectorTraceExporter.test.ts

@@ -36,6 +36,7 @@ import {
 import { nextTick } from 'process';
 import { MockedResponse } from './nodeHelpers';
 import { IExportTraceServiceRequest } from '@opentelemetry/otlp-transformer';
+import { VERSION } from '../../src/version';
 
 let fakeRequest: PassThrough;
 
@@ -160,6 +161,13 @@ describe('OTLPTraceExporter - node with json over http', () => {
       assert.strictEqual(collectorExporter.headers.foo, 'bar');
       envSource.OTEL_EXPORTER_OTLP_HEADERS = '';
     });
+    it('should include user agent in header', () => {
+      const collectorExporter = new OTLPTraceExporter();
+      assert.strictEqual(
+        collectorExporter.headers['User-Agent'],
+        `OTel-OTLP-Exporter-JavaScript/${VERSION}`
+      );
+    });
     it('should override global headers config with signal headers defined via env', () => {
       envSource.OTEL_EXPORTER_OTLP_HEADERS = 'foo=bar,bar=foo';
       envSource.OTEL_EXPORTER_OTLP_TRACES_HEADERS = 'foo=boo';

experimental/packages/exporter-trace-otlp-proto/src/platform/node/OTLPTraceExporter.ts

@@ -29,9 +29,13 @@ import {
   createExportTraceServiceRequest,
   IExportTraceServiceRequest,
 } from '@opentelemetry/otlp-transformer';
+import { VERSION } from '../../version';
 
 const DEFAULT_COLLECTOR_RESOURCE_PATH = 'v1/traces';
 const DEFAULT_COLLECTOR_URL = `http://localhost:4318/${DEFAULT_COLLECTOR_RESOURCE_PATH}`;
+const USER_AGENT = {
+  'User-Agent': `OTel-OTLP-Exporter-JavaScript/${VERSION}`,
+};
 
 /**
  * Collector Trace Exporter for Node with protobuf
@@ -42,12 +46,13 @@ export class OTLPTraceExporter
 {
   constructor(config: OTLPExporterNodeConfigBase = {}) {
     super(config);
-    this.headers = Object.assign(
-      this.headers,
-      baggageUtils.parseKeyPairsIntoRecord(
+    this.headers = {
+      ...this.headers,
+      ...USER_AGENT,
+      ...baggageUtils.parseKeyPairsIntoRecord(
         getEnv().OTEL_EXPORTER_OTLP_TRACES_HEADERS
-      )
-    );
+      ),
+    };
   }
 
   convert(spans: ReadableSpan[]): IExportTraceServiceRequest {