[PM-6167] Remove cosmos logging sink (#3769)

* get rid of cosmos logging sink

* remove logs from layout

* delete log models

* remove logs_view permission

---------

Co-authored-by: Matt Bishop <mbishop@bitwarden.com>

src/Admin/Admin.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
     <UserSecretsId>bitwarden-Admin</UserSecretsId>
@@ -24,8 +24,4 @@
     </When>
   </Choose>
 
-  <ItemGroup>
-    <PackageReference Include="Microsoft.Azure.Cosmos" Version="3.26.1" />
-  </ItemGroup>
-
 </Project>

src/Admin/Controllers/LogsController.cs

@@ -1,94 +0,0 @@
-using Bit.Admin.Models;
-using Bit.Admin.Utilities;
-using Bit.Core.Settings;
-using Bit.Core.Utilities;
-using Microsoft.AspNetCore.Authorization;
-using Microsoft.AspNetCore.Mvc;
-using Microsoft.Azure.Cosmos;
-using Microsoft.Azure.Cosmos.Linq;
-using Serilog.Events;
-
-namespace Bit.Admin.Controllers;
-
-[Authorize]
-[SelfHosted(NotSelfHostedOnly = true)]
-[RequirePermission(Enums.Permission.Logs_View)]
-public class LogsController : Controller
-{
-    private const string Database = "Diagnostics";
-    private const string Container = "Logs";
-
-    private readonly GlobalSettings _globalSettings;
-
-    public LogsController(GlobalSettings globalSettings)
-    {
-        _globalSettings = globalSettings;
-    }
-
-    public async Task<IActionResult> Index(string cursor = null, int count = 50,
-        LogEventLevel? level = null, string project = null, DateTime? start = null, DateTime? end = null)
-    {
-        using (var client = new CosmosClient(_globalSettings.DocumentDb.Uri,
-            _globalSettings.DocumentDb.Key))
-        {
-            var cosmosContainer = client.GetContainer(Database, Container);
-            var query = cosmosContainer.GetItemLinqQueryable<LogModel>(
-                requestOptions: new QueryRequestOptions()
-                {
-                    MaxItemCount = count
-                },
-                continuationToken: cursor
-            ).AsQueryable();
-
-            if (level.HasValue)
-            {
-                query = query.Where(l => l.Level == level.Value.ToString());
-            }
-            if (!string.IsNullOrWhiteSpace(project))
-            {
-                query = query.Where(l => l.Properties != null && l.Properties["Project"] == (object)project);
-            }
-            if (start.HasValue)
-            {
-                query = query.Where(l => l.Timestamp >= start.Value);
-            }
-            if (end.HasValue)
-            {
-                query = query.Where(l => l.Timestamp <= end.Value);
-            }
-            var feedIterator = query.OrderByDescending(l => l.Timestamp).ToFeedIterator();
-            var response = await feedIterator.ReadNextAsync();
-
-            return View(new LogsModel
-            {
-                Level = level,
-                Project = project,
-                Start = start,
-                End = end,
-                Items = response.ToList(),
-                Count = count,
-                Cursor = cursor,
-                NextCursor = response.ContinuationToken
-            });
-        }
-    }
-
-    public async Task<IActionResult> View(Guid id)
-    {
-        using (var client = new CosmosClient(_globalSettings.DocumentDb.Uri,
-            _globalSettings.DocumentDb.Key))
-        {
-            var cosmosContainer = client.GetContainer(Database, Container);
-            var query = cosmosContainer.GetItemLinqQueryable<LogDetailsModel>()
-                .AsQueryable()
-                .Where(l => l.Id == id.ToString());
-
-            var response = await query.ToFeedIterator().ReadNextAsync();
-            if (response == null || response.Count == 0)
-            {
-                return RedirectToAction("Index");
-            }
-            return View(response.First());
-        }
-    }
-}

src/Admin/Enums/Permissions.cs

@@ -47,7 +47,5 @@ public enum Permission
     Tools_GenerateLicenseFile,
     Tools_ManageTaxRates,
     Tools_ManageStripeSubscriptions,
-    Tools_CreateEditTransaction,
-
-    Logs_View
+    Tools_CreateEditTransaction
 }

src/Admin/Models/LogModel.cs

@@ -1,54 +0,0 @@
-using Microsoft.Azure.Documents;
-using Newtonsoft.Json.Linq;
-
-namespace Bit.Admin.Models;
-
-public class LogModel : Resource
-{
-    public long EventIdHash { get; set; }
-    public string Level { get; set; }
-    public string Message { get; set; }
-    public string MessageTruncated => Message.Length > 200 ? $"{Message.Substring(0, 200)}..." : Message;
-    public string MessageTemplate { get; set; }
-    public IDictionary<string, object> Properties { get; set; }
-    public string Project => Properties?.ContainsKey("Project") ?? false ? Properties["Project"].ToString() : null;
-}
-
-public class LogDetailsModel : LogModel
-{
-    public JObject Exception { get; set; }
-
-    public string ExceptionToString(JObject e)
-    {
-        if (e == null)
-        {
-            return null;
-        }
-
-        var val = string.Empty;
-        if (e["Message"] != null && e["Message"].ToObject<string>() != null)
-        {
-            val += "Message:\n";
-            val += e["Message"] + "\n";
-        }
-
-        if (e["StackTrace"] != null && e["StackTrace"].ToObject<string>() != null)
-        {
-            val += "\nStack Trace:\n";
-            val += e["StackTrace"];
-        }
-        else if (e["StackTraceString"] != null && e["StackTraceString"].ToObject<string>() != null)
-        {
-            val += "\nStack Trace String:\n";
-            val += e["StackTraceString"];
-        }
-
-        if (e["InnerException"] != null && e["InnerException"].ToObject<JObject>() != null)
-        {
-            val += "\n\n=== Inner Exception ===\n\n";
-            val += ExceptionToString(e["InnerException"].ToObject<JObject>());
-        }
-
-        return val;
-    }
-}

src/Admin/Models/LogsModel.cs

@@ -1,11 +0,0 @@
-using Serilog.Events;
-
-namespace Bit.Admin.Models;
-
-public class LogsModel : CursorPagedModel<LogModel>
-{
-    public LogEventLevel? Level { get; set; }
-    public string Project { get; set; }
-    public DateTime? Start { get; set; }
-    public DateTime? End { get; set; }
-}

src/Admin/Utilities/RolePermissionMapping.cs

@@ -47,8 +47,7 @@ public static class RolePermissionMapping
                 Permission.Tools_PromoteAdmin,
                 Permission.Tools_GenerateLicenseFile,
                 Permission.Tools_ManageTaxRates,
-                Permission.Tools_ManageStripeSubscriptions,
-                Permission.Logs_View
+                Permission.Tools_ManageStripeSubscriptions
             }
         },
         { "admin", new List<Permission>
@@ -94,8 +93,7 @@ public static class RolePermissionMapping
                 Permission.Tools_GenerateLicenseFile,
                 Permission.Tools_ManageTaxRates,
                 Permission.Tools_ManageStripeSubscriptions,
-                Permission.Tools_CreateEditTransaction,
-                Permission.Logs_View
+                Permission.Tools_CreateEditTransaction
             }
         },
         { "cs", new List<Permission>
@@ -123,8 +121,7 @@ public static class RolePermissionMapping
                 Permission.Org_Billing_View,
                 Permission.Org_Billing_LaunchGateway,
                 Permission.Provider_List_View,
-                Permission.Provider_View,
-                Permission.Logs_View
+                Permission.Provider_View
             }
         },
         { "billing", new List<Permission>
@@ -163,8 +160,7 @@ public static class RolePermissionMapping
                 Permission.Tools_GenerateLicenseFile,
                 Permission.Tools_ManageTaxRates,
                 Permission.Tools_ManageStripeSubscriptions,
-                Permission.Tools_CreateEditTransaction,
-                Permission.Logs_View
+                Permission.Tools_CreateEditTransaction
             }
         },
         { "sales", new List<Permission>
@@ -193,8 +189,7 @@ public static class RolePermissionMapping
                 Permission.Provider_Create,
                 Permission.Provider_Edit,
                 Permission.Provider_View,
-                Permission.Provider_ResendEmailInvite,
-                Permission.Logs_View
+                Permission.Provider_ResendEmailInvite
             }
         },
     };

src/Admin/Views/Logs/Index.cshtml

@@ -1,91 +0,0 @@
-@model LogsModel
-@{
-    ViewData["Title"] = "Logs";
-}
-
-<h1>Logs</h1>
-
-<p>Current UTC time: @DateTime.UtcNow.ToString()</p>
-
-<form class="form-inline mb-2" method="get">
-    <label class="sr-only" asp-for="Level">Level</label>
-    <select class="form-control mb-2 mr-2" asp-for="Level" name="level"
-            asp-items="Html.GetEnumSelectList<Serilog.Events.LogEventLevel>()">
-        <option value="">-- Level --</option>
-    </select>
-    <label class="sr-only" asp-for="Project">Project</label>
-    <select class="form-control mb-2 mr-2" asp-for="Project" name="project">
-        <option asp-selected="string.IsNullOrWhiteSpace(Model.Project)" value="">-- Project --</option>
-        <option asp-selected="@(Model.Project == "Admin")" value="Admin">Admin</option>
-        <option asp-selected="@(Model.Project == "Api")" value="Api">Api</option>
-        <option asp-selected="@(Model.Project == "Billing")" value="Billing">Billing</option>
-        <option asp-selected="@(Model.Project == "Events")" value="Events">Events</option>
-        <option asp-selected="@(Model.Project == "Events Processor")" value="Events Processor">Events Processor</option>
-        <option asp-selected="@(Model.Project == "Identity")" value="Identity">Identity</option>
-        <option asp-selected="@(Model.Project == "Notifications")" value="Notifications">Notifications</option>
-        <option asp-selected="@(Model.Project == "Icons")" value="Icons">Icons</option>
-        <option asp-selected="@(Model.Project == "SSO")" value="SSO">SSO</option>
-        <option asp-selected="@(Model.Project == "Scim")" value="Scim">SCIM</option>
-    </select>
-    <input class="form-control mb-2 mr-2" type="datetime-local" asp-for="Start" name="start" placeholder="Start Date">
-    <input class="form-control mb-2 mr-2" type="datetime-local" asp-for="End" name="end" placeholder="End Date">
-    <button type="submit" class="btn btn-primary mb-2" title="Search"><i class="fa fa-search"></i> Search</button>
-</form>
-
-<div class="table-responsive">
-    <table class="table table-striped table-hover">
-        <thead>
-            <tr>
-                <th style="width: 50px;">&nbsp;</th>
-                <th style="width: 210px;">Timestamp</th>
-                <th style="width: 105px;">Project</th>
-                <th style="width: 125px;">Level</th>
-                <th>Message</th>
-            </tr>
-        </thead>
-        <tbody>
-            @if(!Model.Items.Any())
-            {
-                <tr>
-                    <td colspan="5">No results to list.</td>
-                </tr>
-            }
-            else
-            {
-                @foreach(var log in Model.Items)
-                {
-                    <tr>
-                        <td>
-                            <a asp-action="View" asp-route-id="@log.Id" title="View">
-                                <i class="fa fa-file-text-o fa-lg"></i>
-                            </a>
-                        </td>
-                        <td>@log.Timestamp.ToString()</td>
-                        <td>@(string.IsNullOrWhiteSpace(log.Project) ? "-" : log.Project)</td>
-                        <td>@log.Level</td>
-                        <td>@log.MessageTruncated</td>
-                    </tr>
-                }
-            }
-        </tbody>
-    </table>
-</div>
-
-<nav>
-    <ul class="pagination">
-        @if(string.IsNullOrWhiteSpace(Model.NextCursor))
-        {
-            <li class="page-item disabled">
-                <a class="page-link" href="#" tabindex="-1">Next</a>
-            </li>
-        }
-        else
-        {
-            <li class="page-item">
-                <a class="page-link" asp-action="Index" asp-route-cursor="@Model.NextCursor"
-                   asp-route-count="@Model.Count" asp-route-project="@Model.Project"
-                   asp-route-level="@Model.Level">Next</a>
-            </li>
-        }
-    </ul>
-</nav>

src/Admin/Views/Logs/View.cshtml

@@ -1,42 +0,0 @@
-@model LogDetailsModel
-@{
-    ViewData["Title"] = "Log: " + Model.Id;
-}
-
-<h1>Log <small>@Model.Id</small></h1>
-
-<h2>Information</h2>
-<dl class="row">
-    <dt class="col-sm-4 col-lg-3">Id</dt>
-    <dd class="col-sm-8 col-lg-9"><code>@Model.Id</code></dd>
-
-    <dt class="col-sm-4 col-lg-3">Event Id Hash</dt>
-    <dd class="col-sm-8 col-lg-9">@Model.EventIdHash</dd>
-
-    <dt class="col-sm-4 col-lg-3">Timestamp</dt>
-    <dd class="col-sm-8 col-lg-9">@Model.Timestamp.ToString()</dd>
-
-    <dt class="col-sm-4 col-lg-3">Level</dt>
-    <dd class="col-sm-8 col-lg-9">@Model.Level</dd>
-</dl>
-
-<h2>Message</h2>
-<pre style="max-height: 500px;">@Model.Message</pre>
-
-@if(Model.Exception != null)
-{
-    <h2>Exception</h2>
-    <pre style="max-height: 500px;">@Model.ExceptionToString(Model.Exception)</pre>
-}
-
-@if(Model.Properties != null && Model.Properties.Count > 0)
-{
-    <h2>Properties</h2>
-    <dl class="row">
-        @foreach(var prop in Model.Properties)
-        {
-            <dt class="col-sm-4 col-lg-3">@prop.Key</dt>
-            <dd class="col-sm-8 col-lg-9">@(prop.Value?.ToString() ?? "-")</dd>
-        }
-    </dl>
-}

src/Admin/Views/Shared/_Layout.cshtml

@@ -1,4 +1,4 @@
-@using Bit.Admin.Enums;
+@using Bit.Admin.Enums;
 
 @inject SignInManager<IdentityUser> SignInManager
 @inject Bit.Core.Settings.GlobalSettings GlobalSettings
@@ -8,7 +8,6 @@
     var canViewUsers = AccessControlService.UserHasPermission(Permission.User_List_View);
     var canViewOrgs = AccessControlService.UserHasPermission(Permission.Org_List_View);
     var canViewProviders = AccessControlService.UserHasPermission(Permission.Provider_List_View);
-    var canViewLogs = AccessControlService.UserHasPermission(Permission.Logs_View);
     var canChargeBraintree = AccessControlService.UserHasPermission(Permission.Tools_ChargeBrainTreeCustomer);
     var canCreateTransaction = AccessControlService.UserHasPermission(Permission.Tools_CreateEditTransaction);
     var canPromoteAdmin = AccessControlService.UserHasPermission(Permission.Tools_PromoteAdmin);
@@ -121,12 +120,6 @@
                                     </div>
                                 </li>
                             }
-                            @if (canViewLogs)
-                            {
-                                <li class="nav-item" active-controller="Logs">
-                                    <a class="nav-link" asp-controller="Logs" asp-action="Index">Logs</a>
-                                </li>
-                            }
                         }
                     }
                     @if (GlobalSettings.SelfHosted)

src/Core/Core.csproj

@@ -34,6 +34,7 @@
     <PackageReference Include="Handlebars.Net" Version="2.1.4" />
     <PackageReference Include="MailKit" Version="4.3.0" />
     <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="6.0.25" />
+    <PackageReference Include="Microsoft.Azure.Cosmos" Version="3.38.0" />
     <PackageReference Include="Microsoft.Azure.Cosmos.Table" Version="1.0.8" />
     <PackageReference Include="Microsoft.Azure.NotificationHubs" Version="4.1.0" />
     <PackageReference Include="Microsoft.Data.SqlClient" Version="5.1.5" />
@@ -48,7 +49,6 @@
     <PackageReference Include="Sentry.Serilog" Version="3.41.3" />
     <PackageReference Include="Duende.IdentityServer" Version="6.3.7" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
-    <PackageReference Include="Serilog.Sinks.AzureCosmosDB" Version="2.0.0" />
     <PackageReference Include="Serilog.Sinks.SyslogMessages" Version="2.0.9" />
     <PackageReference Include="AspNetCoreRateLimit" Version="5.0.0" />
     <PackageReference Include="Braintree" Version="5.23.0" />

src/Core/Settings/GlobalSettings.cs

@@ -61,7 +61,6 @@ public class GlobalSettings : IGlobalSettings
     public virtual FileStorageSettings Send { get; set; }
     public virtual IdentityServerSettings IdentityServer { get; set; } = new IdentityServerSettings();
     public virtual DataProtectionSettings DataProtection { get; set; }
-    public virtual DocumentDbSettings DocumentDb { get; set; } = new DocumentDbSettings();
     public virtual SentrySettings Sentry { get; set; } = new SentrySettings();
     public virtual SyslogSettings Syslog { get; set; } = new SyslogSettings();
     public virtual ILogLevelSettings MinLogLevel { get; set; } = new LogLevelSettings();
@@ -351,12 +350,6 @@ public class GlobalSettings : IGlobalSettings
         }
     }
 
-    public class DocumentDbSettings
-    {
-        public string Uri { get; set; }
-        public string Key { get; set; }
-    }
-
     public class SentrySettings
     {
         public string Dsn { get; set; }

src/Core/Utilities/LoggerFactoryExtensions.cs

@@ -60,16 +60,7 @@ public static class LoggerFactoryExtensions
             .Enrich.FromLogContext()
             .Filter.ByIncludingOnly(inclusionPredicate);
 
-        if (CoreHelpers.SettingHasValue(globalSettings?.DocumentDb.Uri) &&
-            CoreHelpers.SettingHasValue(globalSettings?.DocumentDb.Key))
-        {
-            config.WriteTo.AzureCosmosDB(new Uri(globalSettings.DocumentDb.Uri),
-                globalSettings.DocumentDb.Key, timeToLive: TimeSpan.FromDays(7),
-                partitionKey: "_partitionKey")
-                .Enrich.FromLogContext()
-                .Enrich.WithProperty("Project", globalSettings.ProjectName);
-        }
-        else if (CoreHelpers.SettingHasValue(globalSettings?.Sentry.Dsn))
+        if (CoreHelpers.SettingHasValue(globalSettings?.Sentry.Dsn))
         {
             config.WriteTo.Sentry(globalSettings.Sentry.Dsn)
                 .Enrich.FromLogContext()