Merge branch 'dev'

CHANGES.md

@@ -1,5 +1,8 @@
 == Changelog
 
+6.2
+ * Extra overload added to support more settings via AppSettings reader. (#150)
+
 6.1
  * Updated to elasticsearch 6 libraries (#153)
  * Fix field index option for 6.1+ template to use boolean value. (#148)

GitVersion.yml

@@ -1,4 +1,4 @@
-next-version: 6.0.0
+next-version: 6.2.0
 branches: {}
 ignore:
   sha: []

src/Serilog.Sinks.Elasticsearch/LoggerConfigurationElasticSearchExtensions.cs

@@ -21,6 +21,7 @@
 using Serilog.Events;
 using Serilog.Sinks.Elasticsearch;
 using System.Collections.Specialized;
+using System.ComponentModel;
 
 namespace Serilog
 {
@@ -62,6 +63,45 @@ public static LoggerConfiguration Elasticsearch(
             );
         }
 
+        /// <summary>
+        /// Overload to allow basic configuration through AppSettings.
+        /// </summary>
+        /// <param name="loggerSinkConfiguration">Options for the sink.</param>
+        /// <param name="nodeUris">A comma or semi column separated list of URIs for Elasticsearch nodes.</param>
+        /// <param name="indexFormat"><see cref="ElasticsearchSinkOptions.IndexFormat"/></param>
+        /// <param name="templateName"><see cref="ElasticsearchSinkOptions.TemplateName"/></param>
+        /// <param name="typeName"><see cref="ElasticsearchSinkOptions.TypeName"/></param>
+        /// <param name="batchPostingLimit"><see cref="ElasticsearchSinkOptions.BatchPostingLimit"/></param>
+        /// <param name="period"><see cref="ElasticsearchSinkOptions.Period"/></param>
+        /// <param name="inlineFields"><see cref="ElasticsearchSinkOptions.InlineFields"/></param>
+        /// <param name="restrictedToMinimumLevel">The minimum log event level required in order to write an event to the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
+        /// <param name="levelSwitch">A switch allowing the pass-through minimum level to be changed at runtime.</param>
+        /// <param name="bufferBaseFilename"><see cref="ElasticsearchSinkOptions.BufferBaseFilename"/></param>
+        /// <param name="bufferFileSizeLimitBytes"><see cref="ElasticsearchSinkOptions.BufferFileSizeLimitBytes"/></param>
+        /// <param name="bufferLogShippingInterval"><see cref="ElasticsearchSinkOptions.BufferLogShippingInterval"/></param>
+        /// <param name="connectionGlobalHeaders">A comma or semi column separated list of key value pairs of headers to be added to each elastic http request</param>
+        [Obsolete("New code should not be compiled against this obsolete overload"), EditorBrowsable(EditorBrowsableState.Never)]
+        public static LoggerConfiguration Elasticsearch(
+           this LoggerSinkConfiguration loggerSinkConfiguration,
+           string nodeUris,
+           string indexFormat,
+           string templateName,
+           string typeName,
+           int batchPostingLimit,
+           int period,
+           bool inlineFields,
+           LogEventLevel restrictedToMinimumLevel,
+           string bufferBaseFilename,
+           long? bufferFileSizeLimitBytes,
+           long bufferLogShippingInterval,
+           string connectionGlobalHeaders,
+           LoggingLevelSwitch levelSwitch)
+        {
+            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);
+        }
+
         /// <summary>
         /// Overload to allow basic configuration through AppSettings.
         /// </summary>
@@ -79,6 +119,17 @@ public static LoggerConfiguration Elasticsearch(
         /// <param name="bufferFileSizeLimitBytes"><see cref="ElasticsearchSinkOptions.BufferFileSizeLimitBytes"/></param>
         /// <param name="bufferLogShippingInterval"><see cref="ElasticsearchSinkOptions.BufferLogShippingInterval"/></param>
         /// <param name="connectionGlobalHeaders">A comma or semi column separated list of key value pairs of headers to be added to each elastic http request</param>   
+        /// <param name="connectionTimeout"><see cref="ElasticsearchSinkOptions.ConnectionTimeout"/>The connection timeout (in seconds) when sending bulk operations to elasticsearch (defaults to 5).</param>   
+        /// <param name="emitEventFailure"><see cref="ElasticsearchSinkOptions.EmitEventFailure"/>Specifies how failing emits should be handled.</param>  
+        /// <param name="queueSizeLimit"><see cref="ElasticsearchSinkOptions.QueueSizeLimit"/>The maximum number of events that will be held in-memory while waiting to ship them to Elasticsearch. Beyond this limit, events will be dropped. The default is 100,000. Has no effect on durable log shipping.</param>   
+        /// <param name="pipelineName"><see cref="ElasticsearchSinkOptions.PipelineName"/>Name the Pipeline where log events are sent to sink. Please note that the Pipeline should be existing before the usage starts.</param>   
+        /// <param name="autoRegisterTemplate"><see cref="ElasticsearchSinkOptions.AutoRegisterTemplate"/>When set to true the sink will register an index template for the logs in elasticsearch.</param>   
+        /// <param name="autoRegisterTemplateVersion"><see cref="ElasticsearchSinkOptions.AutoRegisterTemplateVersion"/>When using the AutoRegisterTemplate feature, this allows to set the Elasticsearch version. Depending on the version, a template will be selected. Defaults to pre 5.0.</param>  
+        /// <param name="overwriteTemplate"><see cref="ElasticsearchSinkOptions.OverwriteTemplate"/>When using the AutoRegisterTemplate feature, this allows you to overwrite the template in Elasticsearch if it already exists. Defaults to false</param>   
+        /// <param name="registerTemplateFailure"><see cref="ElasticsearchSinkOptions.RegisterTemplateFailure"/>Specifies the option on how to handle failures when writing the template to Elasticsearch. This is only applicable when using the AutoRegisterTemplate option.</param>  
+        /// <param name="deadLetterIndexName"><see cref="ElasticsearchSinkOptions.DeadLetterIndexName"/>Optionally set this value to the name of the index that should be used when the template cannot be written to ES.</param>  
+        /// <param name="numberOfShards"><see cref="ElasticsearchSinkOptions.NumberOfShards"/>The default number of shards.</param>   
+        /// <param name="numberOfReplicas"><see cref="ElasticsearchSinkOptions.NumberOfReplicas"/>The default number of replicas.</param>   
         /// <returns>LoggerConfiguration object</returns>
         /// <exception cref="ArgumentNullException"><paramref name="nodeUris"/> is <see langword="null" />.</exception>
         public static LoggerConfiguration Elasticsearch(
@@ -95,10 +146,21 @@ public static LoggerConfiguration Elasticsearch(
             long? bufferFileSizeLimitBytes = null,
             long bufferLogShippingInterval = 5000,
             string connectionGlobalHeaders = null,
-            LoggingLevelSwitch levelSwitch = null)
+            LoggingLevelSwitch levelSwitch = null,
+            int connectionTimeout = 5,
+            EmitEventFailureHandling emitEventFailure = EmitEventFailureHandling.WriteToSelfLog,
+            int queueSizeLimit = 100000,
+            string pipelineName = null,
+            bool autoRegisterTemplate = false,
+            AutoRegisterTemplateVersion autoRegisterTemplateVersion = AutoRegisterTemplateVersion.ESv2,
+            bool overwriteTemplate = false,
+            RegisterTemplateRecovery registerTemplateFailure = RegisterTemplateRecovery.IndexAnyway,
+            string deadLetterIndexName = null,
+            int? numberOfShards = null,
+            int? numberOfReplicas = null)
         {
             if (string.IsNullOrEmpty(nodeUris))
-                throw new ArgumentNullException("nodeUris", "No Elasticsearch node(s) specified.");
+                throw new ArgumentNullException(nameof(nodeUris), "No Elasticsearch node(s) specified.");
 
             IEnumerable<Uri> nodes = nodeUris
                 .Split(new[] { ',', ';' }, StringSplitOptions.RemoveEmptyEntries)
@@ -156,6 +218,23 @@ public static LoggerConfiguration Elasticsearch(
                 options.ModifyConnectionSettings = (c) => c.GlobalHeaders(headers);
             }
 
+            options.ConnectionTimeout = TimeSpan.FromSeconds(connectionTimeout);
+            options.EmitEventFailure = emitEventFailure;
+            options.QueueSizeLimit = queueSizeLimit;
+            options.PipelineName = pipelineName;
+
+            options.AutoRegisterTemplate = autoRegisterTemplate;
+            options.AutoRegisterTemplateVersion = autoRegisterTemplateVersion;
+            options.RegisterTemplateFailure = registerTemplateFailure;
+            options.OverwriteTemplate = overwriteTemplate;
+            options.NumberOfShards = numberOfShards;
+            options.NumberOfReplicas = numberOfReplicas;
+
+            if (!string.IsNullOrWhiteSpace(deadLetterIndexName))
+            {
+                options.DeadLetterIndexName = deadLetterIndexName;
+            }
+
             return Elasticsearch(loggerSinkConfiguration, options);
         }
     }