Prepare for release

Author: mivano

CHANGES.md

@@ -4,12 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [9.0.2]
+
+- Add support for API Keys by @qgbo in #545
+
 ## [9.0.1]
 
 - fixes: v9.0.0 fails template creation with ES v7 with ElasticsearchCl… by @nenadvicentic in #533
 
-## [Unreleased]
-
 ## [9.0.0] - 2023-01-23
 
 ### Added

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

@@ -282,13 +282,17 @@ public int QueueSizeLimit
         public RollingInterval BufferFileRollingInterval { get; set; }
 
         /// <summary>
-        /// Apikey to access elasticsearch, the value is encoded
-        /// If your elasticsearch can be accessed using user and password, you access via url like this: http://user:password@localhost
-        /// For another choice, you can using a apiKey, which can be created in kibana:    POST /security/api_key { "name": "aaa-apikeys", "role_descriptors": { "abc-shared-application": { "cluster": [ "all" ], "index": [ { "names": [ "abc_share*" ], "privileges": [ "all" ] } ] } } }
-        /// then you can get the apikey coded by base64 it like this: aFlBbDVvY0JOblduWHdpZnNLOUk6cEt2Y01tYVlRQ3FsWlF0MVVjRkN034==
-        /// For more detail about apiKey, see: https://www.elastic.co/guide/en/apm/server/7.15/api-key.html
+        /// Specify the Api key used to access elasticsearch, the value needs to be encoded.
+        /// If your elasticsearch instance can be accessed using a username and password,
+        /// you access it via url like this: http://user:password@localhost
+        /// 
+        /// Alternatively, you can using API key, which can be created in kibana:
+        /// POST /security/api_key { "name": "aaa-apikeys", "role_descriptors": { "abc-shared-application": { "cluster": [ "all" ], "index": [ { "names": [ "abc_share*" ], "privileges": [ "all" ] } ] } } }
+        ///
+        /// Afterwards, you can get the apikey and code it using base64 like this: aFlBbDVvY0JOblduWHdpZnNLOUk6cEt2Y01tYVlRQ3FsWlF0MVVjRkN034==
+        /// For more details about using the  apiKey, see: https://www.elastic.co/guide/en/apm/server/7.15/api-key.html
         /// </summary>
-        public string Apikey { get; set; }
+        public string ApiKey { get; set; }
 
         /// <summary>
         /// Configures the elasticsearch sink defaults

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

@@ -86,8 +86,8 @@ private ElasticsearchSinkState(ElasticsearchSinkOptions options)
             if (options.ModifyConnectionSettings != null)
                 configuration = options.ModifyConnectionSettings(configuration);
 
-            if (!string.IsNullOrEmpty(options.Apikey))
-                configuration = configuration.ApiKeyAuthentication(new ApiKeyAuthenticationCredentials(options.Apikey));
+            if (!string.IsNullOrEmpty(options.ApiKey))
+                configuration = configuration.ApiKeyAuthentication(new ApiKeyAuthenticationCredentials(options.ApiKey));
 
             configuration.ThrowExceptions();