Use apikey to access elastic search (#545)

* Update ElasticsearchSinkOptions.cs * Update ElasticsearchSinkState.cs Use apikey to access elasticsearch * Update ElasticsearchSinkOptions.cs * Update Elasticsearch6XUsing7X.cs for integration test * Update Elasticsearch7XUsing6X.cs For integration test
serilog-contrib · Jun 14, 2023 · 0763a17 · 0763a17
1 parent 2182854
commit 0763a17
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 2 deletions.
diff --git a/src/Serilog.Sinks.Elasticsearch/Sinks/ElasticSearch/ElasticsearchSinkOptions.cs b/src/Serilog.Sinks.Elasticsearch/Sinks/ElasticSearch/ElasticsearchSinkOptions.cs
@@ -281,6 +281,15 @@ public int QueueSizeLimit
         /// </summary>
         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
+        /// </summary>
+        public string Apikey { get; set; }
+
         /// <summary>
         /// Configures the elasticsearch sink defaults
         /// </summary>

diff --git a/src/Serilog.Sinks.Elasticsearch/Sinks/ElasticSearch/ElasticsearchSinkState.cs b/src/Serilog.Sinks.Elasticsearch/Sinks/ElasticSearch/ElasticsearchSinkState.cs
@@ -86,6 +86,9 @@ private ElasticsearchSinkState(ElasticsearchSinkOptions options)
             if (options.ModifyConnectionSettings != null)
                 configuration = options.ModifyConnectionSettings(configuration);
 
+            if (!string.IsNullOrEmpty(options.Apikey))
+                configuration = configuration.ApiKeyAuthentication(new ApiKeyAuthenticationCredentials(options.Apikey));
+
             configuration.ThrowExceptions();
 
             _client = new ElasticLowLevelClient(configuration);

diff --git a/test/Serilog.Sinks.Elasticsearch.IntegrationTests/Elasticsearch6/Elasticsearch6XUsing7X.cs b/test/Serilog.Sinks.Elasticsearch.IntegrationTests/Elasticsearch6/Elasticsearch6XUsing7X.cs
@@ -54,6 +54,7 @@ public SetupSerilog()
                             o.DetectElasticsearchVersion = true;
                             o.AutoRegisterTemplateVersion = AutoRegisterTemplateVersion.ESv7;
                             o.AutoRegisterTemplate = true;
+                            o.ApiKey = "aWQ6d3d3ZGRkZGRkZGRkZA==";
                         })
                     );
                 var logger = loggerConfig.CreateLogger();
@@ -68,4 +69,4 @@ public SetupSerilog()
             }
         }
     }
-}
+}
diff --git a/test/Serilog.Sinks.Elasticsearch.IntegrationTests/Elasticsearch7/Elasticsearch7XUsing6X.cs b/test/Serilog.Sinks.Elasticsearch.IntegrationTests/Elasticsearch7/Elasticsearch7XUsing6X.cs
@@ -51,6 +51,7 @@ public SetupSerilog()
                             o.DetectElasticsearchVersion = true;
                             o.AutoRegisterTemplateVersion = AutoRegisterTemplateVersion.ESv6;
                             o.AutoRegisterTemplate = true;
+                            o.ApiKey = "aWQ6d3d3ZGRkZGRkZGRkZA==";
                         })
                     );
                 using (var logger = loggerConfig.CreateLogger())
@@ -65,4 +66,4 @@ public SetupSerilog()
         }
 
     }
-}
+}