Merge pull request #5918 from crobibero/client-logger

Add endpoint to log client events

MediaBrowser.Controller/ClientEvent/ClientEventLogger.cs

@@ -0,0 +1,55 @@
+using System;
+using System.IO;
+using System.Threading.Tasks;
+using MediaBrowser.Model.ClientLog;
+using Microsoft.Extensions.Logging;
+
+namespace MediaBrowser.Controller.ClientEvent
+{
+    /// <inheritdoc />
+    public class ClientEventLogger : IClientEventLogger
+    {
+        private const string LogString = "[{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz}] [{Level}] [{ClientName}:{ClientVersion}]: UserId: {UserId} DeviceId: {DeviceId}{NewLine}{Message}";
+        private readonly ILogger<ClientEventLogger> _logger;
+        private readonly IServerApplicationPaths _applicationPaths;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ClientEventLogger"/> class.
+        /// </summary>
+        /// <param name="logger">Instance of the <see cref="ILogger{ClientEventLogger}"/> interface.</param>
+        /// <param name="applicationPaths">Instance of the <see cref="IServerApplicationPaths"/> interface.</param>
+        public ClientEventLogger(
+            ILogger<ClientEventLogger> logger,
+            IServerApplicationPaths applicationPaths)
+        {
+            _logger = logger;
+            _applicationPaths = applicationPaths;
+        }
+
+        /// <inheritdoc />
+        public void Log(ClientLogEvent clientLogEvent)
+        {
+            _logger.Log(
+                LogLevel.Critical,
+                LogString,
+                clientLogEvent.Timestamp,
+                clientLogEvent.Level.ToString(),
+                clientLogEvent.ClientName,
+                clientLogEvent.ClientVersion,
+                clientLogEvent.UserId ?? Guid.Empty,
+                clientLogEvent.DeviceId,
+                Environment.NewLine,
+                clientLogEvent.Message);
+        }
+
+        /// <inheritdoc />
+        public async Task<string> WriteDocumentAsync(string clientName, string clientVersion, Stream fileContents)
+        {
+            var fileName = $"upload_{clientName}_{clientVersion}_{DateTime.UtcNow:yyyyMMddHHmmss}_{Guid.NewGuid():N}.log";
+            var logFilePath = Path.Combine(_applicationPaths.LogDirectoryPath, fileName);
+            await using var fileStream = new FileStream(logFilePath, FileMode.CreateNew, FileAccess.Write, FileShare.None);
+            await fileContents.CopyToAsync(fileStream).ConfigureAwait(false);
+            return fileName;
+        }
+    }
+}

MediaBrowser.Controller/ClientEvent/IClientEventLogger.cs

@@ -0,0 +1,31 @@
+using System.IO;
+using System.Threading.Tasks;
+using MediaBrowser.Controller.Net;
+using MediaBrowser.Model.ClientLog;
+
+namespace MediaBrowser.Controller.ClientEvent
+{
+    /// <summary>
+    /// The client event logger.
+    /// </summary>
+    public interface IClientEventLogger
+    {
+        /// <summary>
+        /// Logs the event from the client.
+        /// </summary>
+        /// <param name="clientLogEvent">The client log event.</param>
+        void Log(ClientLogEvent clientLogEvent);
+
+        /// <summary>
+        /// Writes a file to the log directory.
+        /// </summary>
+        /// <param name="clientName">The client name writing the document.</param>
+        /// <param name="clientVersion">The client version writing the document.</param>
+        /// <param name="fileContents">The file contents to write.</param>
+        /// <returns>The created file name.</returns>
+        Task<string> WriteDocumentAsync(
+            string clientName,
+            string clientVersion,
+            Stream fileContents);
+    }
+}