Skip to content

Commit b59aa33

Browse files
vmarchaudmayurkale22
authored andcommitted
Add readme for both scope packages open-telemetry#96 (open-telemetry#148)
* add readme for async-hooks scope manager package * add readme for base scope manager package * chore(readme): fix typos
1 parent 081469f commit b59aa33

File tree

3 files changed

+50
-7
lines changed

3 files changed

+50
-7
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,26 @@
1-
OpenTelemetry AsyncHooks ContextManager
2-
======================================================
1+
# OpenTelemetry AsyncHooks-based Scope Manager
2+
[![Gitter chat][gitter-image]][gitter-url]
3+
[![dependencies][dependencies-image]][dependencies-url]
4+
[![devDependencies][devDependencies-image]][devDependencies-url]
5+
[![Apache License][license-image]][license-image]
36

4-
TODO
7+
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.
8+
9+
## Useful links
10+
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
11+
- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
12+
- For help or feedback on this project, join us on [gitter][gitter-url]
13+
14+
## License
15+
16+
Apache 2.0 - See [LICENSE][license-url] for more information.
17+
18+
[gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-js.svg
19+
[gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
20+
[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/master/LICENSE
21+
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
22+
[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-scope-async-hooks
23+
[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-scope-async-hooks
24+
[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-scope-async-hooks
25+
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-scope-async-hooks&type=dev
26+
[async-hooks-doc]: http://nodejs.org/dist/latest/docs/api/async_hooks.html
+24-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,25 @@
1-
OpenTelemetry Base Scope Manager
2-
======================================================
1+
# OpenTelemetry Base Scope Manager
2+
[![Gitter chat][gitter-image]][gitter-url]
3+
[![dependencies][dependencies-image]][dependencies-url]
4+
[![devDependencies][devDependencies-image]][devDependencies-url]
5+
[![Apache License][license-image]][license-image]
36

4-
TODO
7+
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.
8+
9+
## Useful links
10+
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
11+
- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
12+
- For help or feedback on this project, join us on [gitter][gitter-url]
13+
14+
## License
15+
16+
Apache 2.0 - See [LICENSE][license-url] for more information.
17+
18+
[gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-js.svg
19+
[gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
20+
[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/master/LICENSE
21+
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
22+
[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-scope-base
23+
[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-scope-base
24+
[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-scope-base
25+
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-scope-base&type=dev

packages/opentelemetry-scope-base/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@opentelemetry/scope-base",
33
"version": "0.0.1",
4-
"description": "OpenTelemetry Base Scope Management",
4+
"description": "OpenTelemetry Base Scope Manager",
55
"main": "build/src/index.js",
66
"types": "build/src/index.d.ts",
77
"repository": "open-telemetry/opentelemetry-js",

0 commit comments

Comments
 (0)