Merge pull request #172 in OP/openkit-dotnet from feature/ONE-50587-p…

…repare-openkit-dotnet-release-2.1 to release/2.1

* commit '9204a30dfc6cadf8c064fa6f6237ec91d04622e7':
  Fix badges for AppVeyor and coveralls
  Remove -SNAPSHOT suffix in .csproj file.
  Prepare OpenKit .NET release 2.1

GitOrigin-RevId: 21e4a980fc3980488daa16c120b80af722d6c888

CHANGELOG.md

@@ -1,19 +1,23 @@
 # OpenKit .NET Changelog
 
+## [Unreleased](https://github.com/Dynatrace/openkit-dotnet/compare/v2.1.0...HEAD)
+
+## 2.1.0 [Release date: 2020-11-16]
+[GitHub Releases](https://github.com/Dynatrace/openkit-dotnet/releases/tag/v2.1.0)
+
 ### Added
 - `DynatraceOpenKitBuilderVB` and `AppMonOpenKitBuilderVB` are added to workaround
   an ambiguity error affecting VisualBasic developers. Since VB is case insensitive
  `AbstractOpenKitBuilder.WithModelID(string)` and `AbstractOpenKitBuilder.WithModelId(string)`
   are considered the same methods.  
   This workaround is marked as obsolete and will be removed when the obsolete method
   `AbstractOpenKitBuilder.WithModelID(string)` is removed.
-- Support for reporting `long` values.
-- Convenience method for reporting an `Exception` as crash.
-- Overloaded `Action.reportError(string, int)` method for reporting an integer error code without description.  
-  The old `Action.reportError(string, int, string)` has been deprecated in favor of the new one.
-- Overloaded `Action.reportError(string, Exception)` for reporting caught exceptions as error.
-- Overloaded `Action.reportError(string, string, string, string)` for reporting generic errors to
-  Dynatrace.
+- Overloaded `IAction.ReportValue(string, long`) method for reporting 64-bit integer values.
+- Overloaded `ISession.ReportCrash(Exception)` as convenience method for reporting an `Exception` as crash.
+- Overloaded `IAction.ReportError(string, int)` method for reporting an integer error code without description.  
+  The old `IAction.ReportError(string, int, string)` has been deprecated in favor of the new one.
+- Overloaded `IAction.ReportError(string, Exception)` for reporting caught exceptions as error.
+- Overloaded `IAction.ReportError(string, string, string, string)` for reporting generic errors to Dynatrace.
 
 ### Changed
 - Fix issue with sessions being closed after splitting.

Directory.Build.props

@@ -7,7 +7,7 @@
     <AssemblyOriginatorKeyFile>../../keys/Dynatrace.OpenKit.NET.snk</AssemblyOriginatorKeyFile>
     <DelaySign>false</DelaySign>
     <GenerateAssemblyInfo>true</GenerateAssemblyInfo>
-    <PackageVersion>2.1.0.0-SNAPSHOT</PackageVersion>
+    <PackageVersion>2.1.0.0</PackageVersion>
     <Title>OpenKit .NET</Title>
     <Authors>Dynatrace LLC</Authors>
     <Company>Dynatrace LLC</Company>

README.md

@@ -1,8 +1,8 @@
 # Dynatrace OpenKit - .NET Reference Implementation
 
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
-[![Build status](https://ci.appveyor.com/api/projects/status/ug034eehokcyw1ks/branch/main?svg=true)](https://ci.appveyor.com/project/openkitdt/openkit-dotnet/branch/main)
-[![Coverage Status](https://coveralls.io/repos/github/Dynatrace/openkit-dotnet/badge.svg?branch=main)](https://coveralls.io/github/Dynatrace/openkit-dotnet?branch=main)
+[![Build status](https://ci.appveyor.com/api/projects/status/ug034eehokcyw1ks/branch/release/2.1?svg=true)](https://ci.appveyor.com/project/openkitdt/openkit-dotnet/branch/release/2.1)
+[![Coverage Status](https://coveralls.io/repos/github/Dynatrace/openkit-dotnet/badge.svg?branch=release%2F2.1)](https://coveralls.io/github/Dynatrace/openkit-dotnet?branch=release%2F2.1)
 
 :information_source: We changed the default branch name to `main`. You can find the necessary steps to update your local clone on [Scott Hanselman's Blog](https://www.hanselman.com/blog/EasilyRenameYourGitDefaultBranchFromMasterToMain.aspx).  
 We encourage you to rename the default branch in your forks too.

docs/supported_versions.md

@@ -9,8 +9,9 @@ Example: Version `1.4.5` supersedes `1.4.4` and therefore only `1.4.5` will be m
 ## Active maintenance
 | Version | Bug fixes          | Security fixes     | Remarks          |
 |---------|:------------------:|:------------------:|------------------|
-| 2.0.X   | :heavy_check_mark: | :heavy_check_mark: |                  | 
-| 1.4.X   | :heavy_check_mark: | :heavy_check_mark: |                  | 
+| 2.1.X   | :heavy_check_mark: | :heavy_check_mark: |                  |
+| 2.0.X   | :heavy_check_mark: | :heavy_check_mark: |                  |
+| 1.4.X   | :heavy_check_mark: | :heavy_check_mark: |                  |
 | 1.3.X   |        :x:         |        :x:         | Upgrade to 1.4.X |
 | 1.2.X   |        :x:         |        :x:         | Upgrade to 1.4.X |
 | 1.1.X   |        :x:         |        :x:         | Upgrade to 1.4.X |

docs/upgrade_guide.md

@@ -1,5 +1,14 @@
 # Upgrade guide for OpenKit .NET
 
+## OpenKit .NET 2.0 to 2.1
+There are no breaking API changes and upgrading is straightforward, by [updating][update] the library
+to the latest 2.1 release.
+
+### Deprecated API
+* `IAction.ReportError(string errorName, int errorCode, string reason)`  
+  Use `IAction.ReportError(string errorName, int errorCode)` without `string reason` argument, as
+  `reason` is unhandled in Dynatrace.
+
 ## OpenKit .NET 1.4 to 2.0
 There are no breaking API changes and upgrading is straightforward, by [updating][update] the library
 to the latest 2.0 release.
@@ -9,6 +18,10 @@ to the latest 2.0 release.
   Use `IWebRequestTracer.Stop(int responseCode)` instead as replacement.
 * `DynatraceOpenKitBuilder.WithApplicationName(string applicationName)`  
   The application name is configured in Dynatrace Web UI.
+* `AbstractOpenKitBuilder.EnableVerbose()`  
+  Use `AbstractOpenKitBuilder.WithLogLevel(LogLevel.DEBUG)` instead.
+* `AbstractOpenKitBuilder.WithModelID(string modelId)`  
+  Use `AbstractOpenKitBuilder.WithModelId(string modelId)` instead.
 
 ## OpenKit .NET 1.3 and below to 1.4
 There are no breaking API changes and upgrading is straightforward, by [updating][update] the library

src/Dynatrace.OpenKit/API/IAction.cs

@@ -95,7 +95,7 @@ public interface IAction : IDisposable
         /// <param name="errorCode">numeric error code of this error</param>
         /// <param name="reason">reason for this error</param>
         /// <returns>this Action (for usage as fluent API)</returns>
-        [Obsolete("use IAction.ReportError(string, int) instead, since reason is unhandled")]
+        [Obsolete("Since 2.1.0. Use IAction.ReportError(string, int) instead, since reason is unhandled")]
         IAction ReportError(string errorName, int errorCode, string reason);
 
         /// <summary>

src/Dynatrace.OpenKit/Dynatrace.OpenKit.csproj

@@ -15,7 +15,7 @@
     <IsPackable>false</IsPackable>
     <!-- set the package id, otherwise it's equal to the AssemblyName -->
     <PackageId>Dynatrace.OpenKit.NET</PackageId>
-    <Version>2.1.0-SNAPSHOT</Version>
+    <Version>2.1.0</Version>
   </PropertyGroup>
 
   <!-- generate full debug information when coverage is built -->

src/Dynatrace.OpenKit/Protocol/ProtocolConstants.cs

@@ -19,7 +19,7 @@ namespace Dynatrace.OpenKit.Protocol
     public static class ProtocolConstants
     {
         // version constants
-        public const string OpenKitVersion = "8.198.20100";
+        public const string OpenKitVersion = "8.208.20100";
         public const int ProtocolVersion = 3;
         public const int PlatformTypeOpenKit = 1;
         public const string AgentTechnologyType = "okdotnet";