@azure/core-tracing 1.0.0-dev.20200807.1 → 1.0.0-preview.12

package/CHANGELOG.md

@@ -1,7 +1,28 @@
 # Release History
 
-## 1.0.0-preview.10 (Unreleased)
+## 1.0.0-preview.12 (2021-06-30)
 
+- Update `@opentelemetry/api` to version 1.0.0 [PR #15883](https://github.com/Azure/azure-sdk-for-js/pull/15883)
+
+### Breaking Changes
+
+- Removed `OpenCensusSpanWrapper` and `OpenCensusTracerWrapper` from the public API. Customers using these wrappers should migrate to using `OpenTelemetry` directly. [PR #15770](https://github.com/Azure/azure-sdk-for-js/pull/15770)
+- Update `@azure/core-tracing` to version 1.0.0-preview.12. This brings core-tracing up to date with `@opentelemetry/api@1.0.0`.
+  - `Span#context` was renamed to `Span#spanContext`. This change is supported in `@azure/core-http@1.2.7`.
+
+## 1.0.0-preview.11 (2021-03-30)
+
+### Breaking Changes
+
+- Update @azure/core-tracing to version 1.0.0-preview.11. This brings core-tracing up to date with @opentelemetry/api@1.0.0-rc.0.
+  There are two scenarios that will require changes if you are using tracing:
+  - Previously, you would pass a parent span using the `OperationOptions.tracingOptions.spanOptions.parentSpan` property. This has been
+    changed so that you now specify a parent `Context` using the `OperationOptions.tracingOptions.tracingContext` property instead.
+  - The status code for Spans is no longer of type `CanonicalCode`. Instead, it's now `SpanStatusCode`, which also has a smaller range of values.
+
+## 1.0.0-preview.10 (2021-03-04)
+
+- Internal improvements to make future opentelemetry updates simpler.
 
 ## 1.0.0-preview.9 (2020-08-04)
 

package/README.md

@@ -14,7 +14,7 @@ npm install @azure/core-tracing
 
 ## Key Concepts
 
-The `@azure/core-tracing` package supports enabling tracing for Azure SDK packages, using an [OpenTelemetry](https://opentelemetry.io/) `Tracer`. If you are using [OpenCensus](https://opencensus.io/) instead, we provide an `OpenCensusTracerWrapper` that allows you to convert an OpenCensus `Tracer` into an OpenTelemetry `Tracer`.
+The `@azure/core-tracing` package supports enabling tracing for Azure SDK packages, using an [OpenTelemetry](https://opentelemetry.io/) `Tracer`.
 
 By default, all libraries log with a `NoOpTracer` that takes no action.
 To change this, you have to use `setTracer` to set a new default `Tracer`.
@@ -24,7 +24,7 @@ To change this, you have to use `setTracer` to set a new default `Tracer`.
 ### Example 1 - Setting an OpenTelemetry Tracer
 
 ```js
-const opentelemetry = require("@opentelemetry/core");
+const opentelemetry = require("@opentelemetry/api");
 const { BasicTracer, SimpleSpanProcessor } = require("@opentelemetry/tracing");
 const { ZipkinExporter } = require("@opentelemetry/exporter-zipkin");
 const { setTracer } = require("@azure/core-tracing");
@@ -35,9 +35,10 @@ const exporter = new ZipkinExporter({
 const tracer = new BasicTracer();
 tracer.addSpanProcessor(new SimpleSpanProcessor(exporter));
 
-opentelemetry.initGlobalTracer(tracer);
+setTracer(tracer);
 
-const rootSpan = opentelemetry.getTracer().startSpan("root");
+const rootSpan = tracer.startSpan("root");
+const context = opentelemetry.setSpan(opentelemetry.context.active(), rootSpan);
 
 // Call some client library methods and pass rootSpan via tracingOptions.
 
@@ -45,46 +46,27 @@ rootSpan.end();
 exporter.shutdown();
 ```
 
-### Example 2 - Setting an OpenCensus Tracer
-
-```js
-const tracing = require("@opencensus/nodejs");
-const { ZipkinTraceExporter } = require("@opencensus/exporter-zipkin");
-const {
-  setTracer,
-  OpenCensusTracerWrapper,
-  OpenCensusSpanWrapper
-} = require("@azure/core-tracing");
-
-const tracer = tracing.start({ samplingRate: 1 }).tracer;
-
-tracer.registerSpanEventListener(
-  new ZipkinTraceExporter({
-    serviceName: "azure-tracing-sample",
-    bufferTimeout: 2
-  })
-);
-setTracer(new OpenCensusTracerWrapper(tracer));
-tracer.startRootSpan({ name: "root" }, async (rootSpanEx) => {
-  const rootSpan = new OpenCensusSpanWrapper(rootSpanEx);
-  // Call some client library methods and pass rootSpan via tracingOptions.
-  rootSpanEx.end(); // rootSpan.end() should work as well
-});
-```
-
-### Example 3 - Passing parent Spans to library operations
+### Example 2 - Passing current Context to library operations
 
 ```js
 // Given a BlobClient from @azure/storage-blob
 const result = await blobClient.download(undefined, undefined, {
   tracingOptions: {
-    spanOptions: { parent: rootSpan }
+    tracingContext: context
   }
 });
 ```
 
+## Next steps
+
+You can build and run the tests locally by executing `rushx test`. Explore the `test` folder to see advanced usage and behavior of the public classes.
+
+## Troubleshooting
+
+If you run into issues while using this library, please feel free to [file an issue](https://github.com/Azure/azure-sdk-for-js/issues/new).
+
 ## Contributing
 
-If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
+If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
 
 ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fcore%2Fcore-tracing%2FREADME.png)