Remove support for Elasticsearch v2 and v5. (#488)

* Remove support for Elasticsearch v2 and v5.

* Code-conventions: add rule for underscore `_` on private fields (as it already is in the code).

* Remove GitHub's `set-output` command deprication warning.

Co-authored-by: Nenad Vicentic <[email protected]>

Author: nenadvicentic

.editorconfig

@@ -6,3 +6,19 @@ indent_size = 4
 
 [*.csproj]
 indent_size = 2
+
+# Code files
+[*.{cs,csx,vb,vbx}]
+###############################
+# Naming Conventions          #
+###############################
+# Underscore for private fields
+dotnet_naming_rule.private_members_with_underscore.symbols  = private_fields
+dotnet_naming_rule.private_members_with_underscore.style    = prefix_underscore
+dotnet_naming_rule.private_members_with_underscore.severity = suggestion
+
+dotnet_naming_symbols.private_fields.applicable_kinds           = field
+dotnet_naming_symbols.private_fields.applicable_accessibilities = private
+
+dotnet_naming_style.prefix_underscore.capitalization = camel_case
+dotnet_naming_style.prefix_underscore.required_prefix = _

CHANGES.md

@@ -10,14 +10,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
  - PR #462
+ - PR #488
 
 ### Major Changes
 - `DetectElasticsearchVersion` is set to `true` by default.
 - When `DetectElasticsearchVersion` is set to `false` Elasticsearch version 7 is assumed (as it has broadest wire-compatibility at the moment - v7 and v8)
 - When `DetectElasticsearchVersion` is set to `true`, `TypeName` is handled automatically across different versions of Elasticserach (6.x to 8.x). For example, user-defined name will NOT be used on v7 and v8. Also, correct templates endpoint will be picked up.
 - Elasticsearch 8.x endpoint for templates is supported (`_index_template`)
 - Internal class `ElasticsearchVersionManager` has been added, mainly to handle situations where detection of version fails or when it is disabled. In the case of fallback, sink will assume "default" version 7.
-- Elasticsearch.NET client version 7.15.2 (latest version 7, until new `Elastic.Clients.Elasticsearch` 8.x catches up functional parity with 7.x)
+- Elasticsearch.NET client version 7.15.2 (latest version 7, until new `Elastic.Clients.Elasticsearch` 8.x catches up functional parity with 7.x).
+- Elasticsearch server versions 2 and 5 are no longer supported.
 
 ### Other Changes
 - Nuget pacakges have been updated (except for the Elasticsearch integration-tests related packages)

README.md

@@ -30,7 +30,7 @@ The Serilog Elasticsearch sink project is a sink (basically a writer) for the Se
 * Starting from version 3, compatible with Elasticsearch 2.
 * Version 6.x supports the new Elasticsearch.net version 6.x library.
 * From version 8.x there is support for Elasticsearch.net version 7.
-* From version 9.x there is support for Elasticsearch.net version 8. Version detection is enabled by default, in which case `TypeName` is handled automatically across major versions 6, 7 and 8.
+* From version 9.x there is support for Elasticsearch.net version 8. Version detection is enabled by default, in which case `TypeName` is handled automatically across major versions 6, 7 and 8. Versions 2 and 5 of Elasticsearch are no longer supported.
 
 
 ## Quick start

src/Serilog.Sinks.Elasticsearch/LoggerConfigurationElasticSearchExtensions.cs

@@ -102,7 +102,7 @@ public static LoggerConfiguration Elasticsearch(
         {
             return Elasticsearch(loggerSinkConfiguration, nodeUris, indexFormat, templateName, typeName, batchPostingLimit, period, inlineFields, restrictedToMinimumLevel, bufferBaseFilename,
                 bufferFileSizeLimitBytes, bufferLogShippingInterval, connectionGlobalHeaders, levelSwitch, 5, EmitEventFailureHandling.WriteToSelfLog, 100000, null, false,
-                AutoRegisterTemplateVersion.ESv2, false, RegisterTemplateRecovery.IndexAnyway, null, null, null);
+                AutoRegisterTemplateVersion.ESv7, false, RegisterTemplateRecovery.IndexAnyway, null, null, null);
         }
 
         /// <summary>

src/Serilog.Sinks.Elasticsearch/Sinks/ElasticSearch/ElasticSearchTemplateProvider.cs

@@ -9,14 +9,6 @@ namespace Serilog.Sinks.Elasticsearch
     /// </summary>
     public enum AutoRegisterTemplateVersion
     {
-        /// <summary>
-        /// Elasticsearch version &lt;= 2.4
-        /// </summary>
-        ESv2 = 0,
-        /// <summary>
-        /// Elasticsearch version &lt;= version 5.6
-        /// </summary>
-        ESv5 = 1,
         /// <summary>
         /// Elasticsearch version &gt;= version 6.0
         /// </summary>
@@ -40,7 +32,7 @@ public static object GetTemplate(ElasticsearchSinkOptions options,
             int discoveredMajorVersion,
             Dictionary<string, string> settings,
             string templateMatchString,
-            AutoRegisterTemplateVersion version = AutoRegisterTemplateVersion.ESv2)
+            AutoRegisterTemplateVersion version = AutoRegisterTemplateVersion.ESv7)
         {
             switch (version)
             {
@@ -50,10 +42,6 @@ public static object GetTemplate(ElasticsearchSinkOptions options,
                     return GetTemplateESv7(options, discoveredMajorVersion, settings, templateMatchString);
                 case AutoRegisterTemplateVersion.ESv6:
                     return GetTemplateESv6(options, discoveredMajorVersion, settings, templateMatchString);
-                case AutoRegisterTemplateVersion.ESv5:
-                    return GetTemplateESv5(settings, templateMatchString);
-                case AutoRegisterTemplateVersion.ESv2:
-                    return GetTemplateESv2(settings, templateMatchString);
                 default:
                     throw new ArgumentOutOfRangeException(nameof(version), version, null);
             }

src/Serilog.Sinks.Elasticsearch/Sinks/ElasticSearch/ElasticsearchSinkState.cs

@@ -251,8 +251,6 @@ private object GetTemplateData()
                     >= 8 => AutoRegisterTemplateVersion.ESv8,
                     7 => AutoRegisterTemplateVersion.ESv7,
                     6 => AutoRegisterTemplateVersion.ESv6,
-                    5 => AutoRegisterTemplateVersion.ESv5,
-                    2 => AutoRegisterTemplateVersion.ESv2,
                     _ => throw new NotSupportedException()
                 };
 

test/Serilog.Sinks.Elasticsearch.IntegrationTests/Serilog.Sinks.Elasticsearch.IntegrationTests.csproj

@@ -30,7 +30,7 @@
     <PackageReference Include="FluentAssertions" Version="6.9.0" />
     <PackageReference Include="NEST" Version="7.17.5" />
     <PackageReference Include="coverlet.msbuild" Version="3.2.0" PrivateAssets="all" />
-    <PackageReference Include="ReportGenerator" Version="5.1.13" />    
+    <PackageReference Include="ReportGenerator" Version="5.1.15" />    
   </ItemGroup>
 
   <ItemGroup Condition="$(ContinuousIntegrationBuild) == 'true'">
@@ -59,6 +59,6 @@
   </Target>
 
   <Target Name="PrintCoverageReportPathForGitHubActions" AfterTargets="GenerateCoverageResultAfterTest" Condition="$(ContinuousIntegrationBuild) == 'true'">
-    <Message Importance="high" Text="::set-output name=coverage-reports::@(CoverletReport, ',')" />
+    <Message Importance="high" Text="&quot;coverage-reports=@(CoverletReport, ',')&quot; >> $GITHUB_OUTPUT" />
   </Target>
 </Project>

test/Serilog.Sinks.Elasticsearch.Tests/Serilog.Sinks.Elasticsearch.Tests.csproj

@@ -28,7 +28,6 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <None Remove="Templating\template_v5.json" />
     <None Remove="Templating\template_v6.json" />
     <None Remove="Templating\template_v7.json" />
     <None Remove="Templating\template_v7_no-aliases.json" />
@@ -49,7 +48,6 @@
     <EmbeddedResource Include="Templating\template_v8.json" />
     <EmbeddedResource Include="Templating\template_v7.json" />
     <EmbeddedResource Include="Templating\template_v6.json" />
-    <EmbeddedResource Include="Templating\template_v5.json" />
   </ItemGroup>
 
   <ItemGroup>
@@ -71,7 +69,7 @@
     <PackageReference Include="Serilog.Enrichers.Environment" Version="2.2.0" />
     <PackageReference Include="FluentAssertions" Version="6.9.0" />
     <PackageReference Include="coverlet.msbuild" Version="3.2.0" PrivateAssets="all" />
-    <PackageReference Include="ReportGenerator" Version="5.1.13" />
+    <PackageReference Include="ReportGenerator" Version="5.1.15" />
 
   </ItemGroup>
 
@@ -105,7 +103,7 @@
   </Target>
 
   <Target Name="PrintCoverageReportPathForGitHubActions" AfterTargets="GenerateCoverageResultAfterTest" Condition="$(ContinuousIntegrationBuild) == 'true'">
-    <Message Importance="high" Text="::set-output name=coverage-reports::@(CoverletReport, ',')" />
+    <Message Importance="high" Text="&quot;coverage-reports=@(CoverletReport, ',')&quot; >> $GITHUB_OUTPUT" />
   </Target>
 
   <ItemGroup>