Logs SDK (#3549)

* feat(sdk-logs): sdk-logs init * feat(sdk-logs): sdk-logs init * feat(sdk-logs): sdk-logs init * feat(sdk-logs): sdk-logs init * feat(sdk-logs): sdk-logs init * feat(sdk-logs): sdk-logs init * feat(sdk-logs): sdk-logs init * fix compile errors * feat(sdk-logs): sdk-logs init * feat(sdk-logs): sdk-logs init * feat(sdk-logs): sdk-logs init * feat(sdk-logs): sdk-logs init * feat(sdk-logs): sdk-logs init * feat(sdk-logs): sdk-logs init * feat(sdk-logs): sdk-logs init * feat(sdk-logs): sdk-logs init * feat(sdk-logs): sdk-logs init * feat(sdk-logs): sdk-logs init * feat(sdk-logs): sdk-logs init * feat(sdk-logs): add browser test config * feat: add test-utils compatible assert.rejects * feat(sdk-logs): fix writing errors in README * feat(sdk-logs): update version to 0.36.1 * feat(sdk-logs): add examples * feat(sdk-logs): fix LogRecord default timestamp to Date.now() * feat(sdk-logs): logRecord support rewrite time/body/severityNumber/newSeverityText * feat(sdk-logs): add logs processor environments * feat(sdk-logs): modify export style * feat(sdk-logs): update version to 0.36.1 * feat(sdk-logs): remove exporter factory * feat(sdk-logs): update CHANGELOG * feat(sdk-logs): change the processing of schemeUrl * feat(sdk-logs): split LoggerProviderConfig and LoggerConfig * feat(sdk-logs): getLogger with default name when name is invalid * feat(sdk-logs): improve the shutdown logic of LoggerProvider * feat(sdk-logs): improve the shutdown logic of LoggerProvider * feat(sdk-logs): make log record read-only after it has been emitted * feat(sdk-logs): logger option support includeTraceContext & LogRecordProcessor onEmit suport context * feat(sdk-logs): update version * feat(sdk-logs): update version * feat(sdk-logs): update logs example with typescript * feat(sdk-logs): update peerDependencies * feat(sdk-logs): peer-api-check support @opentelemetry/api-logs * feat(sdk-logs): update peerDependencies --------- Co-authored-by: Martin Kuba <[email protected]> Co-authored-by: Daniel Dyla <[email protected]>
open-telemetry · Apr 13, 2023 · a31b38a · a31b38a
1 parent 26dfc70
commit a31b38a
Show file tree

Hide file tree

Showing 61 changed files with 3,972 additions and 20 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,6 +8,8 @@ logs
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+# Filter Logs singal files
+!experimental/examples/logs
 
 # Runtime data
 pids

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/
 ### :rocket: (Enhancement)
 
 * feat(tracing): log span name and IDs when span end is called multiple times [#3716](https://github.com/open-telemetry/opentelemetry-js/pull/3716)
+* feat(core): add logs environment variables; add timeout utils method. [#3549](https://github.com/open-telemetry/opentelemetry-js/pull/3549/) @fuaiyi
 
 ### :bug: (Bug Fix)
 

diff --git a/experimental/CHANGELOG.md b/experimental/CHANGELOG.md
@@ -11,6 +11,9 @@ All notable changes to experimental packages in this project will be documented
 
 ### :rocket: (Enhancement)
 
+* feat(api-logs): 1.`LogRecord` fields update: `traceFlags`/`traceId`/`spanId` -> `context`; 2.`Logger` supports configuring `includeTraceContext`; 3.The `onEmit` method of `LogRecordProcessor` supports the `context` field.  [#3549](https://github.com/open-telemetry/opentelemetry-js/pull/3549/) @fuaiyi
+* feat(sdk-logs): logs sdk implementation. [#3549](https://github.com/open-telemetry/opentelemetry-js/pull/3549/) @fuaiyi
+
 ### :bug: (Bug Fix)
 
 * fix(sdk-node): only set DiagConsoleLogger when OTEL_LOG_LEVEL is set [#3693](https://github.com/open-telemetry/opentelemetry-js/pull/3672) @pichlermarc

diff --git a/experimental/examples/logs/README.md b/experimental/examples/logs/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
diff --git a/experimental/examples/logs/index.ts b/experimental/examples/logs/index.ts
@@ -0,0 +1,43 @@
+/*
+ * 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, SeverityNumber } from '@opentelemetry/api-logs';
+import {
+  LoggerProvider,
+  ConsoleLogRecordExporter,
+  SimpleLogRecordProcessor,
+} from '@opentelemetry/sdk-logs';
+
+// Optional and only needed to see the internal diagnostic logging (during development)
+diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.DEBUG);
+
+const loggerProvider = new LoggerProvider();
+loggerProvider.addLogRecordProcessor(
+  new SimpleLogRecordProcessor(new ConsoleLogRecordExporter())
+);
+
+logs.setGlobalLoggerProvider(loggerProvider);
+
+const logger = logs.getLogger('example', '1.0.0');
+
+// emit a log record
+logger.emit({
+  severityNumber: SeverityNumber.INFO,
+  severityText: 'INFO',
+  body: 'this is a log record body',
+  attributes: { 'log.type': 'custom' },
+});
diff --git a/experimental/examples/logs/package.json b/experimental/examples/logs/package.json
@@ -0,0 +1,17 @@
+{
+  "name": "logs-example",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "start": "ts-node index.ts"
+  },
+  "dependencies": {
+    "@opentelemetry/api": "^1.4.1",
+    "@opentelemetry/api-logs": "^0.37.0",
+    "@opentelemetry/sdk-logs": "^0.37.0"
+  },
+  "devDependencies": {
+    "ts-node": "^10.9.1",
+    "@types/node": "18.6.5"
+  }
+}
diff --git a/experimental/examples/logs/tsconfig.json b/experimental/examples/logs/tsconfig.json
@@ -0,0 +1,19 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "build",
+    "rootDir": "."
+  },
+  "include": ["./index.ts"],
+  "references": [
+    {
+      "path": "../../../api"
+    },
+    {
+      "path": "../../../experimental/packages/api-logs"
+    },
+    {
+      "path": "../../../experimental/packages/sdk-logs"
+    }
+  ]
+}
diff --git a/experimental/packages/api-logs/src/NoopLogger.ts b/experimental/packages/api-logs/src/NoopLogger.ts
@@ -20,3 +20,5 @@ import { LogRecord } from './types/LogRecord';
 export class NoopLogger implements Logger {
   emit(_logRecord: LogRecord): void {}
 }
+
+export const NOOP_LOGGER = new NoopLogger();
diff --git a/experimental/packages/api-logs/src/index.ts b/experimental/packages/api-logs/src/index.ts
@@ -18,6 +18,8 @@ export * from './types/Logger';
 export * from './types/LoggerProvider';
 export * from './types/LogRecord';
 export * from './types/LoggerOptions';
+export * from './NoopLogger';
+export * from './NoopLoggerProvider';
 
 import { LogsAPI } from './api/logs';
 export const logs = LogsAPI.getInstance();
diff --git a/experimental/packages/api-logs/src/types/LogRecord.ts b/experimental/packages/api-logs/src/types/LogRecord.ts
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { Attributes } from '@opentelemetry/api';
+import { Attributes, Context } from '@opentelemetry/api';
 
 export enum SeverityNumber {
   UNSPECIFIED = 0,
@@ -71,17 +71,7 @@ export interface LogRecord {
   attributes?: Attributes;
 
   /**
-   * 8 least significant bits are the trace flags as defined in W3C Trace Context specification.
+   * The Context associated with the LogRecord.
    */
-  traceFlags?: number;
-
-  /**
-   * A unique identifier for a trace.
-   */
-  traceId?: string;
-
-  /**
-   * A unique identifier for a span within a trace.
-   */
-  spanId?: string;
+  context?: Context;
 }
diff --git a/experimental/packages/api-logs/src/types/LoggerOptions.ts b/experimental/packages/api-logs/src/types/LoggerOptions.ts
@@ -27,4 +27,10 @@ export interface LoggerOptions {
    * The instrumentation scope attributes to associate with emitted telemetry
    */
   scopeAttributes?: Attributes;
+
+  /**
+   * Specifies whether the Trace Context should automatically be passed on to the LogRecords emitted by the Logger.
+   * @default true
+   */
+  includeTraceContext?: boolean;
 }
diff --git a/experimental/packages/sdk-logs/.eslintignore b/experimental/packages/sdk-logs/.eslintignore
@@ -0,0 +1 @@
+build
diff --git a/experimental/packages/sdk-logs/.eslintrc.js b/experimental/packages/sdk-logs/.eslintrc.js
@@ -0,0 +1,7 @@
+module.exports = {
+  env: {
+    mocha: true,
+    node: true,
+  },
+  ...require('../../../eslint.config.js'),
+};
diff --git a/experimental/packages/sdk-logs/.npmignore b/experimental/packages/sdk-logs/.npmignore
@@ -0,0 +1,4 @@
+/bin
+/coverage
+/doc
+/test