tests-integration/Elastic.Extensions.Logging.IntegrationTests/LoggingToIndexTests.cs

using System;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Elastic.Channels.Diagnostics;
using Elastic.Clients.Elasticsearch;
using Elastic.CommonSchema;
using Elastic.Extensions.Logging.Options;
using FluentAssertions;
using Microsoft.Extensions.Logging;
using Xunit;
using Xunit.Abstractions;

namespace Elastic.Extensions.Logging.IntegrationTests
{
	public class LoggingToIndexTests : TestBase
	{
		public LoggingToIndexTests(LoggingCluster cluster, ITestOutputHelper output) : base(cluster, output) { }

		private IDisposable CreateLogger(
			out ILogger logger,
			out ElasticsearchLoggerProvider provider,
			out string @namespace,
			out WaitHandle waitHandle,
			out IChannelDiagnosticsListener listener
		) =>
			base.CreateLogger(out logger, out provider, out @namespace, out waitHandle, out listener, (o, s) =>
			{
				var pre = $"logs-{s}";
				o.Index = new IndexNameOptions { Format = $"{pre}-{{0:yyyy.MM.dd}}" };
				var nodes = Client.ElasticsearchClientSettings.NodePool.Nodes.Select(n => n.Uri).ToArray();
				o.ShipTo = new ShipToOptions { NodeUris = nodes, NodePoolType = NodePoolType.Static };
			});

		[Fact]
		public async Task LogsEndUpInCluster()
		{
			using var _ = CreateLogger(out var logger, out var provider, out var ns, out var waitHandle, out var listener);
			var indexPrefix = $"logs-{ns}";
			logger.LogError("an error occurred");

			if (!waitHandle.WaitOne(TimeSpan.FromSeconds(10)))
				throw new Exception($"No flush occurred in 10 seconds: {listener}", listener.ObservedException);

			listener.PublishSuccess.Should().BeTrue("{0}", listener);
			listener.ObservedException.Should().BeNull();

			await Client.Indices.RefreshAsync($"{indexPrefix}-*");

			var response = await Client.SearchAsync<LogEvent>(new SearchRequest($"{indexPrefix}-*"));

			response.IsValidResponse.Should().BeTrue("{0}", response.DebugInformation);
			response.Total.Should().BeGreaterThan(0);

			var loggedError = response.Documents.First();
			loggedError.Message.Should().Be("an error occurred");
			loggedError.Ecs.Version.Should().Be(EcsDocument.Version);
		}

		[Fact]
		public async Task SerializesAndDeserializesMessageTemplateAndScope()
		{
			using var _ = CreateLogger(out var logger, out var provider, out var ns, out var waitHandle, out var listener);
			using var scope = logger.BeginScope("custom scope");
			var indexPrefix = $"logs-{ns}";

			var userId = 1;
			logger.LogError("an error occurred for userId {UserId}", userId);

			if (!waitHandle.WaitOne(TimeSpan.FromSeconds(10)))
				throw new Exception($"No flush occurred in 10 seconds: {listener}", listener.ObservedException);

			listener.PublishSuccess.Should().BeTrue("{0}", listener);
			listener.ObservedException.Should().BeNull();

			await Client.Indices.RefreshAsync($"{indexPrefix}-*");

			var response = await Client.SearchAsync<LogEvent>(new SearchRequest($"{indexPrefix}-*"));

			response.IsValidResponse.Should().BeTrue("{0}", response.DebugInformation);
			response.Total.Should().BeGreaterThan(0);

			var loggedError = response.Documents.First();
			loggedError.Message.Should().Be("an error occurred for userId 1");
			loggedError.MessageTemplate.Should().Be("an error occurred for userId {UserId}");
			loggedError.Scopes.Should().ContainSingle(s => s == "custom scope");
		}
	}
}