@opentelemetry/api
Advanced tools
Comparing version 1.0.0-rc.1 to 1.0.0-rc.2
@@ -5,36 +5,2 @@ # CHANGELOG | ||
## 1.0.0-rc.1 | ||
### :boom: Breaking Change | ||
* [#55](https://github.com/open-telemetry/opentelemetry-js-api/pull/55) chore: move baggage methods in propagation namespace ([@vmarchaud](https://github.com/vmarchaud)) | ||
* [#65](https://github.com/open-telemetry/opentelemetry-js-api/pull/65) chore: remove suppress instrumentation ([@dyladan](https://github.com/dyladan)) | ||
* [#60](https://github.com/open-telemetry/opentelemetry-js-api/pull/60) chore: removing timed event ([@obecny](https://github.com/obecny)) | ||
* [#58](https://github.com/open-telemetry/opentelemetry-js-api/pull/58) chore: use spancontext for link ([@dyladan](https://github.com/dyladan)) | ||
* [#47](https://github.com/open-telemetry/opentelemetry-js-api/pull/47) chore: move span method for context in trace API #40 ([@vmarchaud](https://github.com/vmarchaud)) | ||
* [#45](https://github.com/open-telemetry/opentelemetry-js-api/pull/45) chore: rename `span#context()` to `span#spanContext` ([@dyladan](https://github.com/dyladan)) | ||
* [#43](https://github.com/open-telemetry/opentelemetry-js-api/pull/43) chore: renaming noop span to non recording span ([@obecny](https://github.com/obecny)) | ||
* [#32](https://github.com/open-telemetry/opentelemetry-js-api/pull/32) feat!: return boolean success value from setGlobalXXX methods ([@dyladan](https://github.com/dyladan)) | ||
### :rocket: Enhancement | ||
* [#62](https://github.com/open-telemetry/opentelemetry-js-api/pull/62) chore: adding component logger ([@obecny](https://github.com/obecny)) | ||
* [#54](https://github.com/open-telemetry/opentelemetry-js-api/pull/54) feat: add tracer.startActiveSpan() ([@naseemkullah](https://github.com/naseemkullah)) | ||
* [#58](https://github.com/open-telemetry/opentelemetry-js-api/pull/58) chore: use spancontext for link ([@dyladan](https://github.com/dyladan)) | ||
* [#51](https://github.com/open-telemetry/opentelemetry-js-api/pull/51) feat: add function to wrap SpanContext in NonRecordingSpan #49 ([@dyladan](https://github.com/dyladan)) | ||
### :memo: Documentation | ||
* [#64](https://github.com/open-telemetry/opentelemetry-js-api/pull/64) chore: document the reason for symbol.for ([@dyladan](https://github.com/dyladan)) | ||
* [#44](https://github.com/open-telemetry/opentelemetry-js-api/pull/44) chore: updating readme headline and fixing links ([@obecny](https://github.com/obecny)) | ||
### Committers: 6 | ||
* Bartlomiej Obecny ([@obecny](https://github.com/obecny)) | ||
* Daniel Dyla ([@dyladan](https://github.com/dyladan)) | ||
* Gerhard Stöbich ([@Flarna](https://github.com/Flarna)) | ||
* Naseem ([@naseemkullah](https://github.com/naseemkullah)) | ||
* Valentin Marchaud ([@vmarchaud](https://github.com/vmarchaud)) | ||
* t2t2 ([@t2t2](https://github.com/t2t2)) | ||
## 1.0.0-rc.0 | ||
@@ -41,0 +7,0 @@ |
{ | ||
"name": "@opentelemetry/api", | ||
"version": "1.0.0-rc.1", | ||
"version": "1.0.0-rc.2", | ||
"description": "Public API for OpenTelemetry", | ||
"main": "build/src/index.js", | ||
"module": "build/esm/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/src/platform/index.js": "./build/src/platform/browser/index.js" | ||
@@ -16,6 +14,6 @@ }, | ||
"build": "npm run compile", | ||
"clean": "tsc --build --clean tsconfig.json tsconfig.esm.json", | ||
"clean": "tsc --build --clean", | ||
"codecov:browser": "nyc report --reporter=json && codecov -f coverage/*.json -p .", | ||
"codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p .", | ||
"compile": "tsc --build tsconfig.json tsconfig.esm.json", | ||
"compile": "tsc --build", | ||
"docs": "typedoc", | ||
@@ -46,5 +44,2 @@ "docs:deploy": "gh-pages --dist docs/out", | ||
"files": [ | ||
"build/esm/**/*.js", | ||
"build/esm/**/*.js.map", | ||
"build/esm/**/*.d.ts", | ||
"build/src/**/*.js", | ||
@@ -60,10 +55,10 @@ "build/src/**/*.js.map", | ||
"devDependencies": { | ||
"@types/mocha": "8.2.2", | ||
"@types/node": "14.14.42", | ||
"@types/sinon": "10.0.0", | ||
"@types/mocha": "8.2.1", | ||
"@types/node": "14.14.28", | ||
"@types/sinon": "9.0.10", | ||
"@types/webpack-env": "1.16.0", | ||
"@typescript-eslint/eslint-plugin": "4.22.0", | ||
"@typescript-eslint/parser": "4.22.0", | ||
"@typescript-eslint/eslint-plugin": "4.15.1", | ||
"@typescript-eslint/parser": "4.15.1", | ||
"codecov": "3.8.1", | ||
"eslint": "7.25.0", | ||
"eslint": "7.20.0", | ||
"eslint-plugin-header": "3.1.1", | ||
@@ -80,13 +75,13 @@ "eslint-plugin-import": "2.22.1", | ||
"karma-webpack": "4.0.2", | ||
"lerna-changelog": "1.0.1", | ||
"linkinator": "2.13.6", | ||
"lerna-changelog": "^1.0.1", | ||
"linkinator": "2.13.5", | ||
"mocha": "7.2.0", | ||
"nyc": "15.1.0", | ||
"sinon": "10.0.0", | ||
"ts-loader": "8.2.0", | ||
"sinon": "9.2.4", | ||
"ts-loader": "8.0.17", | ||
"ts-mocha": "8.0.0", | ||
"typedoc": "0.20.36", | ||
"typescript": "4.2.4", | ||
"typedoc": "0.20.25", | ||
"typescript": "4.1.5", | ||
"webpack": "4.46.0" | ||
} | ||
} |
@@ -1,32 +0,1 @@ | ||
--- | ||
<p align="center"> | ||
<strong> | ||
<a href="https://open-telemetry.github.io/opentelemetry-js">API Documentation<a/> | ||
• | ||
<a href="https://github.com/open-telemetry/opentelemetry-js/discussions">Getting In Touch (GitHub Discussions)<a/> | ||
</strong> | ||
</p> | ||
<p align="center"> | ||
<a href="https://github.com/open-telemetry/opentelemetry-js-api/releases"> | ||
<img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/open-telemetry/opentelemetry-js-api?include_prereleases&style=for-the-badge"> | ||
</a> | ||
<a href="https://codecov.io/gh/open-telemetry/opentelemetry-js-api/branch/main/"> | ||
<img alt="Codecov Status" src="https://img.shields.io/codecov/c/github/open-telemetry/opentelemetry-js-api?style=for-the-badge"> | ||
</a> | ||
<a href="https://github.com/open-telemetry/opentelemetry-js-api/blob/main/LICENSE"> | ||
<img alt="license" src="https://img.shields.io/badge/license-Apache_2.0-green.svg?style=for-the-badge"> | ||
</a> | ||
<br/> | ||
<a href="https://github.com/open-telemetry/opentelemetry-js-api/actions/workflows/docs.yaml"> | ||
<img alt="Build Status" src="https://github.com/open-telemetry/opentelemetry-js-api/actions/workflows/test.yaml/badge.svg?branch=main"> | ||
</a> | ||
<a href="https://github.com/open-telemetry/opentelemetry-js-api/actions/workflows/test.yaml?query=branch%3Amain"> | ||
<img alt="Build Status" src="https://github.com/open-telemetry/opentelemetry-js-api/actions/workflows/docs.yaml/badge.svg"> | ||
</a> | ||
</p> | ||
--- | ||
# OpenTelemetry API for JavaScript | ||
@@ -37,2 +6,3 @@ | ||
[![devDependencies][devDependencies-image]][devDependencies-url] | ||
[![Apache License][license-image]][license-image] | ||
@@ -84,3 +54,3 @@ This package provides everything needed to interact with the OpenTelemetry API, including all TypeScript interfaces, enums, and no-op implementations. It is intended for use both on the server and in the browser. | ||
const span = tracer.startSpan("do operation"); | ||
// mock some work by sleeping 1 second | ||
@@ -108,14 +78,2 @@ await new Promise((resolve, reject) => { | ||
## Upgrade Guidelines | ||
### 1.0.0-rc.1 to x | ||
### 1.0.0-rc.0 to 1.0.0-rc.1 | ||
- Removing `TimedEvent` which was not part of spec | ||
- `HttpBaggage` renamed to `HttpBaggagePropagator` | ||
- [#45](https://github.com/open-telemetry/opentelemetry-js-api/pull/45) `Span#context` renamed to `Span#spanContext` | ||
- [#47](https://github.com/open-telemetry/opentelemetry-js-api/pull/47) `getSpan`/`setSpan`/`getSpanContext`/`setSpanContext` moved to `trace` namespace | ||
- [#55](https://github.com/open-telemetry/opentelemetry-js-api/pull/55) `getBaggage`/`setBaggage`/`createBaggage` moved to `propagation` namespace | ||
## Useful links | ||
@@ -136,9 +94,10 @@ | ||
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat | ||
[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-api.svg | ||
[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-api/status.svg | ||
[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-api | ||
[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-api.svg?type=dev | ||
[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-api/dev-status.svg | ||
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-api?type=dev | ||
[npm-url]: https://www.npmjs.com/package/@opentelemetry/api | ||
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fapi.svg | ||
[docs-tracing]: https://github.com/open-telemetry/opentelemetry-js-api/blob/main/docs/tracing.md | ||
[docs-sdk-registration]: https://github.com/open-telemetry/opentelemetry-js-api/blob/main/docs/sdk-registration.md |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Deprecated
MaintenanceThe maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.
Found 1 instance in 1 package
Empty package
Supply chain riskPackage does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Deprecated
MaintenanceThe maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.
Found 1 instance in 1 package
21244
4
0
100
2