You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|[@opentelemetry/shim-opentracing][otel-shim-opentracing]| OpenTracing shim allows existing OpenTracing instrumentation to report to OpenTelemetry |
301
310
302
-
## Upgrade guidelines
303
-
304
-
### 0.37.x to 0.38.0
305
-
306
-
-`@opentelemetry/sdk-node``NodeSDKConfiguration.defaultAttributes` has been unused and was removed as the concept does not exist in OpenTelemetry anymore
307
-
- Please use `NodeSDKConfiguration.resource` instead.
308
-
309
-
### 0.35.x to 0.36.0
310
-
311
-
-`@opentelemetry/sdk-node` changed `await start()` to now be synchronous
312
-
-`@opentelemetry/sdk-node` changed `await detectResources()` to now be synchronous
313
-
314
-
### 0.28.x to 0.29.x
315
-
316
-
-`@opentelemetry/exporter-trace-otlp-http` is now exporting `scopeSpans` instead of `instrumentationLibrarySpans`
317
-
- this exporter now requires collector version `0.48` and up.
318
-
-`@opentelemetry/exporter-metrics-otlp-http` is now exporting `scopeMetrics` instead of `instrumentationLibraryMetrics`
319
-
- this exporter now requires collector version `0.48` and up.
320
-
321
-
### 0.27.x to 0.28.x
322
-
323
-
- In `@opentelemetry/exporter-trace-otlp-http`, `OTLPExporterBase._isShutdown` is replaced with `_shutdownOnce`.
324
-
325
-
### 0.26.x to 0.27.x
326
-
327
-
Metric and trace exporters are split into separate packages:
328
-
329
-
-`@opentelemetry/exporter-otlp-http` => `@opentelemetry/exporter-trace-otlp-http` and `@opentelemetry/exporter-metrics-otlp-http`
330
-
-`@opentelemetry/exporter-otlp-grpc` => `@opentelemetry/exporter-trace-otlp-grpc` and `@opentelemetry/exporter-metrics-otlp-grpc`
331
-
-`@opentelemetry/exporter-otlp-proto` => `@opentelemetry/exporter-trace-otlp-proto` and `@opentelemetry/exporter-metrics-otlp-proto`
-`ResourceAttributes` renamed to `SemanticResourceAttributes` in the `@opentelemetry/semantic-conventions` package
392
-
393
-
### 0.19.x to 0.20.0
394
-
395
-
-`HttpBaggage` renamed to `HttpBaggagePropagator`
396
-
397
-
-`HttpTraceContext` renamed to `HttpTraceContextPropagator`
398
-
399
-
-`JaegerHttpTracePropagator` renamed to `JaegerPropagator`
400
-
401
-
-`serviceName` configuration removed from Collector exporters. Use `service.name` Resource attribute instead.
402
-
403
-
- Prometheus exporter added suffix `_total` to counter metrics.
404
-
405
-
### 0.18.x to 0.19.0
406
-
407
-
- API is now a peer dependency. This means that users will need to include `@opentelemetry/api` as a dependency of their project in order to use the SDK. NPM version 7+ (Node 15+) should do this automatically.
408
-
409
-
- All plugins have been removed in favor of instrumentations.
410
-
411
-
- The `@opentelemetry/propagator-b3` package previously exported three propagators: `B3Propagator`,`B3SinglePropagator`, and `B3MultiPropagator`, but now only exports the `B3Propagator`. It extracts b3 context in single and multi-header encodings, and injects context using the single-header encoding by default, but can be configured to inject context using the multi-header endcoding during construction: `new B3Propagator({ injectEncoding: B3InjectEncoding.MULTI_HEADER })`. If you were previously using the `B3SinglePropagator` or `B3MultiPropagator` directly, you should update your code to use the `B3Propagator` with the appropriate configuration. See the [readme][otel-propagator-b3] for full details and usage.
412
-
413
-
- Sampling configuration via environment variable has changed. If you were using `OTEL_SAMPLING_PROBABILITY` then you should replace it with `OTEL_TRACES_SAMPLER=parentbased_traceidratio` and `OTEL_TRACES_SAMPLER_ARG=<number>` where `<number>` is a number in the [0..1] range, e.g. "0.25". Default is 1.0 if unset.
414
-
415
-
### 0.17.0 to 0.18.0
416
-
417
-
-`diag.setLogLevel` is removed and LogLevel can be set by an optional second parameter to `setLogger`
- Breaking change - The resulting resource MUST have all attributes that are on any of the two input resources. If a key exists on both the old and updating resource, the value of the updating resource MUST be picked - previously it was opposite.
422
-
423
-
### 0.16.0 to 0.17.0
424
-
425
-
[PR-1880](https://github.com/open-telemetry/opentelemetry-js/pull/1880) feat(diag-logger): introduce a new global level api.diag for internal diagnostic logging
- These PR's remove the previous `Logger` and `LogLevel` implementations and change the way you should use the replacement `DiagLogger` and `DiagLogLevel`, below are simple examples of how to change your existing usages.
430
-
431
-
#### Setting the global diagnostic logger
432
-
433
-
The new global [`api.diag`](https://github.com/open-telemetry/opentelemetry-js/blob/main/api/src/api/diag.ts) provides the ability to set the global diagnostic logger `setLogger()` and logging level `setLogLevel()`, it is also a `DiagLogger` implementation and should be directly to log diagnostic messages.
434
-
435
-
All included logger references have been removed in preference to using the global `api.diag` directly, so you no longer need to pass around the logger instance via function parameters or included as part of the configuration for a component.
-`registerInstrumentations` supports loading old plugins and instrumentations together. It also supports setting tracer provider and meter provider on instrumentations
522
-
523
-
[PR-1874](https://github.com/open-telemetry/opentelemetry-js/pull/1874) More specific API type names
524
-
525
-
Some types exported from `"@opentelemetry/api"` have been changed to be more specific.
526
-
527
-
-`AttributeValue` renamed to `SpanAttributeValue`
528
-
-`Attributes` renamed to `SpanAttributes`
529
-
-`EntryTtl` renamed to `BaggageEntryTtl`
530
-
-`EntryValue` renamed to `BaggageEntryValue`
531
-
-`Status` renamed to `SpanStatus`
532
-
-`StatusCode` renamed to `SpanStatusCode`
533
-
534
-
### 0.15.0 to 0.16.0
535
-
536
-
[PR-1863](https://github.com/open-telemetry/opentelemetry-js/pull/1863) removed public attributes `keepAlive` and `httpAgentOptions` from nodejs `CollectorTraceExporter` and `CollectorMetricExporter`
537
-
538
-
### 0.14.0 to 0.15.0
539
-
540
-
[PR-1764](https://github.com/open-telemetry/opentelemetry-js/pull/1764) removed some APIs from `Tracer`:
541
-
542
-
-`Tracer.getCurrentSpan()`: use `api.getSpan(api.context.active())`
543
-
-`Tracer.withSpan(span)`: use `api.context.with(api.setSpan(api.context.active(), span))`
544
-
-`Tracer.bind(target)`: use `api.context.bind(target)`
545
-
546
-
[PR-1797](https://github.com/open-telemetry/opentelemetry-js/pull/1797) chore!: split metrics into its own api package:
547
-
548
-
- Any references to `require("@opentelemetry/api").metrics` will need to be changed to `require("@opentelemetry/api-metrics").metrics`
549
-
550
-
[PR-1725](https://github.com/open-telemetry/opentelemetry-js/pull/1725) Use new gRPC default port
551
-
552
-
- The default port used by `@opentelemetry/exporter-collector-grpc` is changed from `55680` to `4317`
553
-
554
-
[PR-1749](https://github.com/open-telemetry/opentelemetry-js/pull/1749) chore: improve naming of span related context APIs
555
-
556
-
- Rename `[gs]etActiveSpan()` to `[gs]etSpan()`
557
-
- Rename `setExtractedSpanContext()` to `setSpanContext()`
558
-
- Rename `getParentSpanContext()` to `getSpanContext()`
Copy file name to clipboardExpand all lines: doc/contributing/dependencies.md
+4-8
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,10 @@
1
-
# OpenTelemetry JS Code Contribution Guide
2
-
3
-
This document outlines the essential guidelines for contributing code to the OpenTelemetry JS repository. These guidelines are designed to ensure consistency, stability, and the highest quality of code across the project.
4
-
5
-
## Dependencies
1
+
# OpenTelemetry Dependencies
6
2
7
3
This section refers to `"dependencies"` and `"devDependencies"` entries in `package.json` file.
8
4
> [!IMPORTANT]
9
5
> Not all libraries follow [Semantic Versioning](https://semver.org/). Even those who do might occasionally introduce breaking changes due to human errors. Exceptions to the guidelines in this document MAY be granted by Approvers or Maintainers to work around this.
10
6
11
-
###Development Dependencies
7
+
## Development Dependencies
12
8
13
9
`"devDependencies"` SHOULD be pinned to reduce the risk of autobreaking the build. Since we cannot use the `package-lock.json` file (because the libraries are distributed without it), control over the version our contributors will get is limited. By using pinned versions, we prevent potential disruptions caused by unpinned versions.
14
10
@@ -17,15 +13,15 @@ This section refers to `"dependencies"` and `"devDependencies"` entries in `pack
17
13
> [!NOTE]
18
14
> As this approach might leave our project with outdated tooling, we adopt `renovate-bot`. This automated dependency update tool proactively opens pull requests upon the release of new patch/minor/major versions. The complete configuration for renovate-bot can be found in [renovate.json](../renovate.json) file.
19
15
20
-
###@opentelemetry/* dependencies
16
+
## @opentelemetry/* dependencies
21
17
22
18
All packages from the `@opentelemetry/` namespace MUST have the same pinned version, as these dependencies are automatically updated on each release by lerna.
23
19
24
20
**Example:** all packages under `packages/` should consistently maintain the same version, as should those under `experimental/packages/`.
25
21
26
22
An exception is granted for dependencies on `@opentelemetry/api`, which, if used by the package SHOULD NOT be included as a `dependency`. `@opentelemetry/api` SHOULD be included as a `peerDependency` instead. The version range of the `peerDependency` SHOULD reflect the minimum supported, and SHOULD NOT allow versions greater than the latest released minor version.
27
23
28
-
###Third-Party Library Dependencies
24
+
## Third-Party Library Dependencies
29
25
30
26
Packages categorized as third-party and listed under the `"dependencies"` section (e.g., @grpc/grpc-js, @grpc/proto-loader, shimmer, etc.) should remain unpinned and utilize the caret (`^`) symbol. This approach offers several advantages:
0 commit comments