add Events SDK

experimental/CHANGELOG.md

@@ -12,11 +12,13 @@ All notable changes to experimental packages in this project will be documented
   * `NodeSDK.configureLoggerProvider()`, please use constructor options instead
   * `NodeSDK.addResource()`, please use constructor options instead
   * `NodeSDK.detectResources()`, this is not necessary anymore, resources are now auto-detected on `NodeSDK.start()` if the constructor option `autoDetectResources` is unset, `undefined` or `true`.
+* feat(api-events): removed traceId and spanId from Event interface, added context and severityNumber [#4629](https://github.com/open-telemetry/opentelemetry-js/pull/4629)
 
 ### :rocket: (Enhancement)
 
 * feat(otlp-transformer): consolidate scope/resource creation in transformer [#4600](https://github.com/open-telemetry/opentelemetry-js/pull/4600)
 * feat(sdk-logs): print message when attributes are dropped due to attribute count limit [#4614](https://github.com/open-telemetry/opentelemetry-js/pull/4614) @HyunnoH
+* feat(sdk-events): add Events SDK [#4629](https://github.com/open-telemetry/opentelemetry-js/pull/4629)
 
 ### :bug: (Bug Fix)
 

experimental/examples/events/README.md

@@ -0,0 +1,23 @@
+## Installation
+
+```sh
+# from this directory
+npm install
+```
+
+## Run the Application
+
+LogRecord
+
+```sh
+npm start
+```
+
+## Useful links
+
+- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
+- For more information on OpenTelemetry logs, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/sdk-logs>
+
+## LICENSE
+
+Apache License 2.0

experimental/examples/events/index.ts

@@ -0,0 +1,52 @@
+/*
+ * Copyright The 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.
+ */
+
+import { DiagConsoleLogger, DiagLogLevel, diag } from '@opentelemetry/api';
+import { logs } from '@opentelemetry/api-logs';
+import {
+  LoggerProvider,
+  ConsoleLogRecordExporter,
+  SimpleLogRecordProcessor,
+} from '@opentelemetry/sdk-logs';
+import { events } from '@opentelemetry/api-events';
+import { EventLoggerProvider } from '@opentelemetry/sdk-events';
+
+// Optional and only needed to see the internal diagnostic logging (during development)
+diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.DEBUG);
+
+// configure global LoggerProvider
+const loggerProvider = new LoggerProvider();
+loggerProvider.addLogRecordProcessor(
+  new SimpleLogRecordProcessor(new ConsoleLogRecordExporter())
+);
+logs.setGlobalLoggerProvider(loggerProvider);
+
+// configure global EventLoggerProvider
+const eventLoggerProvider = new EventLoggerProvider();
+events.setGlobalEventLoggerProvider(eventLoggerProvider);
+
+// emit a log record
+const eventLogger = events.getEventLogger('example');
+eventLogger.emit({
+  name: 'my-event',
+  data: {
+    a: 1,
+    b: 'hello',
+    c: {
+      d: 123
+    }
+  }
+});

experimental/examples/events/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "events-example",
+  "version": "0.50.0",
+  "private": true,
+  "scripts": {
+    "start": "ts-node index.ts"
+  },
+  "dependencies": {
+    "@opentelemetry/api": "^1.7.0",
+    "@opentelemetry/api-logs": "0.50.0",
+    "@opentelemetry/sdk-logs": "0.50.0",
+    "@opentelemetry/api-events": "0.50.0",
+    "@opentelemetry/sdk-events": "0.50.0"
+  },
+  "devDependencies": {
+    "@types/node": "18.6.5",
+    "ts-node": "^10.9.1"
+  }
+}

experimental/examples/events/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "build",
+    "rootDir": "."
+  },
+  "include": ["./index.ts"],
+  "references": [
+    {
+      "path": "../../../api"
+    },
+    {
+      "path": "../../../experimental/packages/api-events"
+    },
+    {
+      "path": "../../../experimental/packages/api-logs"
+    },
+    {
+      "path": "../../../experimental/packages/sdk-events"
+    },
+    {
+      "path": "../../../experimental/packages/sdk-logs"
+    }
+  ]
+}

experimental/packages/api-events/package.json

@@ -14,20 +14,20 @@
   },
   "repository": "open-telemetry/opentelemetry-js",
   "scripts": {
-    "prepublishOnly": "npm run compile",
-    "compile": "tsc --build tsconfig.json tsconfig.esm.json tsconfig.esnext.json",
+    "build": "npm run compile",
     "clean": "tsc --build --clean tsconfig.json tsconfig.esm.json tsconfig.esnext.json",
-    "test": "nyc ts-mocha -p tsconfig.json test/**/*.test.ts",
-    "test:browser": "karma start --single-run",
     "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../../",
     "codecov:browser": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../../",
-    "build": "npm run compile",
+    "compile": "tsc --build tsconfig.json tsconfig.esm.json tsconfig.esnext.json",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --ext .ts --fix",
-    "version": "node ../../../scripts/version-update.js",
-    "watch": "tsc --build --watch tsconfig.json tsconfig.esm.json tsconfig.esnext.json",
+    "prepublishOnly": "npm run compile",
     "precompile": "cross-var lerna run version --scope $npm_package_name --include-dependencies",
-    "prewatch": "node ../../../scripts/version-update.js"
+    "prewatch": "node ../../../scripts/version-update.js",
+    "test": "nyc ts-mocha -p tsconfig.json test/**/*.test.ts",
+    "test:browser": "karma start --single-run",
+    "version": "node ../../../scripts/version-update.js",
+    "watch": "tsc --build --watch tsconfig.json tsconfig.esm.json tsconfig.esnext.json"
   },
   "keywords": [
     "opentelemetry",

experimental/packages/api-events/src/types/Event.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import { Attributes } from '@opentelemetry/api';
-import { AnyValue } from '@opentelemetry/api-logs';
+import { Attributes, Context } from '@opentelemetry/api';
+import { AnyValue, SeverityNumber } from '@opentelemetry/api-logs';
 
 export interface Event {
   /**
@@ -40,17 +40,12 @@ export interface Event {
   attributes?: Attributes;
 
   /**
-   * 8 least significant bits are the trace flags as defined in W3C Trace Context specification.
+   * Numerical value of the severity.
    */
-  traceFlags?: number;
+  severityNumber?: SeverityNumber;
 
   /**
-   * A unique identifier for a trace.
+   * The Context associated with the Event.
    */
-  traceId?: string;
-
-  /**
-   * A unique identifier for a span within a trace.
-   */
-  spanId?: string;
+  context?: Context;
 }

experimental/packages/sdk-events/.eslintignore

@@ -0,0 +1 @@
+build

experimental/packages/sdk-events/.eslintrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  env: {
+    mocha: true,
+    node: true,
+  },
+  ...require('../../../eslint.base.js'),
+};

experimental/packages/sdk-events/.npmignore

@@ -0,0 +1,4 @@
+/bin
+/coverage
+/doc
+/test