From b59aa335f2fd7ca21586ff93ff0acc9ee65dd3eb Mon Sep 17 00:00:00 2001 From: Valentin Marchaud Date: Thu, 1 Aug 2019 18:35:07 +0200 Subject: [PATCH] Add readme for both scope packages #96 (#148) * add readme for async-hooks scope manager package * add readme for base scope manager package * chore(readme): fix typos --- .../opentelemetry-scope-async-hooks/README.md | 28 +++++++++++++++++-- packages/opentelemetry-scope-base/README.md | 27 ++++++++++++++++-- .../opentelemetry-scope-base/package.json | 2 +- 3 files changed, 50 insertions(+), 7 deletions(-) diff --git a/packages/opentelemetry-scope-async-hooks/README.md b/packages/opentelemetry-scope-async-hooks/README.md index 7b6324c3ced..63e19e4f652 100644 --- a/packages/opentelemetry-scope-async-hooks/README.md +++ b/packages/opentelemetry-scope-async-hooks/README.md @@ -1,4 +1,26 @@ -OpenTelemetry AsyncHooks ContextManager -====================================================== +# OpenTelemetry AsyncHooks-based Scope Manager +[![Gitter chat][gitter-image]][gitter-url] +[![dependencies][dependencies-image]][dependencies-url] +[![devDependencies][devDependencies-image]][devDependencies-url] +[![Apache License][license-image]][license-image] -TODO +This package provides [async-hooks][async-hooks-doc] based scope manager which is used internally by OpenTelemetry plugins to propagate specific scope between function calls and async operations. It only targets NodeJS since async-hooks is only available there. + +## 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-scope-async-hooks +[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-scope-async-hooks +[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-scope-async-hooks +[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-scope-async-hooks&type=dev +[async-hooks-doc]: http://nodejs.org/dist/latest/docs/api/async_hooks.html diff --git a/packages/opentelemetry-scope-base/README.md b/packages/opentelemetry-scope-base/README.md index 78f2ffb794d..796e67f42bd 100644 --- a/packages/opentelemetry-scope-base/README.md +++ b/packages/opentelemetry-scope-base/README.md @@ -1,4 +1,25 @@ -OpenTelemetry Base Scope Manager -====================================================== +# OpenTelemetry Base Scope Manager +[![Gitter chat][gitter-image]][gitter-url] +[![dependencies][dependencies-image]][dependencies-url] +[![devDependencies][devDependencies-image]][devDependencies-url] +[![Apache License][license-image]][license-image] -TODO +This package provides the ScopeManager interface (which is used by concrete implementations) and a no-op implementation (which is used internally when no scope propagation is defined). It's intended for use both on the server and in the browser. + +## 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-scope-base +[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-scope-base +[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-scope-base +[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-scope-base&type=dev diff --git a/packages/opentelemetry-scope-base/package.json b/packages/opentelemetry-scope-base/package.json index 5edc6966aa3..81cf8a56f3b 100644 --- a/packages/opentelemetry-scope-base/package.json +++ b/packages/opentelemetry-scope-base/package.json @@ -1,7 +1,7 @@ { "name": "@opentelemetry/scope-base", "version": "0.0.1", - "description": "OpenTelemetry Base Scope Management", + "description": "OpenTelemetry Base Scope Manager", "main": "build/src/index.js", "types": "build/src/index.d.ts", "repository": "open-telemetry/opentelemetry-js",