From 7c098063090c827cf97f61d998c0c4aa2d5dd65f Mon Sep 17 00:00:00 2001 From: Daniel Dyla Date: Mon, 27 Jul 2020 13:56:32 -0400 Subject: [PATCH] Add nodejs sdk package (#1187) Co-authored-by: Naseem Co-authored-by: legendecas Co-authored-by: Mark Wolff Co-authored-by: Matthew Wear --- packages/opentelemetry-metrics/src/index.ts | 1 + packages/opentelemetry-node/src/index.ts | 2 + packages/opentelemetry-sdk-node/.eslintignore | 1 + packages/opentelemetry-sdk-node/.eslintrc.js | 7 + packages/opentelemetry-sdk-node/LICENSE | 201 ++++++++++++++++++ packages/opentelemetry-sdk-node/README.md | 146 +++++++++++++ packages/opentelemetry-sdk-node/package.json | 66 ++++++ packages/opentelemetry-sdk-node/src/index.ts | 25 +++ packages/opentelemetry-sdk-node/src/sdk.ts | 161 ++++++++++++++ packages/opentelemetry-sdk-node/src/types.ts | 36 ++++ .../opentelemetry-sdk-node/src/version.ts | 18 ++ .../opentelemetry-sdk-node/test/sdk.test.ts | 124 +++++++++++ packages/opentelemetry-sdk-node/tsconfig.json | 11 + 13 files changed, 799 insertions(+) create mode 100644 packages/opentelemetry-sdk-node/.eslintignore create mode 100644 packages/opentelemetry-sdk-node/.eslintrc.js create mode 100644 packages/opentelemetry-sdk-node/LICENSE create mode 100644 packages/opentelemetry-sdk-node/README.md create mode 100644 packages/opentelemetry-sdk-node/package.json create mode 100644 packages/opentelemetry-sdk-node/src/index.ts create mode 100644 packages/opentelemetry-sdk-node/src/sdk.ts create mode 100644 packages/opentelemetry-sdk-node/src/types.ts create mode 100644 packages/opentelemetry-sdk-node/src/version.ts create mode 100644 packages/opentelemetry-sdk-node/test/sdk.test.ts create mode 100644 packages/opentelemetry-sdk-node/tsconfig.json diff --git a/packages/opentelemetry-metrics/src/index.ts b/packages/opentelemetry-metrics/src/index.ts index 0be805519a..2a0c408d71 100644 --- a/packages/opentelemetry-metrics/src/index.ts +++ b/packages/opentelemetry-metrics/src/index.ts @@ -26,3 +26,4 @@ export * from './export/Batcher'; export * from './export/ConsoleMetricExporter'; export * from './export/types'; export * from './UpDownCounterMetric'; +export { MeterConfig } from './types'; diff --git a/packages/opentelemetry-node/src/index.ts b/packages/opentelemetry-node/src/index.ts index bece472ede..092ae180c9 100644 --- a/packages/opentelemetry-node/src/index.ts +++ b/packages/opentelemetry-node/src/index.ts @@ -14,4 +14,6 @@ * limitations under the License. */ +export { NodeTracerConfig } from './config'; +export { Plugins } from './instrumentation/PluginLoader'; export * from './NodeTracerProvider'; diff --git a/packages/opentelemetry-sdk-node/.eslintignore b/packages/opentelemetry-sdk-node/.eslintignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/packages/opentelemetry-sdk-node/.eslintignore @@ -0,0 +1 @@ +build diff --git a/packages/opentelemetry-sdk-node/.eslintrc.js b/packages/opentelemetry-sdk-node/.eslintrc.js new file mode 100644 index 0000000000..f726f3becb --- /dev/null +++ b/packages/opentelemetry-sdk-node/.eslintrc.js @@ -0,0 +1,7 @@ +module.exports = { + "env": { + "mocha": true, + "node": true + }, + ...require('../../eslint.config.js') +} diff --git a/packages/opentelemetry-sdk-node/LICENSE b/packages/opentelemetry-sdk-node/LICENSE new file mode 100644 index 0000000000..5d6f747bfd --- /dev/null +++ b/packages/opentelemetry-sdk-node/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 2020 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. diff --git a/packages/opentelemetry-sdk-node/README.md b/packages/opentelemetry-sdk-node/README.md new file mode 100644 index 0000000000..2db342d0d7 --- /dev/null +++ b/packages/opentelemetry-sdk-node/README.md @@ -0,0 +1,146 @@ +# OpenTelemetry SDK for Node.js + +[![Gitter chat][gitter-image]][gitter-url] +[![NPM Published Version][npm-img]][npm-url] +[![dependencies][dependencies-image]][dependencies-url] +[![devDependencies][devDependencies-image]][devDependencies-url] +[![Apache License][license-image]][license-image] + +This package provides the full OpenTelemetry SDK for Node.js including tracing and metrics. + +## Quick Start + +To get started you need to install `@opentelemetry/sdk-node`, a metrics and/or tracing exporter, and any appropriate plugins for the node modules used by your application. + +### Installation + +```sh +$ # Install the SDK +$ npm install @opentelemetry/sdk-node + +$ # Install exporters and plugins +$ npm install \ + @opentelemetry/exporter-jaeger \ # add tracing exporters as needed + @opentelemetry/exporter-prometheus # add metrics exporters as needed + @opentelemetry/plugin-http # add plugins as needed + +$ # or install all officially supported core and contrib plugins +$ npm install @opentelemetry/plugins-node-all +``` + +> Note: this example is for Node.js. See [examples/tracer-web](https://github.com/open-telemetry/opentelemetry-js/tree/master/examples/tracer-web) for a browser example. + +### Initialize the SDK + +Before any other module in your application is loaded, you must initialize the SDK. +If you fail to initialize the SDK or initialize it too late, no-op implementations will be provided to any library which acquires a tracer or meter from the API. +This example uses Jaeger and Prometheus, but exporters exist for [other tracing backends][other-tracing-backends]. + +```javascript +const opentelemetry = require("@opentelemetry/sdk-node"); +const { JaegerExporter } = require("@opentelemetry/exporter-jaeger"); +const { PrometheusExporter } = require("@opentelemetry/exporter-prometheus"); + +const jaegerExporter = new JaegerExporter({ + serviceName: 'my-service', +}); +const prometheusExporter = new PrometheusExporter({ startServer: true }); + +const sdk = new opentelemetry.NodeSDK({ + // Optional - if omitted, the tracing SDK will not be initialized + traceExporter: jaegerExporter, + // Optional - If omitted, the metrics SDK will not be initialized + metricExporter: prometheusExporter, + + // See the Configuration section below for additional configuration options +}); + +// You can optionally detect resources asynchronously from the environment. +// Detected resources are merged with the resources provided in the SDK configuration. +sdk + .start() + .then(() => { + // Resources have been detected and SDK is started + }) +``` + +## Configuration + +Below is a full list of configuration options which may be passed into the `NodeSDK` constructor; + +### autoDetectResources + +Detect resources automatically from the environment using the default resource detectors. Default `true`. + +### contextManager + +Use a custom context manager. Default: [AsyncHooksContextManager](../opentelemetry-context-async-hooks/README.md) + +### httpTextPropagator + +Use a custom propagator. Default: [CompositePropagator](../opentelemetry-core/src/context/propagation/composite.ts) using [W3C Trace Context](../opentelemetry-core/README.md#httptracecontext-propagator) and [Correlation Context](../opentelemetry-core/README.md#correlation-context-propagator) + +### logger + +Use a custom logger. Default: Logging disabled + +### logLevel + +Default: [INFO](../opentelemetry-core/src/common/types.ts#L19) + +### metricBatcher + +Use a custom batcher for metrics. Default: [UngroupedBatcher](../opentelemetry-metrics/src/export/Batcher.ts#L50) + +### metricExporter + +Configure a metric exporter. If an exporter is not configured, the metrics SDK will not be initialized and registered. + +### metricInterval + +Configure an interval for metrics export in ms. Default: 60,000 (60 seconds) + +### plugins + +Configure plugins. By default, all plugins which are installed and in the [Default Plugins List](../opentelemetry-node/src/config.ts#L29) will be enabled. + +### resource + +Configure a resource. Resources may also be detected by using the `autoDetectResources` method of the SDK. + +### sampler + +Configure a custom sampler. By default all traces will be sampled. + +### spanProcessor + +### traceExporter + +Configure a trace exporter. If an exporter OR span processor is not configured, the tracing SDK will not be initialized and registered. If an exporter is configured, it will be used with a [BatchSpanProcessor](../opentelemetry-tracing/src/export/BatchSpanProcessor.ts). + +### traceParams + +Configure tracing parameters. These are the same trace parameters used to [configure a tracer](../opentelemetry-tracing/src/types.ts#L71). + +## Useful links + +- For more information on OpenTelemetry, visit: +- For more about OpenTelemetry JavaScript: +- For help or feedback on this project, join us on [gitter][gitter-url] + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +[gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-js.svg +[gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge +[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/master/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-sdk-node +[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-sdk-node +[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-sdk-node +[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-sdk-node&type=dev +[npm-url]: https://www.npmjs.com/package/@opentelemetry/sdk-node +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fsdk-node.svg + +[other-tracing-backends]: https://github.com/open-telemetry/opentelemetry-js#trace-exporters diff --git a/packages/opentelemetry-sdk-node/package.json b/packages/opentelemetry-sdk-node/package.json new file mode 100644 index 0000000000..7815a67644 --- /dev/null +++ b/packages/opentelemetry-sdk-node/package.json @@ -0,0 +1,66 @@ +{ + "name": "@opentelemetry/sdk-node", + "version": "0.9.0", + "description": "OpenTelemetry SDK for Node.js", + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js", + "scripts": { + "test": "nyc ts-mocha -p tsconfig.json test/**/*.test.ts", + "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../", + "build": "npm run compile", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "precompile": "tsc --version", + "version:update": "node ../../scripts/version-update.js", + "compile": "npm run version:update && tsc -p .", + "prepare": "npm run compile", + "watch": "tsc -w" + }, + "keywords": [ + "opentelemetry", + "nodejs", + "tracing", + "profiling", + "metrics", + "stats", + "monitoring" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": ">=8.0.0" + }, + "files": [ + "build/src/**/*.js", + "build/src/**/*.js.map", + "build/src/**/*.d.ts", + "LICENSE", + "README.md" + ], + "publishConfig": { + "access": "public" + }, + "dependencies": { + "@opentelemetry/api": "0.9.0", + "@opentelemetry/context-base": "0.9.0", + "@opentelemetry/core": "0.9.0", + "@opentelemetry/metrics": "0.9.0", + "@opentelemetry/node": "0.9.0", + "@opentelemetry/resources": "0.9.0", + "@opentelemetry/tracing": "0.9.0" + }, + "devDependencies": { + "@opentelemetry/context-async-hooks": "0.9.0", + "@types/mocha": "7.0.2", + "@types/node": "14.0.13", + "codecov": "3.7.0", + "gts": "2.0.2", + "istanbul-instrumenter-loader": "3.0.1", + "mocha": "7.2.0", + "nyc": "15.1.0", + "ts-loader": "7.0.5", + "ts-mocha": "7.0.0", + "typescript": "3.9.5" + } +} diff --git a/packages/opentelemetry-sdk-node/src/index.ts b/packages/opentelemetry-sdk-node/src/index.ts new file mode 100644 index 0000000000..b511af8046 --- /dev/null +++ b/packages/opentelemetry-sdk-node/src/index.ts @@ -0,0 +1,25 @@ +/* + * 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 * as api from '@opentelemetry/api'; +export * as contextBase from '@opentelemetry/context-base'; +export * as core from '@opentelemetry/core'; +export * as metrics from '@opentelemetry/metrics'; +export * as node from '@opentelemetry/node'; +export * as resources from '@opentelemetry/resources'; +export * as tracing from '@opentelemetry/tracing'; +export * from './sdk'; +export * from './types'; diff --git a/packages/opentelemetry-sdk-node/src/sdk.ts b/packages/opentelemetry-sdk-node/src/sdk.ts new file mode 100644 index 0000000000..3b27e1331e --- /dev/null +++ b/packages/opentelemetry-sdk-node/src/sdk.ts @@ -0,0 +1,161 @@ +/* + * 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 { HttpTextPropagator, metrics } from '@opentelemetry/api'; +import { ContextManager } from '@opentelemetry/context-base'; +import { MeterConfig, MeterProvider } from '@opentelemetry/metrics'; +import { NodeTracerConfig, NodeTracerProvider } from '@opentelemetry/node'; +import { detectResources, Resource } from '@opentelemetry/resources'; +import { BatchSpanProcessor, SpanProcessor } from '@opentelemetry/tracing'; +import { NodeSDKConfiguration } from './types'; + +/** This class represents everything needed to register a fully configured OpenTelemetry Node.js SDK */ +export class NodeSDK { + private _tracerProviderConfig?: { + tracerConfig: NodeTracerConfig; + spanProcessor: SpanProcessor; + contextManager?: ContextManager; + httpTextPropagator?: HttpTextPropagator; + }; + private _meterProviderConfig?: MeterConfig; + + private _resource: Resource; + + private _autoDetectResources: boolean; + + /** + * Create a new NodeJS SDK instance + */ + public constructor(configuration: Partial = {}) { + this._resource = configuration.resource ?? new Resource({}); + + this._autoDetectResources = configuration.autoDetectResources ?? true; + + if (configuration.spanProcessor || configuration.traceExporter) { + const tracerProviderConfig: NodeTracerConfig = {}; + + if (typeof configuration.logLevel === 'number') { + tracerProviderConfig.logLevel = configuration.logLevel; + } + if (configuration.logger) { + tracerProviderConfig.logger = configuration.logger; + } + if (configuration.plugins) { + tracerProviderConfig.plugins = configuration.plugins; + } + if (configuration.sampler) { + tracerProviderConfig.sampler = configuration.sampler; + } + if (configuration.traceParams) { + tracerProviderConfig.traceParams = configuration.traceParams; + } + + const spanProcessor = + configuration.spanProcessor ?? + new BatchSpanProcessor(configuration.traceExporter!); + + this.configureTracerProvider( + tracerProviderConfig, + spanProcessor, + configuration.contextManager, + configuration.httpTextPropagator + ); + } + + if (configuration.metricExporter) { + const meterConfig: MeterConfig = {}; + + if (configuration.metricBatcher) { + meterConfig.batcher = configuration.metricBatcher; + } + if (configuration.metricExporter) { + meterConfig.exporter = configuration.metricExporter; + } + if (typeof configuration.metricInterval === 'number') { + meterConfig.interval = configuration.metricInterval; + } + if (typeof configuration.logLevel === 'number') { + meterConfig.logLevel = configuration.logLevel; + } + if (configuration.logger) { + meterConfig.logger = configuration.logger; + } + + this.configureMeterProvider(meterConfig); + } + } + + /** Set configurations required to register a NodeTracerProvider */ + public configureTracerProvider( + tracerConfig: NodeTracerConfig, + spanProcessor: SpanProcessor, + contextManager?: ContextManager, + httpTextPropagator?: HttpTextPropagator + ) { + this._tracerProviderConfig = { + tracerConfig, + spanProcessor, + contextManager, + httpTextPropagator, + }; + } + + /** Set configurations needed to register a MeterProvider */ + public configureMeterProvider(config: MeterConfig) { + this._meterProviderConfig = config; + } + + /** Detect resource attributes */ + public async detectResources() { + this.addResource(await detectResources()); + } + + /** Manually add a resource */ + public addResource(resource: Resource) { + this._resource = this._resource.merge(resource); + } + + /** + * Once the SDK has been configured, call this method to construct SDK components and register them with the OpenTelemetry API. + */ + public async start() { + if (this._autoDetectResources) { + await this.detectResources(); + } + + if (this._tracerProviderConfig) { + const tracerProvider = new NodeTracerProvider({ + ...this._tracerProviderConfig.tracerConfig, + resource: this._resource, + }); + + tracerProvider.addSpanProcessor(this._tracerProviderConfig.spanProcessor); + tracerProvider.register({ + contextManager: this._tracerProviderConfig.contextManager, + propagator: this._tracerProviderConfig.httpTextPropagator, + }); + } + + if (this._meterProviderConfig) { + const meterProvider = new MeterProvider({ + ...this._meterProviderConfig, + resource: this._resource, + }); + + metrics.setGlobalMeterProvider(meterProvider); + } + } +} diff --git a/packages/opentelemetry-sdk-node/src/types.ts b/packages/opentelemetry-sdk-node/src/types.ts new file mode 100644 index 0000000000..a093cbcfa4 --- /dev/null +++ b/packages/opentelemetry-sdk-node/src/types.ts @@ -0,0 +1,36 @@ +/* + * 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 type { ContextManager } from '@opentelemetry/context-base'; +import type { api, core, metrics, node, resources, tracing } from '.'; + +export interface NodeSDKConfiguration { + autoDetectResources: boolean; + contextManager: ContextManager; + defaultAttributes: api.Attributes; + httpTextPropagator: api.HttpTextPropagator; + logger: api.Logger; + logLevel: core.LogLevel; + metricBatcher: metrics.Batcher; + metricExporter: metrics.MetricExporter; + metricInterval: number; + plugins: node.Plugins; + resource: resources.Resource; + sampler: api.Sampler; + spanProcessor: tracing.SpanProcessor; + traceExporter: tracing.SpanExporter; + traceParams: tracing.TraceParams; +} diff --git a/packages/opentelemetry-sdk-node/src/version.ts b/packages/opentelemetry-sdk-node/src/version.ts new file mode 100644 index 0000000000..2c92beb616 --- /dev/null +++ b/packages/opentelemetry-sdk-node/src/version.ts @@ -0,0 +1,18 @@ +/* + * 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. + */ + +// this is autogenerated file, see scripts/version-update.js +export const VERSION = '0.9.0'; diff --git a/packages/opentelemetry-sdk-node/test/sdk.test.ts b/packages/opentelemetry-sdk-node/test/sdk.test.ts new file mode 100644 index 0000000000..b9d464025d --- /dev/null +++ b/packages/opentelemetry-sdk-node/test/sdk.test.ts @@ -0,0 +1,124 @@ +/* + * 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 { + context, + metrics, + NoopHttpTextPropagator, + NoopMeterProvider, + NoopTracerProvider, + propagation, + trace, +} from '@opentelemetry/api'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; +import { NoopContextManager } from '@opentelemetry/context-base'; +import { CompositePropagator } from '@opentelemetry/core'; +import { ConsoleMetricExporter, MeterProvider } from '@opentelemetry/metrics'; +import { NodeTracerProvider } from '@opentelemetry/node'; +import { + ConsoleSpanExporter, + SimpleSpanProcessor, +} from '@opentelemetry/tracing'; +import * as assert from 'assert'; +import { NodeSDK } from '../src'; + +describe('Node SDK', () => { + beforeEach(() => { + context.disable(); + trace.disable(); + propagation.disable(); + metrics.disable(); + }); + + describe('Basic Registration', () => { + it('should not register any unconfigured SDK components', async () => { + const sdk = new NodeSDK({ + autoDetectResources: false, + }); + + await sdk.start(); + + assert.ok(context['_getContextManager']() instanceof NoopContextManager); + assert.ok( + propagation['_getGlobalPropagator']() instanceof NoopHttpTextPropagator + ); + + assert.ok(trace.getTracerProvider() instanceof NoopTracerProvider); + assert.ok(metrics.getMeterProvider() instanceof NoopMeterProvider); + }); + + it('should register a tracer provider if an exporter is provided', async () => { + const sdk = new NodeSDK({ + traceExporter: new ConsoleSpanExporter(), + autoDetectResources: false, + }); + + await sdk.start(); + + assert.ok(metrics.getMeterProvider() instanceof NoopMeterProvider); + + assert.ok( + context['_getContextManager']() instanceof AsyncHooksContextManager + ); + assert.ok( + propagation['_getGlobalPropagator']() instanceof CompositePropagator + ); + assert.ok(trace.getTracerProvider() instanceof NodeTracerProvider); + }); + + it('should register a tracer provider if a span processor is provided', async () => { + const exporter = new ConsoleSpanExporter(); + const spanProcessor = new SimpleSpanProcessor(exporter); + + const sdk = new NodeSDK({ + spanProcessor, + autoDetectResources: false, + }); + + await sdk.start(); + + assert.ok(metrics.getMeterProvider() instanceof NoopMeterProvider); + + assert.ok( + context['_getContextManager']() instanceof AsyncHooksContextManager + ); + assert.ok( + propagation['_getGlobalPropagator']() instanceof CompositePropagator + ); + assert.ok(trace.getTracerProvider() instanceof NodeTracerProvider); + }); + + it('should register a meter provider if an exporter is provided', async () => { + const exporter = new ConsoleMetricExporter(); + + const sdk = new NodeSDK({ + metricExporter: exporter, + autoDetectResources: false, + }); + + await sdk.start(); + + assert.ok(context['_getContextManager']() instanceof NoopContextManager); + assert.ok( + propagation['_getGlobalPropagator']() instanceof NoopHttpTextPropagator + ); + + assert.ok(trace.getTracerProvider() instanceof NoopTracerProvider); + + assert.ok(metrics.getMeterProvider() instanceof MeterProvider); + }); + }); +}); diff --git a/packages/opentelemetry-sdk-node/tsconfig.json b/packages/opentelemetry-sdk-node/tsconfig.json new file mode 100644 index 0000000000..a2042cd68b --- /dev/null +++ b/packages/opentelemetry-sdk-node/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] +}