From 051caa6e3e3579d47e72458c2739f7cf32c6f244 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Mon, 11 Jul 2022 17:39:42 -0700 Subject: [PATCH 01/27] draft of logs API --- .../opentelemetry-api-logs/.eslintignore | 1 + .../opentelemetry-api-logs/.eslintrc.js | 8 + .../packages/opentelemetry-api-logs/LICENSE | 201 ++++++++++++++++++ .../opentelemetry-api-logs/package.json | 48 +++++ .../src/NonRecordingEvent.ts | 28 +++ .../src/NonRecordingLogRecord.ts | 28 +++ .../opentelemetry-api-logs/src/NoopLogger.ts | 38 ++++ .../src/NoopLoggerProvider.ts | 27 +++ .../opentelemetry-api-logs/src/api/logs.ts | 75 +++++++ .../opentelemetry-api-logs/src/index.ts | 24 +++ .../src/internal/global-utils.ts | 55 +++++ .../src/platform/browser/globalThis.ts | 35 +++ .../src/platform/browser/index.ts | 17 ++ .../src/platform/index.ts | 17 ++ .../src/platform/node/globalThis.ts | 19 ++ .../src/platform/node/index.ts | 17 ++ .../opentelemetry-api-logs/src/types/Event.ts | 53 +++++ .../src/types/LogRecord.ts | 47 ++++ .../src/types/Logger.ts | 59 +++++ .../src/types/LoggerOptions.ts | 19 ++ .../src/types/LoggerProvider.ts | 34 +++ .../opentelemetry-api-logs/tsconfig.all.json | 9 + .../opentelemetry-api-logs/tsconfig.docs.json | 15 ++ .../opentelemetry-api-logs/tsconfig.esm.json | 11 + .../tsconfig.esnext.json | 11 + .../opentelemetry-api-logs/tsconfig.json | 11 + 26 files changed, 907 insertions(+) create mode 100644 experimental/packages/opentelemetry-api-logs/.eslintignore create mode 100644 experimental/packages/opentelemetry-api-logs/.eslintrc.js create mode 100644 experimental/packages/opentelemetry-api-logs/LICENSE create mode 100644 experimental/packages/opentelemetry-api-logs/package.json create mode 100644 experimental/packages/opentelemetry-api-logs/src/NonRecordingEvent.ts create mode 100644 experimental/packages/opentelemetry-api-logs/src/NonRecordingLogRecord.ts create mode 100644 experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts create mode 100644 experimental/packages/opentelemetry-api-logs/src/NoopLoggerProvider.ts create mode 100644 experimental/packages/opentelemetry-api-logs/src/api/logs.ts create mode 100644 experimental/packages/opentelemetry-api-logs/src/index.ts create mode 100644 experimental/packages/opentelemetry-api-logs/src/internal/global-utils.ts create mode 100644 experimental/packages/opentelemetry-api-logs/src/platform/browser/globalThis.ts create mode 100644 experimental/packages/opentelemetry-api-logs/src/platform/browser/index.ts create mode 100644 experimental/packages/opentelemetry-api-logs/src/platform/index.ts create mode 100644 experimental/packages/opentelemetry-api-logs/src/platform/node/globalThis.ts create mode 100644 experimental/packages/opentelemetry-api-logs/src/platform/node/index.ts create mode 100644 experimental/packages/opentelemetry-api-logs/src/types/Event.ts create mode 100644 experimental/packages/opentelemetry-api-logs/src/types/LogRecord.ts create mode 100644 experimental/packages/opentelemetry-api-logs/src/types/Logger.ts create mode 100644 experimental/packages/opentelemetry-api-logs/src/types/LoggerOptions.ts create mode 100644 experimental/packages/opentelemetry-api-logs/src/types/LoggerProvider.ts create mode 100644 experimental/packages/opentelemetry-api-logs/tsconfig.all.json create mode 100644 experimental/packages/opentelemetry-api-logs/tsconfig.docs.json create mode 100644 experimental/packages/opentelemetry-api-logs/tsconfig.esm.json create mode 100644 experimental/packages/opentelemetry-api-logs/tsconfig.esnext.json create mode 100644 experimental/packages/opentelemetry-api-logs/tsconfig.json diff --git a/experimental/packages/opentelemetry-api-logs/.eslintignore b/experimental/packages/opentelemetry-api-logs/.eslintignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/.eslintignore @@ -0,0 +1 @@ +build diff --git a/experimental/packages/opentelemetry-api-logs/.eslintrc.js b/experimental/packages/opentelemetry-api-logs/.eslintrc.js new file mode 100644 index 0000000000..7654abb6ac --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/.eslintrc.js @@ -0,0 +1,8 @@ +module.exports = { + "env": { + "mocha": true, + "commonjs": true, + "shared-node-browser": true + }, + ...require('../../../eslint.config.js') +} diff --git a/experimental/packages/opentelemetry-api-logs/LICENSE b/experimental/packages/opentelemetry-api-logs/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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 + + http://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. diff --git a/experimental/packages/opentelemetry-api-logs/package.json b/experimental/packages/opentelemetry-api-logs/package.json new file mode 100644 index 0000000000..b1726aaa12 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/package.json @@ -0,0 +1,48 @@ +{ + "name": "@opentelemetry/api-logs", + "version": "0.0.1", + "description": "Public logs API for OpenTelemetry", + "main": "build/src/index.js", + "module": "build/esm/index.js", + "esnext": "build/esnext/index.js", + "types": "build/src/index.d.ts", + "browser": { + "./src/platform/index.ts": "./src/platform/browser/index.ts", + "./build/esm/platform/index.js": "./build/esm/platform/browser/index.js", + "./build/esnext/platform/index.js": "./build/esnext/platform/browser/index.js", + "./build/src/platform/index.js": "./build/src/platform/browser/index.js" + }, + "scripts": { + "prepublishOnly": "npm run compile", + "compile": "tsc --build tsconfig.all.json", + "clean": "tsc --build --clean tsconfig.all.json", + "test": "nyc ts-mocha -p tsconfig.json test/**/*.test.ts", + "test:browser": "nyc 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", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "version": "node ../../../scripts/version-update.js", + "watch": "tsc --build --watch tsconfig.all.json", + "precompile": "lerna run version --scope $(npm pkg get name) --include-dependencies", + "prewatch": "node ../../../scripts/version-update.js" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/open-telemetry/opentelemetry-js.git" + }, + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "bugs": { + "url": "https://github.com/open-telemetry/opentelemetry-js/issues" + }, + "homepage": "https://github.com/open-telemetry/opentelemetry-js#readme", + "devDependencies": { + "typescript": "4.4.4", + "webpack": "4.46.0" + }, + "dependencies": { + "@opentelemetry/api": "^1.1.0" + } +} diff --git a/experimental/packages/opentelemetry-api-logs/src/NonRecordingEvent.ts b/experimental/packages/opentelemetry-api-logs/src/NonRecordingEvent.ts new file mode 100644 index 0000000000..7a2a12505e --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/src/NonRecordingEvent.ts @@ -0,0 +1,28 @@ +/* + * 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 { AttributeValue, Attributes } from '@opentelemetry/api'; +import { Event } from './types/Event'; + +export class NonRecordingEvent extends Event { + setAttribute(key: string, value?: AttributeValue): this { + return this; + } + + setAttributes(attributes: Attributes): this { + return this; + } +} diff --git a/experimental/packages/opentelemetry-api-logs/src/NonRecordingLogRecord.ts b/experimental/packages/opentelemetry-api-logs/src/NonRecordingLogRecord.ts new file mode 100644 index 0000000000..6e88848401 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/src/NonRecordingLogRecord.ts @@ -0,0 +1,28 @@ +/* + * 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 { AttributeValue, Attributes } from '@opentelemetry/api'; +import { LogRecord } from './types/LogRecord'; + +export class NonRecordingLogRecord implements LogRecord { + setAttribute(key: string, value?: AttributeValue | undefined): this { + return this; + } + + setAttributes(attributes: Attributes): this { + return this; + } +} diff --git a/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts b/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts new file mode 100644 index 0000000000..777d26d9fc --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts @@ -0,0 +1,38 @@ +/* + * 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 { Logger } from './types/Logger'; +import { Event } from './types/Event'; +import { Attributes } from '@opentelemetry/api'; +import { LogRecord } from './types/LogRecord'; +import { NonRecordingLogRecord } from './NonRecordingLogRecord'; +import { NonRecordingEvent } from './NonRecordingEvent'; + +export class NoopLogger implements Logger { + createLogRecord(): LogRecord { + return new NonRecordingLogRecord(); + } + + createEvent(name: string, domain?: string): Event { + return new NonRecordingEvent(name, domain); + } + + emit(logRecord: LogRecord): void; + emit(event: Event): void; + emit(event: unknown): void {} + + emitEvent(name: string, attributes?: Attributes): void {} +} diff --git a/experimental/packages/opentelemetry-api-logs/src/NoopLoggerProvider.ts b/experimental/packages/opentelemetry-api-logs/src/NoopLoggerProvider.ts new file mode 100644 index 0000000000..9735953e3b --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/src/NoopLoggerProvider.ts @@ -0,0 +1,27 @@ +/* + * 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 { LoggerProvider } from './types/LoggerProvider'; +import { Logger } from './types/Logger'; +import { LoggerOptions } from './types/LoggerOptions'; + +export class NoopLoggerProvider implements LoggerProvider { + getLogger(name: string, version?: string | undefined, options?: LoggerOptions | undefined): Logger { + throw new Error('Method not implemented.'); + } +} + +export const NOOP_LOGGER_PROVIDER = new NoopLoggerProvider(); diff --git a/experimental/packages/opentelemetry-api-logs/src/api/logs.ts b/experimental/packages/opentelemetry-api-logs/src/api/logs.ts new file mode 100644 index 0000000000..76c64e293a --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/src/api/logs.ts @@ -0,0 +1,75 @@ +/* + * 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 { + API_BACKWARDS_COMPATIBILITY_VERSION, + GLOBAL_LOGS_API_KEY, + _global, + makeGetter +} from '../internal/global-utils'; +import { LoggerProvider } from '../types/LoggerProvider'; +import { NOOP_LOGGER_PROVIDER } from '../NoopLoggerProvider'; +import { Logger } from '../types/Logger'; +import { LoggerOptions } from '../types/LoggerOptions'; + +export class LogsAPI { + private static _instance?: LogsAPI; + + private constructor() {} + + public static getInstance(): LogsAPI { + if (!this._instance) { + this._instance = new LogsAPI(); + } + + return this._instance; + } + + public setGlobalLoggerProvider(provider: LoggerProvider): LoggerProvider { + if (_global[GLOBAL_LOGS_API_KEY]) { + return this.getLoggerProvider(); + } + + _global[GLOBAL_LOGS_API_KEY] = makeGetter( + API_BACKWARDS_COMPATIBILITY_VERSION, + provider, + NOOP_LOGGER_PROVIDER + ); + + return provider; + } + + /** + * Returns the global logger provider. + * + * @returns LoggerProvider + */ + public getLoggerProvider(): LoggerProvider { + return ( + _global[GLOBAL_LOGS_API_KEY]?.(API_BACKWARDS_COMPATIBILITY_VERSION) ?? + NOOP_LOGGER_PROVIDER + ); + } + + /** + * Returns a logger from the global logger provider. + * + * @returns Logger + */ + public getLogger(name: string, version?: string, options?: LoggerOptions): Logger { + return this.getLoggerProvider().getLogger(name, version); + } +} diff --git a/experimental/packages/opentelemetry-api-logs/src/index.ts b/experimental/packages/opentelemetry-api-logs/src/index.ts new file mode 100644 index 0000000000..8732221d9a --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/src/index.ts @@ -0,0 +1,24 @@ +/* + * 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. + */ + +export * from './types/Logger'; +export * from './types/LoggerProvider'; +export * from './types/LogRecord'; +export * from './types/Event'; +export * from './types/LoggerOptions'; + +import { LogsAPI } from './api/logs'; +export const logs = LogsAPI.getInstance(); diff --git a/experimental/packages/opentelemetry-api-logs/src/internal/global-utils.ts b/experimental/packages/opentelemetry-api-logs/src/internal/global-utils.ts new file mode 100644 index 0000000000..af5e924c59 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/src/internal/global-utils.ts @@ -0,0 +1,55 @@ +/* + * 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 { LoggerProvider } from '../types/LoggerProvider'; +import { _globalThis } from '../platform'; + +export const GLOBAL_LOGS_API_KEY = Symbol.for( + 'io.opentelemetry.js.api.logs' +); + +type Get = (version: number) => T; +type OtelGlobal = Partial<{ + [GLOBAL_LOGS_API_KEY]: Get; +}>; + +export const _global = _globalThis as OtelGlobal; + +/** + * Make a function which accepts a version integer and returns the instance of an API if the version + * is compatible, or a fallback version (usually NOOP) if it is not. + * + * @param requiredVersion Backwards compatibility version which is required to return the instance + * @param instance Instance which should be returned if the required version is compatible + * @param fallback Fallback instance, usually NOOP, which will be returned if the required version is not compatible + */ +export function makeGetter( + requiredVersion: number, + instance: T, + fallback: T +): Get { + return (version: number): T => + version === requiredVersion ? instance : fallback; +} + +/** + * A number which should be incremented each time a backwards incompatible + * change is made to the API. This number is used when an API package + * attempts to access the global API to ensure it is getting a compatible + * version. If the global API is not compatible with the API package + * attempting to get it, a NOOP API implementation will be returned. + */ +export const API_BACKWARDS_COMPATIBILITY_VERSION = 4; diff --git a/experimental/packages/opentelemetry-api-logs/src/platform/browser/globalThis.ts b/experimental/packages/opentelemetry-api-logs/src/platform/browser/globalThis.ts new file mode 100644 index 0000000000..693547b7c2 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/src/platform/browser/globalThis.ts @@ -0,0 +1,35 @@ +/* + * 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. + */ + +// Updates to this file should also be replicated to @opentelemetry/api and +// @opentelemetry/core too. + +/** + * - globalThis (New standard) + * - self (Will return the current window instance for supported browsers) + * - window (fallback for older browser implementations) + * - global (NodeJS implementation) + * - (When all else fails) + */ + +/** only globals that common to node and browsers are allowed */ +// eslint-disable-next-line node/no-unsupported-features/es-builtins, no-undef +export const _globalThis: typeof globalThis = + typeof globalThis === 'object' ? globalThis : + typeof self === 'object' ? self : + typeof window === 'object' ? window : + typeof global === 'object' ? global : + {} as typeof globalThis; diff --git a/experimental/packages/opentelemetry-api-logs/src/platform/browser/index.ts b/experimental/packages/opentelemetry-api-logs/src/platform/browser/index.ts new file mode 100644 index 0000000000..e9d6ebed71 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/src/platform/browser/index.ts @@ -0,0 +1,17 @@ +/* + * 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. + */ + +export * from './globalThis'; diff --git a/experimental/packages/opentelemetry-api-logs/src/platform/index.ts b/experimental/packages/opentelemetry-api-logs/src/platform/index.ts new file mode 100644 index 0000000000..3f9ab45f9f --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/src/platform/index.ts @@ -0,0 +1,17 @@ +/* + * 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. + */ + +export * from './browser'; diff --git a/experimental/packages/opentelemetry-api-logs/src/platform/node/globalThis.ts b/experimental/packages/opentelemetry-api-logs/src/platform/node/globalThis.ts new file mode 100644 index 0000000000..36e97e2732 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/src/platform/node/globalThis.ts @@ -0,0 +1,19 @@ +/* + * 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. + */ + +/** only globals that common to node and browsers are allowed */ +// eslint-disable-next-line node/no-unsupported-features/es-builtins +export const _globalThis = typeof globalThis === 'object' ? globalThis : global; diff --git a/experimental/packages/opentelemetry-api-logs/src/platform/node/index.ts b/experimental/packages/opentelemetry-api-logs/src/platform/node/index.ts new file mode 100644 index 0000000000..e9d6ebed71 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/src/platform/node/index.ts @@ -0,0 +1,17 @@ +/* + * 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. + */ + +export * from './globalThis'; diff --git a/experimental/packages/opentelemetry-api-logs/src/types/Event.ts b/experimental/packages/opentelemetry-api-logs/src/types/Event.ts new file mode 100644 index 0000000000..6ed26dd9e9 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/src/types/Event.ts @@ -0,0 +1,53 @@ +/* + * 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 { Attributes, AttributeValue } from '@opentelemetry/api'; +import { LogRecord } from './LogRecord'; + +export abstract class Event implements LogRecord { + name: string; + domain?: string; + + constructor(name: string, domain?: string) { + this.name = name; + this.setAttribute('event.name', name); + + if (domain) { + this.domain = domain; + this.setAttribute('event.domain', name); + } + } + + /** + * Sets an attribute to the event. + * + * Sets a single Attribute with the key and value passed as arguments. + * + * @param key the key for this attribute. + * @param value the value for this attribute. Setting a value null or + * undefined is invalid and will result in undefined behavior. + */ + abstract setAttribute(key: string, value?: AttributeValue): this; + + /** + * Sets attributes to the event. + * + * @param attributes the attributes that will be added. + * null or undefined attribute values + * are invalid and will result in undefined behavior. + */ + abstract setAttributes(attributes: Attributes): this; +} diff --git a/experimental/packages/opentelemetry-api-logs/src/types/LogRecord.ts b/experimental/packages/opentelemetry-api-logs/src/types/LogRecord.ts new file mode 100644 index 0000000000..5bcd959055 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/src/types/LogRecord.ts @@ -0,0 +1,47 @@ +/* + * 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 { Attributes, AttributeValue } from '@opentelemetry/api'; + +export interface LogRecord { + /** + * Sets an attribute to the log record. + * + * Sets a single Attribute with the key and value passed as arguments. + * + * @param key the key for this attribute. + * @param value the value for this attribute. Setting a value null or + * undefined is invalid and will result in undefined behavior. + */ + setAttribute(key: string, value?: AttributeValue): this; + + /** + * Sets attributes to the span. + * + * @param attributes the attributes that will be added. + * null or undefined attribute values + * are invalid and will result in undefined behavior. + */ + + /** + * Sets attributes to the event. + * + * @param attributes the attributes that will be added. + * null or undefined attribute values + * are invalid and will result in undefined behavior. + */ + setAttributes(attributes: Attributes): this; +} diff --git a/experimental/packages/opentelemetry-api-logs/src/types/Logger.ts b/experimental/packages/opentelemetry-api-logs/src/types/Logger.ts new file mode 100644 index 0000000000..5d8324c32d --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/src/types/Logger.ts @@ -0,0 +1,59 @@ +/* + * 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 { Attributes } from '@opentelemetry/api'; +import { LogRecord } from './LogRecord'; +import { Event } from './Event'; + +export interface Logger { + /** + * Creates a new LogRecord. + * + * @returns LogRecord + */ + createLogRecord(): LogRecord; + + /** + * Creates a new Event. + * + * @param name the name of the event + * @param [domain] the domain of the event + * @returns Event The newly created event + */ + createEvent(name: string, domain?: string): Event; + + /** + * Emits a log record + * + * @param logRecord + */ + emit(logRecord: LogRecord): void; + + /** + * Emits an event + * + * @param event + */ + emit(event: Event): void; + + /** + * Emits an event + * + * @param name + * @param attributes + */ + emitEvent(name: string, attributes?: Attributes): void; +} diff --git a/experimental/packages/opentelemetry-api-logs/src/types/LoggerOptions.ts b/experimental/packages/opentelemetry-api-logs/src/types/LoggerOptions.ts new file mode 100644 index 0000000000..83bd3acbc3 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/src/types/LoggerOptions.ts @@ -0,0 +1,19 @@ +/* + * 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. + */ + +export interface LoggerOptions { + schemaUrl?: string; +} diff --git a/experimental/packages/opentelemetry-api-logs/src/types/LoggerProvider.ts b/experimental/packages/opentelemetry-api-logs/src/types/LoggerProvider.ts new file mode 100644 index 0000000000..e79aa1ce09 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/src/types/LoggerProvider.ts @@ -0,0 +1,34 @@ +/* + * 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 { Logger } from './Logger'; +import { LoggerOptions } from './LoggerOptions'; + +/** + * A registry for creating named {@link Logger}s. + */ +export interface LoggerProvider { + /** + * Returns a Logger, creating one if one with the given name, version, and + * schemaUrl pair is not already created. + * + * @param name The name of the logger or instrumentation library. + * @param version The version of the logger or instrumentation library. + * @param options The options of the logger or instrumentation library. + * @returns Logger A Logger with the given name and version + */ + getLogger(name: string, version?: string, options?: LoggerOptions): Logger; +} diff --git a/experimental/packages/opentelemetry-api-logs/tsconfig.all.json b/experimental/packages/opentelemetry-api-logs/tsconfig.all.json new file mode 100644 index 0000000000..06c5491334 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/tsconfig.all.json @@ -0,0 +1,9 @@ +{ + "extends": "../../../tsconfig.base.json", + "files": [], + "references": [ + { "path": "./tsconfig.json" }, + { "path": "./tsconfig.esm.json" }, + { "path": "./tsconfig.esnext.json" } + ] +} diff --git a/experimental/packages/opentelemetry-api-logs/tsconfig.docs.json b/experimental/packages/opentelemetry-api-logs/tsconfig.docs.json new file mode 100644 index 0000000000..627fa3ff3e --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/tsconfig.docs.json @@ -0,0 +1,15 @@ +{ + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts" + ], + "typedocOptions": { + "name": "OpenTelemetry API for JavaScript", + "out": "docs/out", + "mode": "file", + "hideGenerator": true + } +} diff --git a/experimental/packages/opentelemetry-api-logs/tsconfig.esm.json b/experimental/packages/opentelemetry-api-logs/tsconfig.esm.json new file mode 100644 index 0000000000..379f547a46 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/tsconfig.esm.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.base.esm.json", + "compilerOptions": { + "rootDir": "src", + "outDir": "build/esm", + "tsBuildInfoFile": "build/esm/tsconfig.esm.tsbuildinfo" + }, + "include": [ + "src/**/*.ts" + ] +} diff --git a/experimental/packages/opentelemetry-api-logs/tsconfig.esnext.json b/experimental/packages/opentelemetry-api-logs/tsconfig.esnext.json new file mode 100644 index 0000000000..cb78dd6ff3 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/tsconfig.esnext.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.base.esnext.json", + "compilerOptions": { + "rootDir": "src", + "outDir": "build/esnext", + "tsBuildInfoFile": "build/esnext/tsconfig.esnext.tsbuildinfo" + }, + "include": [ + "src/**/*.ts" + ] +} diff --git a/experimental/packages/opentelemetry-api-logs/tsconfig.json b/experimental/packages/opentelemetry-api-logs/tsconfig.json new file mode 100644 index 0000000000..ed9d0830bd --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.base.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] +} From 381cf4443963e87ea637c3020ccd6b39071a4a68 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Thu, 28 Jul 2022 15:51:10 -0700 Subject: [PATCH 02/27] added all fields to LoggerOptions, removed emit(Event), return NoopLogger --- .../src/NoopLoggerProvider.ts | 3 ++- .../src/types/Logger.ts | 7 ------ .../src/types/LoggerOptions.ts | 23 +++++++++++++++++++ 3 files changed, 25 insertions(+), 8 deletions(-) diff --git a/experimental/packages/opentelemetry-api-logs/src/NoopLoggerProvider.ts b/experimental/packages/opentelemetry-api-logs/src/NoopLoggerProvider.ts index 9735953e3b..93cce3e65b 100644 --- a/experimental/packages/opentelemetry-api-logs/src/NoopLoggerProvider.ts +++ b/experimental/packages/opentelemetry-api-logs/src/NoopLoggerProvider.ts @@ -17,10 +17,11 @@ import { LoggerProvider } from './types/LoggerProvider'; import { Logger } from './types/Logger'; import { LoggerOptions } from './types/LoggerOptions'; +import { NoopLogger } from './NoopLogger'; export class NoopLoggerProvider implements LoggerProvider { getLogger(name: string, version?: string | undefined, options?: LoggerOptions | undefined): Logger { - throw new Error('Method not implemented.'); + return new NoopLogger(); } } diff --git a/experimental/packages/opentelemetry-api-logs/src/types/Logger.ts b/experimental/packages/opentelemetry-api-logs/src/types/Logger.ts index 5d8324c32d..59a47974d2 100644 --- a/experimental/packages/opentelemetry-api-logs/src/types/Logger.ts +++ b/experimental/packages/opentelemetry-api-logs/src/types/Logger.ts @@ -42,13 +42,6 @@ export interface Logger { */ emit(logRecord: LogRecord): void; - /** - * Emits an event - * - * @param event - */ - emit(event: Event): void; - /** * Emits an event * diff --git a/experimental/packages/opentelemetry-api-logs/src/types/LoggerOptions.ts b/experimental/packages/opentelemetry-api-logs/src/types/LoggerOptions.ts index 83bd3acbc3..9ca7dd160e 100644 --- a/experimental/packages/opentelemetry-api-logs/src/types/LoggerOptions.ts +++ b/experimental/packages/opentelemetry-api-logs/src/types/LoggerOptions.ts @@ -14,6 +14,29 @@ * limitations under the License. */ +import { Attributes } from "@opentelemetry/api"; + export interface LoggerOptions { + /** + * The schemaUrl of the tracer or instrumentation library + * @default '' + */ schemaUrl?: string; + + /** + * The domain for the events created + * @default '' + */ + eventDomain?: string; + + /** + * Specifies whether the Trace Context should automatically be passed on to the events and logs created by the Logger + * @default false + */ + includeTraceContext?: boolean; + + /** + * The instrumentation scope attributes to associate with emitted telemetry + */ + attributes?: Attributes; } From 56c52c69b21ef9307918f3e0213dc768bd2b170a Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Thu, 28 Jul 2022 16:00:08 -0700 Subject: [PATCH 03/27] lint --- .../opentelemetry-api-logs/src/NonRecordingEvent.ts | 4 ++-- .../opentelemetry-api-logs/src/NonRecordingLogRecord.ts | 4 ++-- .../packages/opentelemetry-api-logs/src/NoopLogger.ts | 4 ++-- .../opentelemetry-api-logs/src/NoopLoggerProvider.ts | 2 +- .../packages/opentelemetry-api-logs/src/api/logs.ts | 2 +- .../src/platform/browser/globalThis.ts | 6 +++--- .../packages/opentelemetry-api-logs/src/types/Event.ts | 2 +- .../packages/opentelemetry-api-logs/src/types/Logger.ts | 6 +++--- .../opentelemetry-api-logs/src/types/LoggerOptions.ts | 2 +- 9 files changed, 16 insertions(+), 16 deletions(-) diff --git a/experimental/packages/opentelemetry-api-logs/src/NonRecordingEvent.ts b/experimental/packages/opentelemetry-api-logs/src/NonRecordingEvent.ts index 7a2a12505e..7cc7ed51c1 100644 --- a/experimental/packages/opentelemetry-api-logs/src/NonRecordingEvent.ts +++ b/experimental/packages/opentelemetry-api-logs/src/NonRecordingEvent.ts @@ -18,11 +18,11 @@ import { AttributeValue, Attributes } from '@opentelemetry/api'; import { Event } from './types/Event'; export class NonRecordingEvent extends Event { - setAttribute(key: string, value?: AttributeValue): this { + setAttribute(_key: string, _value?: AttributeValue): this { return this; } - setAttributes(attributes: Attributes): this { + setAttributes(_attributes: Attributes): this { return this; } } diff --git a/experimental/packages/opentelemetry-api-logs/src/NonRecordingLogRecord.ts b/experimental/packages/opentelemetry-api-logs/src/NonRecordingLogRecord.ts index 6e88848401..5c5ef551f7 100644 --- a/experimental/packages/opentelemetry-api-logs/src/NonRecordingLogRecord.ts +++ b/experimental/packages/opentelemetry-api-logs/src/NonRecordingLogRecord.ts @@ -18,11 +18,11 @@ import { AttributeValue, Attributes } from '@opentelemetry/api'; import { LogRecord } from './types/LogRecord'; export class NonRecordingLogRecord implements LogRecord { - setAttribute(key: string, value?: AttributeValue | undefined): this { + setAttribute(_key: string, _value?: AttributeValue | undefined): this { return this; } - setAttributes(attributes: Attributes): this { + setAttributes(_attributes: Attributes): this { return this; } } diff --git a/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts b/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts index 777d26d9fc..f57a3b037d 100644 --- a/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts +++ b/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts @@ -32,7 +32,7 @@ export class NoopLogger implements Logger { emit(logRecord: LogRecord): void; emit(event: Event): void; - emit(event: unknown): void {} + emit(_event: unknown): void {} - emitEvent(name: string, attributes?: Attributes): void {} + emitEvent(_name: string, _attributes?: Attributes): void {} } diff --git a/experimental/packages/opentelemetry-api-logs/src/NoopLoggerProvider.ts b/experimental/packages/opentelemetry-api-logs/src/NoopLoggerProvider.ts index 93cce3e65b..5c69e5a7bd 100644 --- a/experimental/packages/opentelemetry-api-logs/src/NoopLoggerProvider.ts +++ b/experimental/packages/opentelemetry-api-logs/src/NoopLoggerProvider.ts @@ -20,7 +20,7 @@ import { LoggerOptions } from './types/LoggerOptions'; import { NoopLogger } from './NoopLogger'; export class NoopLoggerProvider implements LoggerProvider { - getLogger(name: string, version?: string | undefined, options?: LoggerOptions | undefined): Logger { + getLogger(_name: string, _version?: string | undefined, _options?: LoggerOptions | undefined): Logger { return new NoopLogger(); } } diff --git a/experimental/packages/opentelemetry-api-logs/src/api/logs.ts b/experimental/packages/opentelemetry-api-logs/src/api/logs.ts index 76c64e293a..f41b73d9d0 100644 --- a/experimental/packages/opentelemetry-api-logs/src/api/logs.ts +++ b/experimental/packages/opentelemetry-api-logs/src/api/logs.ts @@ -70,6 +70,6 @@ export class LogsAPI { * @returns Logger */ public getLogger(name: string, version?: string, options?: LoggerOptions): Logger { - return this.getLoggerProvider().getLogger(name, version); + return this.getLoggerProvider().getLogger(name, version, options); } } diff --git a/experimental/packages/opentelemetry-api-logs/src/platform/browser/globalThis.ts b/experimental/packages/opentelemetry-api-logs/src/platform/browser/globalThis.ts index 693547b7c2..1dece570f3 100644 --- a/experimental/packages/opentelemetry-api-logs/src/platform/browser/globalThis.ts +++ b/experimental/packages/opentelemetry-api-logs/src/platform/browser/globalThis.ts @@ -29,7 +29,7 @@ // eslint-disable-next-line node/no-unsupported-features/es-builtins, no-undef export const _globalThis: typeof globalThis = typeof globalThis === 'object' ? globalThis : - typeof self === 'object' ? self : - typeof window === 'object' ? window : - typeof global === 'object' ? global : + typeof self === 'object' ? self : + typeof window === 'object' ? window : + typeof global === 'object' ? global : {} as typeof globalThis; diff --git a/experimental/packages/opentelemetry-api-logs/src/types/Event.ts b/experimental/packages/opentelemetry-api-logs/src/types/Event.ts index 6ed26dd9e9..f599579010 100644 --- a/experimental/packages/opentelemetry-api-logs/src/types/Event.ts +++ b/experimental/packages/opentelemetry-api-logs/src/types/Event.ts @@ -31,7 +31,7 @@ export abstract class Event implements LogRecord { } } - /** + /** * Sets an attribute to the event. * * Sets a single Attribute with the key and value passed as arguments. diff --git a/experimental/packages/opentelemetry-api-logs/src/types/Logger.ts b/experimental/packages/opentelemetry-api-logs/src/types/Logger.ts index 59a47974d2..fcc3ee779c 100644 --- a/experimental/packages/opentelemetry-api-logs/src/types/Logger.ts +++ b/experimental/packages/opentelemetry-api-logs/src/types/Logger.ts @@ -38,15 +38,15 @@ export interface Logger { /** * Emits a log record * - * @param logRecord + * @param logRecord */ emit(logRecord: LogRecord): void; /** * Emits an event * - * @param name - * @param attributes + * @param name + * @param attributes */ emitEvent(name: string, attributes?: Attributes): void; } diff --git a/experimental/packages/opentelemetry-api-logs/src/types/LoggerOptions.ts b/experimental/packages/opentelemetry-api-logs/src/types/LoggerOptions.ts index 9ca7dd160e..fe485fc02c 100644 --- a/experimental/packages/opentelemetry-api-logs/src/types/LoggerOptions.ts +++ b/experimental/packages/opentelemetry-api-logs/src/types/LoggerOptions.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { Attributes } from "@opentelemetry/api"; +import { Attributes } from '@opentelemetry/api'; export interface LoggerOptions { /** From 995253137643cef8fa9a1e4ac84eda4fd2de778f Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Mon, 1 Aug 2022 15:16:16 -0700 Subject: [PATCH 04/27] added tests --- .../opentelemetry-api-logs/package.json | 4 +- .../opentelemetry-api-logs/src/NoopLogger.ts | 4 +- .../opentelemetry-api-logs/src/api/logs.ts | 5 ++ .../opentelemetry-api-logs/src/index.ts | 2 + .../test/api/api.test.ts | 58 +++++++++++++++++++ .../noop-logger-provider.test.ts | 31 ++++++++++ .../noop-implementations/noop-logger.test.ts | 23 ++++++++ 7 files changed, 123 insertions(+), 4 deletions(-) create mode 100644 experimental/packages/opentelemetry-api-logs/test/api/api.test.ts create mode 100644 experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger-provider.test.ts create mode 100644 experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger.test.ts diff --git a/experimental/packages/opentelemetry-api-logs/package.json b/experimental/packages/opentelemetry-api-logs/package.json index b1726aaa12..358f9bb075 100644 --- a/experimental/packages/opentelemetry-api-logs/package.json +++ b/experimental/packages/opentelemetry-api-logs/package.json @@ -16,7 +16,7 @@ "prepublishOnly": "npm run compile", "compile": "tsc --build tsconfig.all.json", "clean": "tsc --build --clean tsconfig.all.json", - "test": "nyc ts-mocha -p tsconfig.json test/**/*.test.ts", + "test": "nyc ts-mocha -p tsconfig.json test/**/*.test.ts -w --watch-files '**/*.ts'", "test:browser": "nyc 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 ../../../", @@ -39,6 +39,8 @@ }, "homepage": "https://github.com/open-telemetry/opentelemetry-js#readme", "devDependencies": { + "nyc": "^15.1.0", + "ts-mocha": "^10.0.0", "typescript": "4.4.4", "webpack": "4.46.0" }, diff --git a/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts b/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts index f57a3b037d..248a6def79 100644 --- a/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts +++ b/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts @@ -30,9 +30,7 @@ export class NoopLogger implements Logger { return new NonRecordingEvent(name, domain); } - emit(logRecord: LogRecord): void; - emit(event: Event): void; - emit(_event: unknown): void {} + emit(logRecord: LogRecord): void {}; emitEvent(_name: string, _attributes?: Attributes): void {} } diff --git a/experimental/packages/opentelemetry-api-logs/src/api/logs.ts b/experimental/packages/opentelemetry-api-logs/src/api/logs.ts index f41b73d9d0..0f9388648a 100644 --- a/experimental/packages/opentelemetry-api-logs/src/api/logs.ts +++ b/experimental/packages/opentelemetry-api-logs/src/api/logs.ts @@ -72,4 +72,9 @@ export class LogsAPI { public getLogger(name: string, version?: string, options?: LoggerOptions): Logger { return this.getLoggerProvider().getLogger(name, version, options); } + + /** Remove the global logger provider */ + public disable(): void { + delete _global[GLOBAL_LOGS_API_KEY]; + } } diff --git a/experimental/packages/opentelemetry-api-logs/src/index.ts b/experimental/packages/opentelemetry-api-logs/src/index.ts index 8732221d9a..8f9617696d 100644 --- a/experimental/packages/opentelemetry-api-logs/src/index.ts +++ b/experimental/packages/opentelemetry-api-logs/src/index.ts @@ -19,6 +19,8 @@ export * from './types/LoggerProvider'; export * from './types/LogRecord'; export * from './types/Event'; export * from './types/LoggerOptions'; +export * from './NoopLoggerProvider'; +export * from './NoopLogger'; import { LogsAPI } from './api/logs'; export const logs = LogsAPI.getInstance(); diff --git a/experimental/packages/opentelemetry-api-logs/test/api/api.test.ts b/experimental/packages/opentelemetry-api-logs/test/api/api.test.ts new file mode 100644 index 0000000000..a69f3fe6e0 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/test/api/api.test.ts @@ -0,0 +1,58 @@ +/* + * 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 * as assert from 'assert'; +import { Logger, logs, NoopLogger, NoopLoggerProvider } from '../../src'; + +describe('API', () => { + const dummyLogger = new NoopLogger(); + + it('should expose a logger provider via getLoggerProvider', () => { + const provider = logs.getLoggerProvider(); + assert.ok(provider); + assert.strictEqual(typeof provider, 'object'); + }); + + describe('GlobalLoggerProvider', () => { + beforeEach(() => { + logs.disable(); + }); + + it('should use the global logger provider', () => { + logs.setGlobalLoggerProvider(new TestLoggerProvider()); + const logger = logs.getLoggerProvider().getLogger('name'); + assert.deepStrictEqual(logger, dummyLogger); + }); + }); + + describe('getLogger', () => { + beforeEach(() => { + logs.disable(); + }); + + it('should return a logger instance from global provider', () => { + logs.setGlobalLoggerProvider(new TestLoggerProvider()); + const logger = logs.getLogger('myLogger'); + assert.deepStrictEqual(logger, dummyLogger); + }); + }); + + class TestLoggerProvider extends NoopLoggerProvider { + override getLogger(): Logger { + return dummyLogger; + } + } +}); diff --git a/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger-provider.test.ts b/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger-provider.test.ts new file mode 100644 index 0000000000..e696c77b01 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger-provider.test.ts @@ -0,0 +1,31 @@ +/* + * 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 * as assert from 'assert'; +import { NoopLogger } from '../../src/NoopLogger'; +import { NoopLoggerProvider } from '../../src/NoopLoggerProvider'; + +describe('NoopLoggerProvider', () => { + it('should not crash', () => { + const loggerProvider = new NoopLoggerProvider(); + + assert.ok(loggerProvider.getLogger('logger-name') instanceof NoopLogger); + assert.ok(loggerProvider.getLogger('logger-name', 'v1') instanceof NoopLogger); + assert.ok(loggerProvider.getLogger('logger-name', 'v1', { + schemaUrl: 'https://opentelemetry.io/schemas/1.7.0' + }) instanceof NoopLogger); + }); +}); diff --git a/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger.test.ts b/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger.test.ts new file mode 100644 index 0000000000..096164eab2 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger.test.ts @@ -0,0 +1,23 @@ +/* + * 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 * as assert from 'assert'; +import { NoopLogger } from '../../src/NoopLogger'; +import { NoopLoggerProvider } from '../../src/NoopLoggerProvider'; + +describe('NoopLogger', () => { + +}); From b4366e778b5ea96dfc758bc39e44c641697be3b4 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Mon, 1 Aug 2022 18:17:38 -0700 Subject: [PATCH 05/27] more tests --- .../opentelemetry-api-logs/src/NoopLogger.ts | 2 +- .../test/api/api.test.ts | 2 +- .../test/internal/global.test.ts | 76 +++++++++++++++++++ .../test/noop-implementations/noop-event.ts | 33 ++++++++ .../noop-log-record.test.ts | 33 ++++++++ .../noop-implementations/noop-logger.test.ts | 28 +++++++ 6 files changed, 172 insertions(+), 2 deletions(-) create mode 100644 experimental/packages/opentelemetry-api-logs/test/internal/global.test.ts create mode 100644 experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-event.ts create mode 100644 experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-log-record.test.ts diff --git a/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts b/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts index 248a6def79..241bb9b3a3 100644 --- a/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts +++ b/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts @@ -30,7 +30,7 @@ export class NoopLogger implements Logger { return new NonRecordingEvent(name, domain); } - emit(logRecord: LogRecord): void {}; + emit(_logRecord: LogRecord): void {} emitEvent(_name: string, _attributes?: Attributes): void {} } diff --git a/experimental/packages/opentelemetry-api-logs/test/api/api.test.ts b/experimental/packages/opentelemetry-api-logs/test/api/api.test.ts index a69f3fe6e0..8d927e73ec 100644 --- a/experimental/packages/opentelemetry-api-logs/test/api/api.test.ts +++ b/experimental/packages/opentelemetry-api-logs/test/api/api.test.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import * as assert from 'assert'; +import * as assert from 'assert'; import { Logger, logs, NoopLogger, NoopLoggerProvider } from '../../src'; describe('API', () => { diff --git a/experimental/packages/opentelemetry-api-logs/test/internal/global.test.ts b/experimental/packages/opentelemetry-api-logs/test/internal/global.test.ts new file mode 100644 index 0000000000..313484399d --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/test/internal/global.test.ts @@ -0,0 +1,76 @@ +/* + * 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 * as assert from 'assert'; +import { _global, GLOBAL_LOGS_API_KEY } from '../../src/internal/global-utils'; +import { NoopLoggerProvider } from '../../src'; + +const api1 = require('../../src') as typeof import('../../src'); + +// clear cache and load a second instance of the api +for (const key of Object.keys(require.cache)) { + delete require.cache[key]; +} +const api2 = require('../../src') as typeof import('../../src'); + +describe('Global Utils', () => { + // prove they are separate instances + assert.notStrictEqual(api1, api2); + // that return separate noop instances to start + assert.notStrictEqual( + api1.logs.getLoggerProvider(), + api2.logs.getLoggerProvider() + ); + + beforeEach(() => { + api1.logs.disable(); + api2.logs.disable(); + }); + + it('should change the global meter provider', () => { + const original = api1.logs.getLoggerProvider(); + const newLoggerProvider = new NoopLoggerProvider(); + api1.logs.setGlobalLoggerProvider(newLoggerProvider); + assert.notStrictEqual(api1.logs.getLoggerProvider(), original); + assert.strictEqual(api1.logs.getLoggerProvider(), newLoggerProvider); + }); + + it('should load an instance from one which was set in the other', () => { + api1.logs.setGlobalLoggerProvider(new NoopLoggerProvider()); + assert.strictEqual( + api1.logs.getLoggerProvider(), + api2.logs.getLoggerProvider() + ); + }); + + it('should disable both if one is disabled', () => { + const original = api1.logs.getLoggerProvider(); + + api1.logs.setGlobalLoggerProvider(new NoopLoggerProvider()); + + assert.notStrictEqual(original, api1.logs.getLoggerProvider()); + api2.logs.disable(); + assert.strictEqual(original, api1.logs.getLoggerProvider()); + }); + + it('should return the module NoOp implementation if the version is a mismatch', () => { + const original = api1.logs.getLoggerProvider(); + api1.logs.setGlobalLoggerProvider(new NoopLoggerProvider()); + const afterSet = _global[GLOBAL_LOGS_API_KEY]!(-1); + + assert.strictEqual(original, afterSet); + }); +}); diff --git a/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-event.ts b/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-event.ts new file mode 100644 index 0000000000..5b7499e57f --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-event.ts @@ -0,0 +1,33 @@ +/* + * 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 { Attributes, AttributeValue } from '@opentelemetry/api'; +import { NonRecordingEvent } from '../../src/NonRecordingEvent'; + +class TestAttributes implements Attributes { + [attributeKey: string]: AttributeValue | undefined; +} + +describe('NonRecordingEvent', () => { + it('setting attributes should not crash', () => { + const event = new NonRecordingEvent('test-name', 'test-domain'); + event.setAttribute('test-key', 'test-value'); + + const attributes = new TestAttributes(); + attributes['test-attribute'] = 'test-value'; + event.setAttributes(attributes); + }); +}); diff --git a/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-log-record.test.ts b/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-log-record.test.ts new file mode 100644 index 0000000000..518e4acbfd --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-log-record.test.ts @@ -0,0 +1,33 @@ +/* + * 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 { Attributes, AttributeValue } from '@opentelemetry/api'; +import { NonRecordingLogRecord } from '../../src/NonRecordingLogRecord'; + +class TestAttributes implements Attributes { + [attributeKey: string]: AttributeValue | undefined; +} + +describe('NonRecordingLogRecord', () => { + it('setting attributes should not crash', () => { + const logRecord = new NonRecordingLogRecord(); + logRecord.setAttribute('test-key', 'test-value'); + + const attributes = new TestAttributes(); + attributes['test-attribute'] = 'test-value'; + logRecord.setAttributes(attributes); + }); +}); diff --git a/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger.test.ts b/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger.test.ts index 096164eab2..ea709224a2 100644 --- a/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger.test.ts +++ b/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger.test.ts @@ -15,9 +15,37 @@ */ import * as assert from 'assert'; +import { NonRecordingEvent } from '../../src/NonRecordingEvent'; +import { NonRecordingLogRecord } from '../../src/NonRecordingLogRecord'; import { NoopLogger } from '../../src/NoopLogger'; import { NoopLoggerProvider } from '../../src/NoopLoggerProvider'; describe('NoopLogger', () => { + it('constructor should not crash', () => { + const logger = new NoopLoggerProvider().getLogger('test-noop'); + assert(logger instanceof NoopLogger); + }); + it('calling emit should not crash', () => { + const logger = new NoopLoggerProvider().getLogger('test-noop'); + const logRecord = new NonRecordingLogRecord(); + logger.emit(logRecord); + }); + + it('calling emitEvent should not crash', () => { + const logger = new NoopLoggerProvider().getLogger('test-noop'); + logger.emitEvent('test-event'); + }); + + it('calling createLogRecord should not crash', () => { + const logger = new NoopLoggerProvider().getLogger('test-noop'); + const logRecord = logger.createLogRecord(); + assert(logRecord instanceof NonRecordingLogRecord); + }); + + it('calling createEvent should not crash', () => { + const logger = new NoopLoggerProvider().getLogger('test-noop'); + const event = logger.createEvent('test-event', 'test-domain'); + assert(event instanceof NonRecordingEvent); + }); }); From 9122c051824a74ea780510e583a513734163c171 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Wed, 3 Aug 2022 14:52:44 -0700 Subject: [PATCH 06/27] made package.json consistent with other packages --- .../opentelemetry-api-logs/package.json | 45 ++++++++++++++----- 1 file changed, 34 insertions(+), 11 deletions(-) diff --git a/experimental/packages/opentelemetry-api-logs/package.json b/experimental/packages/opentelemetry-api-logs/package.json index 358f9bb075..8a3e087176 100644 --- a/experimental/packages/opentelemetry-api-logs/package.json +++ b/experimental/packages/opentelemetry-api-logs/package.json @@ -12,11 +12,12 @@ "./build/esnext/platform/index.js": "./build/esnext/platform/browser/index.js", "./build/src/platform/index.js": "./build/src/platform/browser/index.js" }, + "repository": "open-telemetry/opentelemetry-js", "scripts": { "prepublishOnly": "npm run compile", "compile": "tsc --build tsconfig.all.json", "clean": "tsc --build --clean tsconfig.all.json", - "test": "nyc ts-mocha -p tsconfig.json test/**/*.test.ts -w --watch-files '**/*.ts'", + "test": "nyc ts-mocha -p tsconfig.json test/**/*.test.ts", "test:browser": "nyc 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 ../../../", @@ -28,23 +29,45 @@ "precompile": "lerna run version --scope $(npm pkg get name) --include-dependencies", "prewatch": "node ../../../scripts/version-update.js" }, - "repository": { - "type": "git", - "url": "git+https://github.com/open-telemetry/opentelemetry-js.git" - }, + "keywords": [ + "opentelemetry", + "nodejs", + "browser", + "profiling", + "metrics", + "stats", + "monitoring" + ], "author": "OpenTelemetry Authors", "license": "Apache-2.0", - "bugs": { - "url": "https://github.com/open-telemetry/opentelemetry-js/issues" + "engines": { + "node": ">=14" + }, + "files": [ + "build/esm/**/*.js", + "build/esm/**/*.js.map", + "build/esm/**/*.d.ts", + "build/esnext/**/*.js", + "build/esnext/**/*.js.map", + "build/esnext/**/*.d.ts", + "build/src/**/*.js", + "build/src/**/*.js.map", + "build/src/**/*.d.ts", + "doc", + "LICENSE", + "README.md" + ], + "publishConfig": { + "access": "public" + }, + "dependencies": { + "@opentelemetry/api": "^1.1.0" }, - "homepage": "https://github.com/open-telemetry/opentelemetry-js#readme", "devDependencies": { "nyc": "^15.1.0", "ts-mocha": "^10.0.0", "typescript": "4.4.4", "webpack": "4.46.0" }, - "dependencies": { - "@opentelemetry/api": "^1.1.0" - } + "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-api-logs" } From c4d2c01f9692b02b988e5e26862a9cb52660286f Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Wed, 3 Aug 2022 15:30:54 -0700 Subject: [PATCH 07/27] getting browser tests to work --- .../opentelemetry-api-logs/karma.conf.js | 24 +++++++++++++++++++ .../opentelemetry-api-logs/package.json | 17 +++++++++++-- .../src/platform/index.ts | 2 +- .../test/index-webpack.ts | 20 ++++++++++++++++ 4 files changed, 60 insertions(+), 3 deletions(-) create mode 100644 experimental/packages/opentelemetry-api-logs/karma.conf.js create mode 100644 experimental/packages/opentelemetry-api-logs/test/index-webpack.ts diff --git a/experimental/packages/opentelemetry-api-logs/karma.conf.js b/experimental/packages/opentelemetry-api-logs/karma.conf.js new file mode 100644 index 0000000000..6174839d65 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/karma.conf.js @@ -0,0 +1,24 @@ +/*! + * 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 + * + * http://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. + */ + +const karmaWebpackConfig = require('../../../karma.webpack'); +const karmaBaseConfig = require('../../../karma.base'); + +module.exports = (config) => { + config.set(Object.assign({}, karmaBaseConfig, { + webpack: karmaWebpackConfig + })) +}; diff --git a/experimental/packages/opentelemetry-api-logs/package.json b/experimental/packages/opentelemetry-api-logs/package.json index 8a3e087176..060b6968d3 100644 --- a/experimental/packages/opentelemetry-api-logs/package.json +++ b/experimental/packages/opentelemetry-api-logs/package.json @@ -64,8 +64,21 @@ "@opentelemetry/api": "^1.1.0" }, "devDependencies": { - "nyc": "^15.1.0", - "ts-mocha": "^10.0.0", + "@types/mocha": "8.2.3", + "@types/node": "14.17.33", + "@types/webpack-env": "1.16.3", + "codecov": "3.8.3", + "istanbul-instrumenter-loader": "3.0.1", + "karma": "6.3.16", + "karma-chrome-launcher": "3.1.0", + "karma-coverage-istanbul-reporter": "3.0.3", + "karma-mocha": "2.0.1", + "karma-spec-reporter": "0.0.32", + "karma-webpack": "4.0.2", + "mocha": "7.2.0", + "nyc": "15.1.0", + "ts-loader": "8.3.0", + "ts-mocha": "9.0.2", "typescript": "4.4.4", "webpack": "4.46.0" }, diff --git a/experimental/packages/opentelemetry-api-logs/src/platform/index.ts b/experimental/packages/opentelemetry-api-logs/src/platform/index.ts index 3f9ab45f9f..cdaf8858ce 100644 --- a/experimental/packages/opentelemetry-api-logs/src/platform/index.ts +++ b/experimental/packages/opentelemetry-api-logs/src/platform/index.ts @@ -14,4 +14,4 @@ * limitations under the License. */ -export * from './browser'; +export * from './node'; diff --git a/experimental/packages/opentelemetry-api-logs/test/index-webpack.ts b/experimental/packages/opentelemetry-api-logs/test/index-webpack.ts new file mode 100644 index 0000000000..061a48ccfa --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/test/index-webpack.ts @@ -0,0 +1,20 @@ +/* + * 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. + */ +const testsContext = require.context('.', true, /test$/); +testsContext.keys().forEach(testsContext); + +const srcContext = require.context('.', true, /src$/); +srcContext.keys().forEach(srcContext); From 9ae472b1b3487d2d72c15b4a9e93e0253fc64a00 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Wed, 3 Aug 2022 15:43:27 -0700 Subject: [PATCH 08/27] added readme --- .../packages/opentelemetry-api-logs/README.md | 57 +++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 experimental/packages/opentelemetry-api-logs/README.md diff --git a/experimental/packages/opentelemetry-api-logs/README.md b/experimental/packages/opentelemetry-api-logs/README.md new file mode 100644 index 0000000000..bc9c9745e3 --- /dev/null +++ b/experimental/packages/opentelemetry-api-logs/README.md @@ -0,0 +1,57 @@ +# OpenTelemetry API for JavaScript + +[![NPM Published Version][npm-img]][npm-url] +[![Apache License][license-image]][license-image] + +This package provides everything needed to interact with the unstable OpenTelemetry Logs API, including all TypeScript interfaces, enums, and no-op implementations. It is intended for use both on the server and in the browser. + +## Beta Software - Use at your own risk + +The logs API is considered alpha software and there is no guarantee of stability or long-term support. When the API is stabilized, it will be made available and supported long-term in the `@opentelemetry/api` package and this package will be deprecated. + +## Quick Start + +Purposefully left blank until SDK is available. + +## Version Compatibility + +Because the npm installer and node module resolution algorithm could potentially allow two or more copies of any given package to exist within the same `node_modules` structure, the OpenTelemetry API takes advantage of a variable on the `global` object to store the global API. When an API method in the API package is called, it checks if this `global` API exists and proxies calls to it if and only if it is a compatible API version. This means if a package has a dependency on an OpenTelemetry API version which is not compatible with the API used by the end user, the package will receive a no-op implementation of the API. + +## Advanced Use + +### API Methods + +If you are writing an instrumentation library, or prefer to call the API methods directly rather than using the `register` method on the Tracer/Meter/Logger Provider, OpenTelemetry provides direct access to the underlying API methods through the `@opentelemetry/api-logs` package. API entry points are defined as global singleton objects `trace`, `metrics`, `logs`, `propagation`, and `context` which contain methods used to initialize SDK implementations and acquire resources from the API. + +- [Metrics API Documentation][metrics-api-docs] + +```javascript +const api = require("@opentelemetry/api-logs"); + +/* Initialize LoggerProvider */ +api.logs.setGlobalLoggerProvider(loggerProvider); +/* returns loggerProvider (no-op if a working provider has not been initialized) */ +api.logs.getLoggerProvider(); +/* returns a meter from the registered global meter provider (no-op if a working provider has not been initialized) */ +api.logs.getLogger(name, version); +``` + +## Useful links + +- For more information on OpenTelemetry, visit: +- For more about OpenTelemetry JavaScript: +- For help or feedback on this project, join us in [GitHub Discussions][discussions-url] + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions +[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/main/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[npm-url]: https://www.npmjs.com/package/@opentelemetry/api-metrics +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fapi-metrics.svg + +[metrics-api-docs]: https://open-telemetry.github.io/opentelemetry-js/modules/_opentelemetry_api_metrics.html + +[other-tracing-backends]: https://github.com/open-telemetry/opentelemetry-js#trace-exporters From 9d15df96c96378c13bc2cb03269204e5263a5704 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Wed, 3 Aug 2022 16:04:07 -0700 Subject: [PATCH 09/27] updated CHANGELOG --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 48de348db0..f8e4ea287f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,7 @@ All notable changes to this project will be documented in this file. * feat(sdk-trace-base): move Sampler declaration into sdk-trace-base [#3088](https://github.com/open-telemetry/opentelemetry-js/pull/3088) @legendecas * fix(grpc-instrumentation): added grpc attributes in instrumentation [#3127](https://github.com/open-telemetry/opentelemetry-js/pull/3127) @andrewzenkov * feat: support latest `@opentelemetry/api` [#3177](https://github.com/open-telemetry/opentelemetry-js/pull/3177) @dyladan +* feat: add Logs API @mkuba ### :bug: (Bug Fix) From 278e07c9363d12f13c7043fa39b8b2f3abfb244f Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Wed, 3 Aug 2022 16:39:16 -0700 Subject: [PATCH 10/27] renamed test file --- .../noop-implementations/{noop-event.ts => noop-event.test.ts} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename experimental/packages/opentelemetry-api-logs/test/noop-implementations/{noop-event.ts => noop-event.test.ts} (100%) diff --git a/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-event.ts b/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-event.test.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-event.ts rename to experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-event.test.ts From 8c6ed058fed38b6232cd1f12b689184bf56acc47 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Fri, 5 Aug 2022 16:32:22 -0700 Subject: [PATCH 11/27] removed create* methods from API, updated emit methods --- .../src/NonRecordingEvent.ts | 28 -------- .../src/NonRecordingLogRecord.ts | 28 -------- .../opentelemetry-api-logs/src/NoopLogger.ts | 16 +---- .../opentelemetry-api-logs/src/types/Event.ts | 42 ++++-------- .../src/types/LogRecord.ts | 66 +++++++++++-------- .../src/types/Logger.ts | 28 ++------ .../noop-implementations/noop-event.test.ts | 33 ---------- .../noop-log-record.test.ts | 33 ---------- .../noop-implementations/noop-logger.test.ts | 21 +----- 9 files changed, 63 insertions(+), 232 deletions(-) delete mode 100644 experimental/packages/opentelemetry-api-logs/src/NonRecordingEvent.ts delete mode 100644 experimental/packages/opentelemetry-api-logs/src/NonRecordingLogRecord.ts delete mode 100644 experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-event.test.ts delete mode 100644 experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-log-record.test.ts diff --git a/experimental/packages/opentelemetry-api-logs/src/NonRecordingEvent.ts b/experimental/packages/opentelemetry-api-logs/src/NonRecordingEvent.ts deleted file mode 100644 index 7cc7ed51c1..0000000000 --- a/experimental/packages/opentelemetry-api-logs/src/NonRecordingEvent.ts +++ /dev/null @@ -1,28 +0,0 @@ -/* - * 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 { AttributeValue, Attributes } from '@opentelemetry/api'; -import { Event } from './types/Event'; - -export class NonRecordingEvent extends Event { - setAttribute(_key: string, _value?: AttributeValue): this { - return this; - } - - setAttributes(_attributes: Attributes): this { - return this; - } -} diff --git a/experimental/packages/opentelemetry-api-logs/src/NonRecordingLogRecord.ts b/experimental/packages/opentelemetry-api-logs/src/NonRecordingLogRecord.ts deleted file mode 100644 index 5c5ef551f7..0000000000 --- a/experimental/packages/opentelemetry-api-logs/src/NonRecordingLogRecord.ts +++ /dev/null @@ -1,28 +0,0 @@ -/* - * 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 { AttributeValue, Attributes } from '@opentelemetry/api'; -import { LogRecord } from './types/LogRecord'; - -export class NonRecordingLogRecord implements LogRecord { - setAttribute(_key: string, _value?: AttributeValue | undefined): this { - return this; - } - - setAttributes(_attributes: Attributes): this { - return this; - } -} diff --git a/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts b/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts index 241bb9b3a3..206b9b5d2a 100644 --- a/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts +++ b/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts @@ -16,21 +16,9 @@ import { Logger } from './types/Logger'; import { Event } from './types/Event'; -import { Attributes } from '@opentelemetry/api'; import { LogRecord } from './types/LogRecord'; -import { NonRecordingLogRecord } from './NonRecordingLogRecord'; -import { NonRecordingEvent } from './NonRecordingEvent'; export class NoopLogger implements Logger { - createLogRecord(): LogRecord { - return new NonRecordingLogRecord(); - } - - createEvent(name: string, domain?: string): Event { - return new NonRecordingEvent(name, domain); - } - - emit(_logRecord: LogRecord): void {} - - emitEvent(_name: string, _attributes?: Attributes): void {} + emitLogRecord(_logRecord: LogRecord): void {} + emitEvent(_event: Event): void {} } diff --git a/experimental/packages/opentelemetry-api-logs/src/types/Event.ts b/experimental/packages/opentelemetry-api-logs/src/types/Event.ts index f599579010..8a26d5dde3 100644 --- a/experimental/packages/opentelemetry-api-logs/src/types/Event.ts +++ b/experimental/packages/opentelemetry-api-logs/src/types/Event.ts @@ -14,40 +14,26 @@ * limitations under the License. */ -import { Attributes, AttributeValue } from '@opentelemetry/api'; -import { LogRecord } from './LogRecord'; +import { Attributes } from '@opentelemetry/api'; -export abstract class Event implements LogRecord { - name: string; - domain?: string; - - constructor(name: string, domain?: string) { - this.name = name; - this.setAttribute('event.name', name); +export interface Event { + /** + * The time when the event occurred as UNIX Epoch time in nanoseconds. + */ + timestamp?: number; - if (domain) { - this.domain = domain; - this.setAttribute('event.domain', name); - } - } + /** + * The name of the event. + */ + name: string; /** - * Sets an attribute to the event. - * - * Sets a single Attribute with the key and value passed as arguments. - * - * @param key the key for this attribute. - * @param value the value for this attribute. Setting a value null or - * undefined is invalid and will result in undefined behavior. + * The domain the event belongs to. */ - abstract setAttribute(key: string, value?: AttributeValue): this; + domain?: string; /** - * Sets attributes to the event. - * - * @param attributes the attributes that will be added. - * null or undefined attribute values - * are invalid and will result in undefined behavior. + * Additional attributes that describe the event. */ - abstract setAttributes(attributes: Attributes): this; + attributes?: Attributes; } diff --git a/experimental/packages/opentelemetry-api-logs/src/types/LogRecord.ts b/experimental/packages/opentelemetry-api-logs/src/types/LogRecord.ts index 5bcd959055..132900c54a 100644 --- a/experimental/packages/opentelemetry-api-logs/src/types/LogRecord.ts +++ b/experimental/packages/opentelemetry-api-logs/src/types/LogRecord.ts @@ -14,34 +14,46 @@ * limitations under the License. */ -import { Attributes, AttributeValue } from '@opentelemetry/api'; +import { Attributes } from '@opentelemetry/api'; export interface LogRecord { /** - * Sets an attribute to the log record. - * - * Sets a single Attribute with the key and value passed as arguments. - * - * @param key the key for this attribute. - * @param value the value for this attribute. Setting a value null or - * undefined is invalid and will result in undefined behavior. - */ - setAttribute(key: string, value?: AttributeValue): this; - - /** - * Sets attributes to the span. - * - * @param attributes the attributes that will be added. - * null or undefined attribute values - * are invalid and will result in undefined behavior. - */ - - /** - * Sets attributes to the event. - * - * @param attributes the attributes that will be added. - * null or undefined attribute values - * are invalid and will result in undefined behavior. - */ - setAttributes(attributes: Attributes): this; + * The time when the log record occurred as UNIX Epoch time in nanoseconds. + */ + timestamp?: number; + + /** + * Numerical value of the severity. + */ + severityNumber?: number; + + /** + * The severity text. + */ + severityText?: string; + + /** + * A value containing the body of the log record. + */ + body?: string; + + /** + * Attributes that define the log record. + */ + attributes?: Attributes; + + /** + * 8 least significant bits are the trace flags as defined in W3C Trace Context specification. + */ + traceFlags?: number; + + /** + * A unique identifier for a trace. + */ + traceId?: string; + + /** + * A unique identifier for a span within a trace. + */ + spanId?: string; } diff --git a/experimental/packages/opentelemetry-api-logs/src/types/Logger.ts b/experimental/packages/opentelemetry-api-logs/src/types/Logger.ts index fcc3ee779c..b88a2b0611 100644 --- a/experimental/packages/opentelemetry-api-logs/src/types/Logger.ts +++ b/experimental/packages/opentelemetry-api-logs/src/types/Logger.ts @@ -14,39 +14,21 @@ * limitations under the License. */ -import { Attributes } from '@opentelemetry/api'; import { LogRecord } from './LogRecord'; import { Event } from './Event'; export interface Logger { /** - * Creates a new LogRecord. - * - * @returns LogRecord - */ - createLogRecord(): LogRecord; - - /** - * Creates a new Event. - * - * @param name the name of the event - * @param [domain] the domain of the event - * @returns Event The newly created event - */ - createEvent(name: string, domain?: string): Event; - - /** - * Emits a log record + * Emit a log record. This method should only be used by log appenders. * * @param logRecord */ - emit(logRecord: LogRecord): void; + emitLogRecord(logRecord: LogRecord): void; /** - * Emits an event + * Emit an event. This method should only be used by instrumentations emitting events. * - * @param name - * @param attributes + * @param event */ - emitEvent(name: string, attributes?: Attributes): void; + emitEvent(event: Event): void; } diff --git a/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-event.test.ts b/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-event.test.ts deleted file mode 100644 index 5b7499e57f..0000000000 --- a/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-event.test.ts +++ /dev/null @@ -1,33 +0,0 @@ -/* - * 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 { Attributes, AttributeValue } from '@opentelemetry/api'; -import { NonRecordingEvent } from '../../src/NonRecordingEvent'; - -class TestAttributes implements Attributes { - [attributeKey: string]: AttributeValue | undefined; -} - -describe('NonRecordingEvent', () => { - it('setting attributes should not crash', () => { - const event = new NonRecordingEvent('test-name', 'test-domain'); - event.setAttribute('test-key', 'test-value'); - - const attributes = new TestAttributes(); - attributes['test-attribute'] = 'test-value'; - event.setAttributes(attributes); - }); -}); diff --git a/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-log-record.test.ts b/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-log-record.test.ts deleted file mode 100644 index 518e4acbfd..0000000000 --- a/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-log-record.test.ts +++ /dev/null @@ -1,33 +0,0 @@ -/* - * 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 { Attributes, AttributeValue } from '@opentelemetry/api'; -import { NonRecordingLogRecord } from '../../src/NonRecordingLogRecord'; - -class TestAttributes implements Attributes { - [attributeKey: string]: AttributeValue | undefined; -} - -describe('NonRecordingLogRecord', () => { - it('setting attributes should not crash', () => { - const logRecord = new NonRecordingLogRecord(); - logRecord.setAttribute('test-key', 'test-value'); - - const attributes = new TestAttributes(); - attributes['test-attribute'] = 'test-value'; - logRecord.setAttributes(attributes); - }); -}); diff --git a/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger.test.ts b/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger.test.ts index ea709224a2..6360e7b7dd 100644 --- a/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger.test.ts +++ b/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger.test.ts @@ -15,8 +15,6 @@ */ import * as assert from 'assert'; -import { NonRecordingEvent } from '../../src/NonRecordingEvent'; -import { NonRecordingLogRecord } from '../../src/NonRecordingLogRecord'; import { NoopLogger } from '../../src/NoopLogger'; import { NoopLoggerProvider } from '../../src/NoopLoggerProvider'; @@ -26,26 +24,13 @@ describe('NoopLogger', () => { assert(logger instanceof NoopLogger); }); - it('calling emit should not crash', () => { - const logger = new NoopLoggerProvider().getLogger('test-noop'); - const logRecord = new NonRecordingLogRecord(); - logger.emit(logRecord); - }); - it('calling emitEvent should not crash', () => { const logger = new NoopLoggerProvider().getLogger('test-noop'); - logger.emitEvent('test-event'); - }); - - it('calling createLogRecord should not crash', () => { - const logger = new NoopLoggerProvider().getLogger('test-noop'); - const logRecord = logger.createLogRecord(); - assert(logRecord instanceof NonRecordingLogRecord); + logger.emitEvent({ name: 'event-name', domain: 'event-domain' }); }); - it('calling createEvent should not crash', () => { + it('calling emitLogRecord should not crash', () => { const logger = new NoopLoggerProvider().getLogger('test-noop'); - const event = logger.createEvent('test-event', 'test-domain'); - assert(event instanceof NonRecordingEvent); + logger.emitLogRecord({ severityNumber: 1, body: 'log body' }); }); }); From 420c59c58a203ab594693d60193769b1ec738f8c Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Fri, 5 Aug 2022 16:52:39 -0700 Subject: [PATCH 12/27] updated README, removed export of Noop classes --- experimental/packages/opentelemetry-api-logs/README.md | 10 ++++++++-- .../packages/opentelemetry-api-logs/package.json | 5 +++-- .../packages/opentelemetry-api-logs/src/index.ts | 2 -- .../opentelemetry-api-logs/test/api/api.test.ts | 4 +++- .../test/internal/global.test.ts | 2 +- .../opentelemetry-api-metrics/tsconfig.docs.json | 2 +- 6 files changed, 16 insertions(+), 9 deletions(-) diff --git a/experimental/packages/opentelemetry-api-logs/README.md b/experimental/packages/opentelemetry-api-logs/README.md index bc9c9745e3..145877bd83 100644 --- a/experimental/packages/opentelemetry-api-logs/README.md +++ b/experimental/packages/opentelemetry-api-logs/README.md @@ -23,7 +23,7 @@ Because the npm installer and node module resolution algorithm could potentially If you are writing an instrumentation library, or prefer to call the API methods directly rather than using the `register` method on the Tracer/Meter/Logger Provider, OpenTelemetry provides direct access to the underlying API methods through the `@opentelemetry/api-logs` package. API entry points are defined as global singleton objects `trace`, `metrics`, `logs`, `propagation`, and `context` which contain methods used to initialize SDK implementations and acquire resources from the API. -- [Metrics API Documentation][metrics-api-docs] +- [Logs API Documentation][logs-api-docs] ```javascript const api = require("@opentelemetry/api-logs"); @@ -33,7 +33,13 @@ api.logs.setGlobalLoggerProvider(loggerProvider); /* returns loggerProvider (no-op if a working provider has not been initialized) */ api.logs.getLoggerProvider(); /* returns a meter from the registered global meter provider (no-op if a working provider has not been initialized) */ -api.logs.getLogger(name, version); +const logger = api.logs.getLogger(name, version); + +// logging an event in an instrumentation library +logger.emitEvent({ name: 'event-name', domain: 'event-domain' }); + +// logging an event in a log appender +logger.emitLogRecord({ severityNumber: 1, body: 'log data' }); ``` ## Useful links diff --git a/experimental/packages/opentelemetry-api-logs/package.json b/experimental/packages/opentelemetry-api-logs/package.json index 060b6968d3..5ec798e919 100644 --- a/experimental/packages/opentelemetry-api-logs/package.json +++ b/experimental/packages/opentelemetry-api-logs/package.json @@ -1,6 +1,6 @@ { "name": "@opentelemetry/api-logs", - "version": "0.0.1", + "version": "0.31.0", "description": "Public logs API for OpenTelemetry", "main": "build/src/index.js", "module": "build/esm/index.js", @@ -34,7 +34,8 @@ "nodejs", "browser", "profiling", - "metrics", + "logs", + "events", "stats", "monitoring" ], diff --git a/experimental/packages/opentelemetry-api-logs/src/index.ts b/experimental/packages/opentelemetry-api-logs/src/index.ts index 8f9617696d..8732221d9a 100644 --- a/experimental/packages/opentelemetry-api-logs/src/index.ts +++ b/experimental/packages/opentelemetry-api-logs/src/index.ts @@ -19,8 +19,6 @@ export * from './types/LoggerProvider'; export * from './types/LogRecord'; export * from './types/Event'; export * from './types/LoggerOptions'; -export * from './NoopLoggerProvider'; -export * from './NoopLogger'; import { LogsAPI } from './api/logs'; export const logs = LogsAPI.getInstance(); diff --git a/experimental/packages/opentelemetry-api-logs/test/api/api.test.ts b/experimental/packages/opentelemetry-api-logs/test/api/api.test.ts index 8d927e73ec..1006d3a694 100644 --- a/experimental/packages/opentelemetry-api-logs/test/api/api.test.ts +++ b/experimental/packages/opentelemetry-api-logs/test/api/api.test.ts @@ -15,7 +15,9 @@ */ import * as assert from 'assert'; -import { Logger, logs, NoopLogger, NoopLoggerProvider } from '../../src'; +import { Logger, logs } from '../../src'; +import { NoopLogger } from '../../src/NoopLogger'; +import { NoopLoggerProvider } from '../../src/NoopLoggerProvider'; describe('API', () => { const dummyLogger = new NoopLogger(); diff --git a/experimental/packages/opentelemetry-api-logs/test/internal/global.test.ts b/experimental/packages/opentelemetry-api-logs/test/internal/global.test.ts index 313484399d..a2f9f96ce8 100644 --- a/experimental/packages/opentelemetry-api-logs/test/internal/global.test.ts +++ b/experimental/packages/opentelemetry-api-logs/test/internal/global.test.ts @@ -16,7 +16,7 @@ import * as assert from 'assert'; import { _global, GLOBAL_LOGS_API_KEY } from '../../src/internal/global-utils'; -import { NoopLoggerProvider } from '../../src'; +import { NoopLoggerProvider } from '../../src/NoopLoggerProvider'; const api1 = require('../../src') as typeof import('../../src'); diff --git a/experimental/packages/opentelemetry-api-metrics/tsconfig.docs.json b/experimental/packages/opentelemetry-api-metrics/tsconfig.docs.json index 627fa3ff3e..18c131e2b9 100644 --- a/experimental/packages/opentelemetry-api-metrics/tsconfig.docs.json +++ b/experimental/packages/opentelemetry-api-metrics/tsconfig.docs.json @@ -7,7 +7,7 @@ "src/**/*.ts" ], "typedocOptions": { - "name": "OpenTelemetry API for JavaScript", + "name": "OpenTelemetry Logs API for JavaScript", "out": "docs/out", "mode": "file", "hideGenerator": true From 6fc640316994fe5d1ac2f38683a3fd3ba9b417de Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Fri, 5 Aug 2022 16:53:48 -0700 Subject: [PATCH 13/27] renamed folder to api-logs --- .../packages/{opentelemetry-api-logs => api-logs}/.eslintignore | 0 .../packages/{opentelemetry-api-logs => api-logs}/.eslintrc.js | 0 .../packages/{opentelemetry-api-logs => api-logs}/LICENSE | 0 .../packages/{opentelemetry-api-logs => api-logs}/README.md | 0 .../packages/{opentelemetry-api-logs => api-logs}/karma.conf.js | 0 .../packages/{opentelemetry-api-logs => api-logs}/package.json | 0 .../{opentelemetry-api-logs => api-logs}/src/NoopLogger.ts | 0 .../src/NoopLoggerProvider.ts | 0 .../packages/{opentelemetry-api-logs => api-logs}/src/api/logs.ts | 0 .../packages/{opentelemetry-api-logs => api-logs}/src/index.ts | 0 .../src/internal/global-utils.ts | 0 .../src/platform/browser/globalThis.ts | 0 .../src/platform/browser/index.ts | 0 .../{opentelemetry-api-logs => api-logs}/src/platform/index.ts | 0 .../src/platform/node/globalThis.ts | 0 .../src/platform/node/index.ts | 0 .../{opentelemetry-api-logs => api-logs}/src/types/Event.ts | 0 .../{opentelemetry-api-logs => api-logs}/src/types/LogRecord.ts | 0 .../{opentelemetry-api-logs => api-logs}/src/types/Logger.ts | 0 .../src/types/LoggerOptions.ts | 0 .../src/types/LoggerProvider.ts | 0 .../{opentelemetry-api-logs => api-logs}/test/api/api.test.ts | 0 .../{opentelemetry-api-logs => api-logs}/test/index-webpack.ts | 0 .../test/internal/global.test.ts | 0 .../test/noop-implementations/noop-logger-provider.test.ts | 0 .../test/noop-implementations/noop-logger.test.ts | 0 .../{opentelemetry-api-logs => api-logs}/tsconfig.all.json | 0 .../{opentelemetry-api-logs => api-logs}/tsconfig.docs.json | 0 .../{opentelemetry-api-logs => api-logs}/tsconfig.esm.json | 0 .../{opentelemetry-api-logs => api-logs}/tsconfig.esnext.json | 0 .../packages/{opentelemetry-api-logs => api-logs}/tsconfig.json | 0 31 files changed, 0 insertions(+), 0 deletions(-) rename experimental/packages/{opentelemetry-api-logs => api-logs}/.eslintignore (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/.eslintrc.js (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/LICENSE (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/README.md (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/karma.conf.js (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/package.json (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/src/NoopLogger.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/src/NoopLoggerProvider.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/src/api/logs.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/src/index.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/src/internal/global-utils.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/src/platform/browser/globalThis.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/src/platform/browser/index.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/src/platform/index.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/src/platform/node/globalThis.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/src/platform/node/index.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/src/types/Event.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/src/types/LogRecord.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/src/types/Logger.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/src/types/LoggerOptions.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/src/types/LoggerProvider.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/test/api/api.test.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/test/index-webpack.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/test/internal/global.test.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/test/noop-implementations/noop-logger-provider.test.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/test/noop-implementations/noop-logger.test.ts (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/tsconfig.all.json (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/tsconfig.docs.json (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/tsconfig.esm.json (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/tsconfig.esnext.json (100%) rename experimental/packages/{opentelemetry-api-logs => api-logs}/tsconfig.json (100%) diff --git a/experimental/packages/opentelemetry-api-logs/.eslintignore b/experimental/packages/api-logs/.eslintignore similarity index 100% rename from experimental/packages/opentelemetry-api-logs/.eslintignore rename to experimental/packages/api-logs/.eslintignore diff --git a/experimental/packages/opentelemetry-api-logs/.eslintrc.js b/experimental/packages/api-logs/.eslintrc.js similarity index 100% rename from experimental/packages/opentelemetry-api-logs/.eslintrc.js rename to experimental/packages/api-logs/.eslintrc.js diff --git a/experimental/packages/opentelemetry-api-logs/LICENSE b/experimental/packages/api-logs/LICENSE similarity index 100% rename from experimental/packages/opentelemetry-api-logs/LICENSE rename to experimental/packages/api-logs/LICENSE diff --git a/experimental/packages/opentelemetry-api-logs/README.md b/experimental/packages/api-logs/README.md similarity index 100% rename from experimental/packages/opentelemetry-api-logs/README.md rename to experimental/packages/api-logs/README.md diff --git a/experimental/packages/opentelemetry-api-logs/karma.conf.js b/experimental/packages/api-logs/karma.conf.js similarity index 100% rename from experimental/packages/opentelemetry-api-logs/karma.conf.js rename to experimental/packages/api-logs/karma.conf.js diff --git a/experimental/packages/opentelemetry-api-logs/package.json b/experimental/packages/api-logs/package.json similarity index 100% rename from experimental/packages/opentelemetry-api-logs/package.json rename to experimental/packages/api-logs/package.json diff --git a/experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts b/experimental/packages/api-logs/src/NoopLogger.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/src/NoopLogger.ts rename to experimental/packages/api-logs/src/NoopLogger.ts diff --git a/experimental/packages/opentelemetry-api-logs/src/NoopLoggerProvider.ts b/experimental/packages/api-logs/src/NoopLoggerProvider.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/src/NoopLoggerProvider.ts rename to experimental/packages/api-logs/src/NoopLoggerProvider.ts diff --git a/experimental/packages/opentelemetry-api-logs/src/api/logs.ts b/experimental/packages/api-logs/src/api/logs.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/src/api/logs.ts rename to experimental/packages/api-logs/src/api/logs.ts diff --git a/experimental/packages/opentelemetry-api-logs/src/index.ts b/experimental/packages/api-logs/src/index.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/src/index.ts rename to experimental/packages/api-logs/src/index.ts diff --git a/experimental/packages/opentelemetry-api-logs/src/internal/global-utils.ts b/experimental/packages/api-logs/src/internal/global-utils.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/src/internal/global-utils.ts rename to experimental/packages/api-logs/src/internal/global-utils.ts diff --git a/experimental/packages/opentelemetry-api-logs/src/platform/browser/globalThis.ts b/experimental/packages/api-logs/src/platform/browser/globalThis.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/src/platform/browser/globalThis.ts rename to experimental/packages/api-logs/src/platform/browser/globalThis.ts diff --git a/experimental/packages/opentelemetry-api-logs/src/platform/browser/index.ts b/experimental/packages/api-logs/src/platform/browser/index.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/src/platform/browser/index.ts rename to experimental/packages/api-logs/src/platform/browser/index.ts diff --git a/experimental/packages/opentelemetry-api-logs/src/platform/index.ts b/experimental/packages/api-logs/src/platform/index.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/src/platform/index.ts rename to experimental/packages/api-logs/src/platform/index.ts diff --git a/experimental/packages/opentelemetry-api-logs/src/platform/node/globalThis.ts b/experimental/packages/api-logs/src/platform/node/globalThis.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/src/platform/node/globalThis.ts rename to experimental/packages/api-logs/src/platform/node/globalThis.ts diff --git a/experimental/packages/opentelemetry-api-logs/src/platform/node/index.ts b/experimental/packages/api-logs/src/platform/node/index.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/src/platform/node/index.ts rename to experimental/packages/api-logs/src/platform/node/index.ts diff --git a/experimental/packages/opentelemetry-api-logs/src/types/Event.ts b/experimental/packages/api-logs/src/types/Event.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/src/types/Event.ts rename to experimental/packages/api-logs/src/types/Event.ts diff --git a/experimental/packages/opentelemetry-api-logs/src/types/LogRecord.ts b/experimental/packages/api-logs/src/types/LogRecord.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/src/types/LogRecord.ts rename to experimental/packages/api-logs/src/types/LogRecord.ts diff --git a/experimental/packages/opentelemetry-api-logs/src/types/Logger.ts b/experimental/packages/api-logs/src/types/Logger.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/src/types/Logger.ts rename to experimental/packages/api-logs/src/types/Logger.ts diff --git a/experimental/packages/opentelemetry-api-logs/src/types/LoggerOptions.ts b/experimental/packages/api-logs/src/types/LoggerOptions.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/src/types/LoggerOptions.ts rename to experimental/packages/api-logs/src/types/LoggerOptions.ts diff --git a/experimental/packages/opentelemetry-api-logs/src/types/LoggerProvider.ts b/experimental/packages/api-logs/src/types/LoggerProvider.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/src/types/LoggerProvider.ts rename to experimental/packages/api-logs/src/types/LoggerProvider.ts diff --git a/experimental/packages/opentelemetry-api-logs/test/api/api.test.ts b/experimental/packages/api-logs/test/api/api.test.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/test/api/api.test.ts rename to experimental/packages/api-logs/test/api/api.test.ts diff --git a/experimental/packages/opentelemetry-api-logs/test/index-webpack.ts b/experimental/packages/api-logs/test/index-webpack.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/test/index-webpack.ts rename to experimental/packages/api-logs/test/index-webpack.ts diff --git a/experimental/packages/opentelemetry-api-logs/test/internal/global.test.ts b/experimental/packages/api-logs/test/internal/global.test.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/test/internal/global.test.ts rename to experimental/packages/api-logs/test/internal/global.test.ts diff --git a/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger-provider.test.ts b/experimental/packages/api-logs/test/noop-implementations/noop-logger-provider.test.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger-provider.test.ts rename to experimental/packages/api-logs/test/noop-implementations/noop-logger-provider.test.ts diff --git a/experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger.test.ts b/experimental/packages/api-logs/test/noop-implementations/noop-logger.test.ts similarity index 100% rename from experimental/packages/opentelemetry-api-logs/test/noop-implementations/noop-logger.test.ts rename to experimental/packages/api-logs/test/noop-implementations/noop-logger.test.ts diff --git a/experimental/packages/opentelemetry-api-logs/tsconfig.all.json b/experimental/packages/api-logs/tsconfig.all.json similarity index 100% rename from experimental/packages/opentelemetry-api-logs/tsconfig.all.json rename to experimental/packages/api-logs/tsconfig.all.json diff --git a/experimental/packages/opentelemetry-api-logs/tsconfig.docs.json b/experimental/packages/api-logs/tsconfig.docs.json similarity index 100% rename from experimental/packages/opentelemetry-api-logs/tsconfig.docs.json rename to experimental/packages/api-logs/tsconfig.docs.json diff --git a/experimental/packages/opentelemetry-api-logs/tsconfig.esm.json b/experimental/packages/api-logs/tsconfig.esm.json similarity index 100% rename from experimental/packages/opentelemetry-api-logs/tsconfig.esm.json rename to experimental/packages/api-logs/tsconfig.esm.json diff --git a/experimental/packages/opentelemetry-api-logs/tsconfig.esnext.json b/experimental/packages/api-logs/tsconfig.esnext.json similarity index 100% rename from experimental/packages/opentelemetry-api-logs/tsconfig.esnext.json rename to experimental/packages/api-logs/tsconfig.esnext.json diff --git a/experimental/packages/opentelemetry-api-logs/tsconfig.json b/experimental/packages/api-logs/tsconfig.json similarity index 100% rename from experimental/packages/opentelemetry-api-logs/tsconfig.json rename to experimental/packages/api-logs/tsconfig.json From b21a1d2e3a1033a151784b8cbb6f089d09c73634 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Mon, 8 Aug 2022 08:06:05 -0700 Subject: [PATCH 14/27] updated example --- experimental/packages/api-logs/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/experimental/packages/api-logs/README.md b/experimental/packages/api-logs/README.md index 145877bd83..6629574b1f 100644 --- a/experimental/packages/api-logs/README.md +++ b/experimental/packages/api-logs/README.md @@ -28,6 +28,9 @@ If you are writing an instrumentation library, or prefer to call the API methods ```javascript const api = require("@opentelemetry/api-logs"); +/* A specific implementation of LoggerProvider comes from an SDK */ +const loggerProvider = createLoggerProvider(); + /* Initialize LoggerProvider */ api.logs.setGlobalLoggerProvider(loggerProvider); /* returns loggerProvider (no-op if a working provider has not been initialized) */ From 684030da7355ddb5a3a39bc3c79b02c4ba101406 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Mon, 8 Aug 2022 08:09:37 -0700 Subject: [PATCH 15/27] set compatibility version to 1 --- experimental/packages/api-logs/src/internal/global-utils.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/experimental/packages/api-logs/src/internal/global-utils.ts b/experimental/packages/api-logs/src/internal/global-utils.ts index af5e924c59..705139aeda 100644 --- a/experimental/packages/api-logs/src/internal/global-utils.ts +++ b/experimental/packages/api-logs/src/internal/global-utils.ts @@ -52,4 +52,4 @@ export function makeGetter( * version. If the global API is not compatible with the API package * attempting to get it, a NOOP API implementation will be returned. */ -export const API_BACKWARDS_COMPATIBILITY_VERSION = 4; +export const API_BACKWARDS_COMPATIBILITY_VERSION = 1; From a112b1e1d7960f79b11f7e3840f0eb1b653e6925 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Mon, 15 Aug 2022 08:58:47 -0700 Subject: [PATCH 16/27] fixed change to the wrong file --- experimental/packages/api-logs/tsconfig.docs.json | 2 +- .../packages/opentelemetry-api-metrics/tsconfig.docs.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/experimental/packages/api-logs/tsconfig.docs.json b/experimental/packages/api-logs/tsconfig.docs.json index 627fa3ff3e..18c131e2b9 100644 --- a/experimental/packages/api-logs/tsconfig.docs.json +++ b/experimental/packages/api-logs/tsconfig.docs.json @@ -7,7 +7,7 @@ "src/**/*.ts" ], "typedocOptions": { - "name": "OpenTelemetry API for JavaScript", + "name": "OpenTelemetry Logs API for JavaScript", "out": "docs/out", "mode": "file", "hideGenerator": true diff --git a/experimental/packages/opentelemetry-api-metrics/tsconfig.docs.json b/experimental/packages/opentelemetry-api-metrics/tsconfig.docs.json index 18c131e2b9..627fa3ff3e 100644 --- a/experimental/packages/opentelemetry-api-metrics/tsconfig.docs.json +++ b/experimental/packages/opentelemetry-api-metrics/tsconfig.docs.json @@ -7,7 +7,7 @@ "src/**/*.ts" ], "typedocOptions": { - "name": "OpenTelemetry Logs API for JavaScript", + "name": "OpenTelemetry API for JavaScript", "out": "docs/out", "mode": "file", "hideGenerator": true From 06bbd52a672d8f6755658752ed3aa3ec9e2002ec Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Wed, 17 Aug 2022 19:02:34 -0700 Subject: [PATCH 17/27] updated dependencies --- experimental/packages/api-logs/package.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/experimental/packages/api-logs/package.json b/experimental/packages/api-logs/package.json index 5ec798e919..c0409163d0 100644 --- a/experimental/packages/api-logs/package.json +++ b/experimental/packages/api-logs/package.json @@ -65,8 +65,8 @@ "@opentelemetry/api": "^1.1.0" }, "devDependencies": { - "@types/mocha": "8.2.3", - "@types/node": "14.17.33", + "@types/mocha": "9.1.1", + "@types/node": "18.6.5", "@types/webpack-env": "1.16.3", "codecov": "3.8.3", "istanbul-instrumenter-loader": "3.0.1", @@ -76,12 +76,12 @@ "karma-mocha": "2.0.1", "karma-spec-reporter": "0.0.32", "karma-webpack": "4.0.2", - "mocha": "7.2.0", + "mocha": "10.0.0", "nyc": "15.1.0", - "ts-loader": "8.3.0", - "ts-mocha": "9.0.2", + "ts-loader": "8.4.0", + "ts-mocha": "10.0.0", "typescript": "4.4.4", "webpack": "4.46.0" }, - "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-api-logs" + "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/api-logs" } From a8e17b4e42db737218c32a165c5e8593d545ec94 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Thu, 18 Aug 2022 14:46:43 -0700 Subject: [PATCH 18/27] added api-logs to tsconfig references --- tsconfig.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/tsconfig.json b/tsconfig.json index cdbf4c4272..4e977f5424 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -88,6 +88,9 @@ { "path": "packages/template" }, + { + "path": "experimental/packages/api-logs" + }, { "path": "experimental/packages/exporter-trace-otlp-grpc" }, From d7cdc9c61d69c557cc786feffd856bf7aa61c240 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Tue, 23 Aug 2022 16:51:04 -0700 Subject: [PATCH 19/27] added trace context to the Event interface, updated eventDomain field description --- experimental/packages/api-logs/src/types/Event.ts | 15 +++++++++++++++ .../packages/api-logs/src/types/LoggerOptions.ts | 2 +- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/experimental/packages/api-logs/src/types/Event.ts b/experimental/packages/api-logs/src/types/Event.ts index 8a26d5dde3..19839e14cb 100644 --- a/experimental/packages/api-logs/src/types/Event.ts +++ b/experimental/packages/api-logs/src/types/Event.ts @@ -36,4 +36,19 @@ export interface Event { * Additional attributes that describe the event. */ attributes?: Attributes; + + /** + * 8 least significant bits are the trace flags as defined in W3C Trace Context specification. + */ + traceFlags?: number; + + /** + * A unique identifier for a trace. + */ + traceId?: string; + + /** + * A unique identifier for a span within a trace. + */ + spanId?: string; } diff --git a/experimental/packages/api-logs/src/types/LoggerOptions.ts b/experimental/packages/api-logs/src/types/LoggerOptions.ts index fe485fc02c..5053822667 100644 --- a/experimental/packages/api-logs/src/types/LoggerOptions.ts +++ b/experimental/packages/api-logs/src/types/LoggerOptions.ts @@ -24,7 +24,7 @@ export interface LoggerOptions { schemaUrl?: string; /** - * The domain for the events created + * The default domain for events created by the Logger. The default domain can be overridden when emitting an individual event. * @default '' */ eventDomain?: string; From e2b02f0e94812134008a5e35a8187133e8736e77 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Tue, 30 Aug 2022 14:53:04 -0700 Subject: [PATCH 20/27] removed includeTraceContext and renamed attributes to scopeAttributes --- .../packages/api-logs/src/types/LoggerOptions.ts | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/experimental/packages/api-logs/src/types/LoggerOptions.ts b/experimental/packages/api-logs/src/types/LoggerOptions.ts index 5053822667..9b2fe06fc8 100644 --- a/experimental/packages/api-logs/src/types/LoggerOptions.ts +++ b/experimental/packages/api-logs/src/types/LoggerOptions.ts @@ -24,19 +24,19 @@ export interface LoggerOptions { schemaUrl?: string; /** - * The default domain for events created by the Logger. The default domain can be overridden when emitting an individual event. + * The default domain for events created by the Logger. + * + * The combination of event name and event domain uiquely identifies an event. + * By supplying an event domain, it is possible to use the same event name across + * different domains / use cases. + * + * The default domain can be overridden when emitting an individual event. * @default '' */ eventDomain?: string; - /** - * Specifies whether the Trace Context should automatically be passed on to the events and logs created by the Logger - * @default false - */ - includeTraceContext?: boolean; - /** * The instrumentation scope attributes to associate with emitted telemetry */ - attributes?: Attributes; + scopeAttributes?: Attributes; } From b6654861e3399ea1f3d3fb5e77c012798732584b Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Wed, 31 Aug 2022 11:54:45 -0700 Subject: [PATCH 21/27] renamed Event interface to LogEvent --- experimental/packages/api-logs/src/NoopLogger.ts | 4 ++-- experimental/packages/api-logs/src/index.ts | 2 +- .../packages/api-logs/src/types/{Event.ts => LogEvent.ts} | 2 +- experimental/packages/api-logs/src/types/Logger.ts | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) rename experimental/packages/api-logs/src/types/{Event.ts => LogEvent.ts} (97%) diff --git a/experimental/packages/api-logs/src/NoopLogger.ts b/experimental/packages/api-logs/src/NoopLogger.ts index 206b9b5d2a..3f2227154c 100644 --- a/experimental/packages/api-logs/src/NoopLogger.ts +++ b/experimental/packages/api-logs/src/NoopLogger.ts @@ -15,10 +15,10 @@ */ import { Logger } from './types/Logger'; -import { Event } from './types/Event'; +import { LogEvent } from './types/LogEvent'; import { LogRecord } from './types/LogRecord'; export class NoopLogger implements Logger { emitLogRecord(_logRecord: LogRecord): void {} - emitEvent(_event: Event): void {} + emitEvent(_event: LogEvent): void {} } diff --git a/experimental/packages/api-logs/src/index.ts b/experimental/packages/api-logs/src/index.ts index 8732221d9a..cf22a2e5eb 100644 --- a/experimental/packages/api-logs/src/index.ts +++ b/experimental/packages/api-logs/src/index.ts @@ -17,7 +17,7 @@ export * from './types/Logger'; export * from './types/LoggerProvider'; export * from './types/LogRecord'; -export * from './types/Event'; +export * from './types/LogEvent'; export * from './types/LoggerOptions'; import { LogsAPI } from './api/logs'; diff --git a/experimental/packages/api-logs/src/types/Event.ts b/experimental/packages/api-logs/src/types/LogEvent.ts similarity index 97% rename from experimental/packages/api-logs/src/types/Event.ts rename to experimental/packages/api-logs/src/types/LogEvent.ts index 19839e14cb..7b37572c6c 100644 --- a/experimental/packages/api-logs/src/types/Event.ts +++ b/experimental/packages/api-logs/src/types/LogEvent.ts @@ -16,7 +16,7 @@ import { Attributes } from '@opentelemetry/api'; -export interface Event { +export interface LogEvent { /** * The time when the event occurred as UNIX Epoch time in nanoseconds. */ diff --git a/experimental/packages/api-logs/src/types/Logger.ts b/experimental/packages/api-logs/src/types/Logger.ts index b88a2b0611..b30f3aff93 100644 --- a/experimental/packages/api-logs/src/types/Logger.ts +++ b/experimental/packages/api-logs/src/types/Logger.ts @@ -15,7 +15,7 @@ */ import { LogRecord } from './LogRecord'; -import { Event } from './Event'; +import { LogEvent } from './LogEvent'; export interface Logger { /** @@ -30,5 +30,5 @@ export interface Logger { * * @param event */ - emitEvent(event: Event): void; + emitEvent(event: LogEvent): void; } From 46933eedf6a7b6424414704dc7d4c4de0126b4c4 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Fri, 2 Sep 2022 10:53:19 -0700 Subject: [PATCH 22/27] missed references to meter provider --- experimental/packages/api-logs/README.md | 2 +- experimental/packages/api-logs/test/internal/global.test.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/experimental/packages/api-logs/README.md b/experimental/packages/api-logs/README.md index 6629574b1f..d940cfc0cc 100644 --- a/experimental/packages/api-logs/README.md +++ b/experimental/packages/api-logs/README.md @@ -35,7 +35,7 @@ const loggerProvider = createLoggerProvider(); api.logs.setGlobalLoggerProvider(loggerProvider); /* returns loggerProvider (no-op if a working provider has not been initialized) */ api.logs.getLoggerProvider(); -/* returns a meter from the registered global meter provider (no-op if a working provider has not been initialized) */ +/* returns a logger from the registered global logger provider (no-op if a working provider has not been initialized) */ const logger = api.logs.getLogger(name, version); // logging an event in an instrumentation library diff --git a/experimental/packages/api-logs/test/internal/global.test.ts b/experimental/packages/api-logs/test/internal/global.test.ts index a2f9f96ce8..8ac9c48cf3 100644 --- a/experimental/packages/api-logs/test/internal/global.test.ts +++ b/experimental/packages/api-logs/test/internal/global.test.ts @@ -40,7 +40,7 @@ describe('Global Utils', () => { api2.logs.disable(); }); - it('should change the global meter provider', () => { + it('should change the global logger provider', () => { const original = api1.logs.getLoggerProvider(); const newLoggerProvider = new NoopLoggerProvider(); api1.logs.setGlobalLoggerProvider(newLoggerProvider); From 3fb0def78a0f9cd044ebc059698e83b0f0c9d259 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Fri, 2 Sep 2022 15:23:03 -0700 Subject: [PATCH 23/27] bumped version to be consistent --- experimental/packages/api-logs/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/experimental/packages/api-logs/package.json b/experimental/packages/api-logs/package.json index c0409163d0..9f513abf03 100644 --- a/experimental/packages/api-logs/package.json +++ b/experimental/packages/api-logs/package.json @@ -1,6 +1,6 @@ { "name": "@opentelemetry/api-logs", - "version": "0.31.0", + "version": "0.32.0", "description": "Public logs API for OpenTelemetry", "main": "build/src/index.js", "module": "build/esm/index.js", From 90a170d9f9c8d6a891eeb1c32e870e13c9c77b91 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Fri, 2 Sep 2022 15:23:53 -0700 Subject: [PATCH 24/27] pin node version for w3c integration tests --- .github/workflows/w3c-integration-test.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/w3c-integration-test.yml b/.github/workflows/w3c-integration-test.yml index c2be63b9df..971ea6ee7f 100644 --- a/.github/workflows/w3c-integration-test.yml +++ b/.github/workflows/w3c-integration-test.yml @@ -13,6 +13,10 @@ jobs: - name: Checkout 🛎️ uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: '16' + - name: restore lock files uses: actions/cache@master # must use unreleased master to cache multiple paths id: cache From f8cd28b0c81d6c270834de31bed63097067661f7 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Fri, 2 Sep 2022 15:49:55 -0700 Subject: [PATCH 25/27] lowered compatible api version --- experimental/packages/api-logs/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/experimental/packages/api-logs/package.json b/experimental/packages/api-logs/package.json index 9f513abf03..91a2ac61f0 100644 --- a/experimental/packages/api-logs/package.json +++ b/experimental/packages/api-logs/package.json @@ -62,7 +62,7 @@ "access": "public" }, "dependencies": { - "@opentelemetry/api": "^1.1.0" + "@opentelemetry/api": "^1.0.0" }, "devDependencies": { "@types/mocha": "9.1.1", From b03c464a58455a675086422da83407b4d797fd67 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Wed, 7 Sep 2022 11:11:36 -0700 Subject: [PATCH 26/27] moved changelog entry to experimental --- CHANGELOG.md | 1 - experimental/CHANGELOG.md | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f8e4ea287f..48de348db0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,7 +22,6 @@ All notable changes to this project will be documented in this file. * feat(sdk-trace-base): move Sampler declaration into sdk-trace-base [#3088](https://github.com/open-telemetry/opentelemetry-js/pull/3088) @legendecas * fix(grpc-instrumentation): added grpc attributes in instrumentation [#3127](https://github.com/open-telemetry/opentelemetry-js/pull/3127) @andrewzenkov * feat: support latest `@opentelemetry/api` [#3177](https://github.com/open-telemetry/opentelemetry-js/pull/3177) @dyladan -* feat: add Logs API @mkuba ### :bug: (Bug Fix) diff --git a/experimental/CHANGELOG.md b/experimental/CHANGELOG.md index 377e37c9fa..9c3307b0b4 100644 --- a/experimental/CHANGELOG.md +++ b/experimental/CHANGELOG.md @@ -42,6 +42,7 @@ All notable changes to experimental packages in this project will be documented ### :rocket: (Enhancement) * Add `resourceDetectors` option to `NodeSDK` [#3210](https://github.com/open-telemetry/opentelemetry-js/issues/3210) +* feat: add Logs API @mkuba [#3117](https://github.com/open-telemetry/opentelemetry-js/pull/3117) ### :bug: (Bug Fix) From 41e7bbfb07b2776845659033ee44613bcd577739 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Wed, 7 Sep 2022 14:50:00 -0700 Subject: [PATCH 27/27] added test for uncovered line --- experimental/packages/api-logs/test/api/api.test.ts | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/experimental/packages/api-logs/test/api/api.test.ts b/experimental/packages/api-logs/test/api/api.test.ts index 1006d3a694..3548e08184 100644 --- a/experimental/packages/api-logs/test/api/api.test.ts +++ b/experimental/packages/api-logs/test/api/api.test.ts @@ -38,6 +38,15 @@ describe('API', () => { const logger = logs.getLoggerProvider().getLogger('name'); assert.deepStrictEqual(logger, dummyLogger); }); + + it('should not allow overriding global provider if already set', () => { + const provider1 = new TestLoggerProvider(); + const provider2 = new TestLoggerProvider(); + logs.setGlobalLoggerProvider(provider1); + assert.equal(logs.getLoggerProvider(), provider1); + logs.setGlobalLoggerProvider(provider2); + assert.equal(logs.getLoggerProvider(), provider1); + }); }); describe('getLogger', () => {