Add Quartz.OpenTracing to change log and docs

quartznet · Oct 25, 2020 · 3ce179f · 3ce179f
1 parent 651f36d
commit 3ce179f
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 1 deletion.
diff --git a/changelog.md b/changelog.md
@@ -5,6 +5,12 @@
 
 ## Release vNext, Oct xx 2020
 
+This release addresses issue with Autofac integration and adds new integration package Quartz.OpenTracing to allow
+integration with OpenTracing.
+
+* NEW FEATURE
+
+  * Add Quartz.OpenTracing support (#1006)
 
 * FIXES
 

diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -117,6 +117,7 @@ module.exports = {
               ['/documentation/quartz-3.x/packages/hosted-services-integration', 'Hosted Services Integration'],
               ['/documentation/quartz-3.x/packages/microsoft-di-integration', 'Microsoft DI Integration'],
               ['/documentation/quartz-3.x/packages/opentelemetry-integration', 'OpenTelemetry Integration'],
+              ['/documentation/quartz-3.x/packages/opentracing-integration', 'OpenTracing Integration'],
               ['/documentation/quartz-3.x/packages/timezoneconverter-integration', 'TimeZoneConverter Integration'],
             ]
           }

diff --git a/docs/documentation/quartz-3.x/packages/opentelemetry-integration.md b/docs/documentation/quartz-3.x/packages/opentelemetry-integration.md
@@ -6,7 +6,7 @@ Quartz 3.1 or later required.
 :::
 
 ::: danger
-The OpenTelemetry integration libraries are in beta so this integration can break and change behavior.
+The integration library can still live a bit and thus integration API can have breaking changes and change behavior.
 :::
 
 ## Installation

diff --git a/docs/documentation/quartz-3.x/packages/opentracing-integration.md b/docs/documentation/quartz-3.x/packages/opentracing-integration.md
@@ -0,0 +1,38 @@
+[Quartz.OpenTracing](https://www.nuget.org/packages/Quartz.OpenTracing)
+provides integration with [OpenTracing](https://opentracing.io/). You may also consider
+[Quartz.OpenTelemetry.Instrumentation](opentelemetry-integration.md) package which will supercede OpenTracing and OpenCensus
+when OpenTelemetry project reaches maturity.
+
+::: tip
+Quartz 3.2.3 or later required.
+:::
+
+::: danger
+The integration library can still live a bit and thus integration API can have breaking changes and change behavior.
+:::
+
+## Installation
+
+You need to add NuGet package reference to your project which uses Quartz.
+
+    Install-Package Quartz.OpenTracing
+
+## Using
+
+You can add Quartz configuration by invoking an extension method `AddQuartzOpenTracing` on `IServiceCollection`.
+
+
+**Example Startup.ConfigureServices configuration**
+
+```csharp
+public void ConfigureServices(IServiceCollection services)
+{
+    // make sure you configure logging and OpenTracing before quartz services
+    services.AddQuartzOpenTracing(options =>
+    {
+        // these are the defaults
+        options.ComponentName = "Quartz";
+        options.IncludeExceptionDetails = false;
+    });
+}
+```