Merge pull request 'enhancement/system-logs' (#47) from enhancement/system-logs into development

Reviewed-on: daniel-hbn/Watcher#47
This commit is contained in:
2025-06-25 17:52:53 +00:00
11 changed files with 152 additions and 37 deletions

2
.gitignore vendored
View File

@@ -1,6 +1,6 @@
# Per-Use special Files and Directories
/persistance/*.db
/logs
/logs/*.log
*.env
/wwwroot/downloads/sqlite/*.sql

View File

@@ -22,12 +22,19 @@ public class AuthController : Controller
private readonly AppDbContext _context;
private readonly AppSettings _settings;
public AuthController(AppDbContext context, IOptions<AppSettings> options)
// Logging einbinden
private readonly ILogger<AuthController> _logger;
public AuthController(AppDbContext context, IOptions<AppSettings> options, ILogger<AuthController> logger)
{
_context = context;
_settings = options.Value;
_logger = logger;
}
// Login Seite anzeigen
[HttpGet]
public IActionResult Login(string? returnUrl = null)
{
@@ -41,6 +48,7 @@ public class AuthController : Controller
}
// Login mit lokalem User
[HttpPost]
public async Task<IActionResult> Login(LoginViewModel model)
{
@@ -55,20 +63,23 @@ public class AuthController : Controller
}
var claims = new List<Claim>
{
new Claim(ClaimTypes.Name, user.Username),
new Claim(ClaimTypes.NameIdentifier, user.Id.ToString()),
};
{
new Claim(ClaimTypes.Name, user.Username),
new Claim(ClaimTypes.NameIdentifier, user.Id.ToString()),
};
var identity = new ClaimsIdentity(claims, "local");
var principal = new ClaimsPrincipal(identity);
await HttpContext.SignInAsync("Cookies", principal);
_logger.LogInformation("lokaler User angemeldet: " + user.Username);
return Redirect("Home/Index");
}
// Login mit OIDC-Provider
public IActionResult SignIn()
{
return Challenge(new AuthenticationProperties
@@ -77,6 +88,9 @@ public class AuthController : Controller
}, "oidc");
}
// Logout
[HttpPost]
[ValidateAntiForgeryToken]
public async Task<IActionResult> Logout()
@@ -89,26 +103,32 @@ public class AuthController : Controller
await HttpContext.SignOutAsync("Cookies");
await HttpContext.SignOutAsync("oidc", props);
_logger.LogInformation("User abgemeldet");
return Redirect("/"); // nur als Fallback
}
// Anzeigen der User-Informationen
[Authorize]
public IActionResult Info()
{
var username = User.Identity?.Name;
Console.WriteLine("gefundener User: " + username);
var claims = User.Claims.Select(c => new { c.Type, c.Value }).ToList();
var Identity_User = User.Identity?.Name;
var user = _context.Users.FirstOrDefault(u => u.Username == username);
var user = _context.Users.FirstOrDefault(u => u.Username == Identity_User);
if (user == null) return NotFound();
// Anzeigedaten
var DbProvider = _context.Database.ProviderName;
var username = user.Username;
var mail = user.Email;
var Id = user.Id;
ViewBag.Name = username;
// Anzeigedaten an View übergeben
ViewBag.Claims = claims;
ViewBag.Name = username;
ViewBag.Mail = mail;
ViewBag.Id = Id;
@@ -154,9 +174,12 @@ public class AuthController : Controller
// Eventuell hier das Auth-Cookie erneuern, wenn Username sich ändert
_logger.LogTrace("Passwort-Change durchgeführt");
return RedirectToAction("Index", "Home");
}
// Edit-Form anzeigen
[Authorize]
[HttpGet]

View File

@@ -14,9 +14,12 @@ namespace Watcher.Controllers
[Authorize]
public class DatabaseController : Controller
{
// Backup Infos
private readonly string _dbPath = Path.Combine(Directory.GetCurrentDirectory(), "persistence", "watcher.db");
private readonly string _backupFolder = Path.Combine(Directory.GetCurrentDirectory(), "wwwroot", "downloads", "sqlite");
// Services
private readonly ILogger<DatabaseController> _logger;
public class DumpFileInfo
{
@@ -26,12 +29,22 @@ namespace Watcher.Controllers
}
public DatabaseController(IWebHostEnvironment env)
public DatabaseController(IWebHostEnvironment env, ILogger<DatabaseController> logger)
{
_logger = logger;
_backupFolder = Path.Combine(env.WebRootPath, "downloads", "sqlite");
if (!Directory.Exists(_backupFolder))
{
_logger.LogInformation("Backup-Directory neu erstellt");
Directory.CreateDirectory(_backupFolder);
}
else
{
_logger.LogInformation("Backup-Directory existiert bereits");
}
}
[HttpPost("/maintenance/sqlite-dump")]

View File

@@ -11,10 +11,21 @@ namespace Watcher.Controllers;
[Authorize]
public class DownloadController : Controller
{
// Logging einbinden
private readonly ILogger<AuthController> _logger;
public DownloadController(ILogger<AuthController> logger)
{
_logger = logger;
}
// Allgemeiner Download von Dateien
[Authorize]
[HttpGet("Download/File/{type}/{filename}")]
public IActionResult FileDownload(string type, string filename)
{
// Nur erlaubte Endungen zulassen (Sicherheit!)
// TODO: aktuelles "" für Binaries ist das absolute Gegenteil von sicher, ich hab aber keine bessere Idee
var allowedExtensions = new[] { ".exe", "", ".sql" };
var extension = Path.GetExtension(filename).ToLowerInvariant();
@@ -24,13 +35,17 @@ public class DownloadController : Controller
var path = Path.Combine(Directory.GetCurrentDirectory(), "wwwroot", "downloads", type, filename);
if (!System.IO.File.Exists(path))
{
_logger.LogError("Download fehlgeschlagen: Datei nicht gefunden ({path})", path);
return NotFound("Datei nicht gefunden");
}
// .exe MIME-Typ: application/octet-stream
var mimeType = "application/octet-stream";
var fileBytes = System.IO.File.ReadAllBytes(path);
_logger.LogTrace("Download ausgeführt: {filename}", filename);
return File(fileBytes, mimeType, filename);
//return File(fileBytes, filename);
}

View File

@@ -1,13 +1,10 @@
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.CodeAnalysis;
using Microsoft.EntityFrameworkCore;
using Microsoft.IdentityModel.Tokens;
using Watcher.Data;
using Watcher.Models;
using Watcher.ViewModels;
// eingehender Heartbeat-Payload
public class HeartbeatDto
{
public string? IpAddress { get; set; }
@@ -18,18 +15,27 @@ public class HeartbeatDto
public class HeartbeatController : Controller
{
// Datenbankverbindung
private readonly AppDbContext _context;
public HeartbeatController(AppDbContext context)
// Logging einbinden
private readonly ILogger<HeartbeatController> _logger;
public HeartbeatController(AppDbContext context, ILogger<HeartbeatController> logger)
{
_context = context;
_logger = logger;
}
// Endpoint um Heartbeat-Payloads zu empfangen
[HttpPost("receive")]
public async Task<IActionResult> Receive([FromBody] HeartbeatDto dto)
{
_logger.LogInformation("Heartbeat empfangen");
if (string.IsNullOrWhiteSpace(dto.IpAddress))
{
_logger.LogWarning("Eingehender Payload enthält keine IP-Adresse");
return BadRequest("Missing IP address.");
}
@@ -40,9 +46,11 @@ public class HeartbeatController : Controller
{
server.LastSeen = DateTime.UtcNow;
await _context.SaveChangesAsync();
_logger.LogInformation("Heartbeat von {server} in Datenbank eingetragen.", server.Name);
return Ok();
}
_logger.LogWarning("Eingehender Payload kann keiner bekannten IP-Adresse zugewiesen werden.");
return NotFound("No matching server found.");
}
}

View File

@@ -1,9 +1,9 @@
// .NET Packages
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;
using Microsoft.EntityFrameworkCore;
using System.Security.Claims;
// Local Namespaces
using Watcher.Data;
using Watcher.Models;
using Watcher.ViewModels;
namespace Watcher.Controllers
@@ -11,13 +11,20 @@ namespace Watcher.Controllers
[Authorize]
public class HomeController : Controller
{
// Datenbankverbindung
private readonly AppDbContext _context;
public HomeController(AppDbContext context)
// Logging einbinden
private readonly ILogger<HomeController> _logger;
// HomeController Constructor
public HomeController(AppDbContext context, ILogger<HomeController> logger)
{
_context = context;
_logger = logger;
}
// Dashboard unter /home/index
public async Task<IActionResult> Index()
{
var preferredUserName = User.FindFirst("preferred_username")?.Value;
@@ -39,9 +46,10 @@ namespace Watcher.Controllers
return View(viewModel);
}
// Funktion für /Views/Home/Index.cshtml um das DashboardStats-Partial neu zu laden.
// Die Funktion wird nicht direkt aufgerufen, sondern nur der /Home/DashboardStats Endpoint angefragt.
public IActionResult DashboardStats()
{
Console.WriteLine("Dashboard aktualisiert");
var servers = _context.Servers.ToList();
var containers = _context.Containers.ToList();
@@ -51,9 +59,12 @@ namespace Watcher.Controllers
{
ActiveServers = servers.Count(s => (now - s.LastSeen).TotalSeconds <= 120),
OfflineServers = servers.Count(s => (now - s.LastSeen).TotalSeconds > 120),
//TODO: anwendbar, wenn Container implementiert wurden.
//RunningContainers = containers.Count(c => (now - c.LastSeen).TotalSeconds <= 120),
//FailedContainers = containers.Count(c => (now - c.LastSeen).TotalSeconds > 120),
LastLogin = DateTime.Now // Oder was auch immer hier richtig ist
LastLogin = DateTime.Now
};
return PartialView("_DashboardStats", model);

View File

@@ -51,17 +51,23 @@ public class MetricDto
// Disks?
}
[ApiController]
[Route("[controller]")]
public class MonitoringController : Controller
{
private readonly AppDbContext _context;
public MonitoringController(AppDbContext context)
private readonly ILogger<MonitoringController> _logger;
public MonitoringController(AppDbContext context, ILogger<MonitoringController> logger)
{
_context = context;
_logger = logger;
}
// Endpoint, an dem sich neue Agents registrieren
[HttpPost("register")]
public async Task<IActionResult> Register([FromBody] RegistrationDto dto)
{
@@ -73,6 +79,7 @@ public class MonitoringController : Controller
.Select(e => e.ErrorMessage)
.ToList();
_logger.LogError("Fehlerhafter Registrierungs-Payload.");
return BadRequest(new { error = "Ungültiger Payload", details = errors });
}
@@ -92,13 +99,17 @@ public class MonitoringController : Controller
await _context.SaveChangesAsync();
// Success
_logger.LogInformation("Agent für '{server}' erfolgreich registriert.", server.Name);
return Ok();
}
_logger.LogError("Kein Server für Registrierung gefunden");
return NotFound("No Matching Server found.");
}
// Enpoint, an den Agents Ihre gesammelten Daten senden
[HttpPost("metric")]
public async Task<IActionResult> Receive([FromBody] MetricDto dto)
{
@@ -110,6 +121,7 @@ public class MonitoringController : Controller
.Select(e => e.ErrorMessage)
.ToList();
_logger.LogError("Ungültiger Monitoring-Payload.");
return BadRequest(new { error = "Ungültiger Payload", details = errors });
}
@@ -119,12 +131,14 @@ public class MonitoringController : Controller
if (server != null)
{
// Serverdaten in Datenbank eintragen
// TODO: Serverdaten in Datenbank eintragen
// Success
_logger.LogInformation("Monitoring-Daten für '{server}' empfangen", server.Name);
return Ok();
}
_logger.LogError("Kein Server für eingegangenen Monitoring-Payload gefunden");
return NotFound("No Matching Server found.");
}

View File

@@ -11,9 +11,12 @@ public class ServerController : Controller
{
private readonly AppDbContext _context;
public ServerController(AppDbContext context)
private readonly ILogger<ServerController> _logger;
public ServerController(AppDbContext context, ILogger<ServerController> logger)
{
_context = context;
_logger = logger;
}
public async Task<IActionResult> Overview()
@@ -49,6 +52,8 @@ public class ServerController : Controller
_context.Servers.Add(server);
await _context.SaveChangesAsync();
_logger.LogInformation("Neuer Server erstellt: {server}", server.Name);
return RedirectToAction(nameof(Overview));
}
@@ -59,11 +64,15 @@ public class ServerController : Controller
var server = await _context.Servers.FindAsync(id);
if (server == null)
{
_logger.LogError("Server nicht gefunden");
return NotFound();
}
_context.Servers.Remove(server);
await _context.SaveChangesAsync();
_logger.LogInformation("Server '{server}' erfolgreich gelöscht", server.Name);
return RedirectToAction(nameof(Overview));
}
@@ -98,6 +107,9 @@ public class ServerController : Controller
server.Type = vm.Type;
await _context.SaveChangesAsync();
_logger.LogInformation("Server '{server}' erfolgreich aktualisiert", server.Name);
return RedirectToAction(nameof(Overview));
}

View File

@@ -4,17 +4,39 @@ using Microsoft.AspNetCore.Authentication.OpenIdConnect;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Sqlite;
using Microsoft.IdentityModel.Tokens;
using Serilog;
using Watcher.Data;
using Watcher.Models;
var builder = WebApplication.CreateBuilder(args);
// Serilog konfigurieren nur Logs, die nicht von Microsoft stammen
Log.Logger = new LoggerConfiguration()
.MinimumLevel.Information()
.MinimumLevel.Override("Microsoft", Serilog.Events.LogEventLevel.Warning) // <--
.Enrich.FromLogContext()
.WriteTo.File(
"logs/watcher-.log",
outputTemplate: "[{Timestamp:yyyy-MM-dd HH:mm:ss}] [{Level:u3}] {Message:lj}{NewLine}{Exception}",
rollingInterval: RollingInterval.Day
)
.CreateLogger();
builder.Host.UseSerilog();
// Add services to the container.
builder.Services.AddControllersWithViews();
// HttpContentAccessor
builder.Services.AddHttpContextAccessor();
// ---------- Konfiguration ----------
DotNetEnv.Env.Load();
@@ -22,14 +44,14 @@ builder.Configuration
.AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
.AddEnvironmentVariables();
// Konfiguration laden
var configuration = builder.Configuration;
// ---------- DB-Kontext ----------
// ---------- DB-Kontext ----------
var dbProvider = configuration["Database:Provider"] ?? "MySQL";
var connectionString = configuration["Database:ConnectionString"];
builder.Services.AddDbContext<AppDbContext>((serviceProvider, options) =>
{
var config = serviceProvider.GetRequiredService<IConfiguration>();
@@ -51,19 +73,21 @@ builder.Services.AddDbContext<AppDbContext>((serviceProvider, options) =>
}
});
// ---------- Authentifizierung konfigurieren ----------
// PocketID nur konfigurieren, wenn aktiviert
var pocketIdSection = builder.Configuration.GetSection("Authentication:PocketID");
var pocketIdEnabled = pocketIdSection.GetValue<bool>("Enabled");
var auth = builder.Services.AddAuthentication("Cookies");
var auth = builder.Services.AddAuthentication("Cookies");
auth.AddCookie("Cookies", options =>
{
options.LoginPath = "/Auth/Login";
options.AccessDeniedPath = "/Auth/AccessDenied";
});
builder.Services.AddAuthentication()
.AddOpenIdConnect("oidc", options =>
{
@@ -124,12 +148,9 @@ builder.Services.AddAuthentication()
});
var app = builder.Build();
// Migrationen anwenden (für SQLite oder andere DBs)
using (var scope = app.Services.CreateScope())
{
@@ -169,6 +190,7 @@ using (var scope = app.Services.CreateScope())
}
}
// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
@@ -178,10 +200,6 @@ if (!app.Environment.IsDevelopment())
}
app.UseHttpsRedirection();
app.UseRouting();
@@ -190,11 +208,9 @@ app.UseAuthorization();
app.UseStaticFiles();
app.MapControllerRoute(
name: "default",
pattern: "{controller=Auth}/{action=Login}/"
);
app.Run();

View File

@@ -47,6 +47,7 @@
try {
const response = await fetch('/Home/DashboardStats');
if (response.ok) {
console.log("reload")
const html = await response.text();
document.getElementById('dashboard-stats').innerHTML = html;
} else {

View File

@@ -20,6 +20,8 @@
<!-- Auth via OpenID Connect + Cookies -->
<PackageReference Include="Microsoft.AspNetCore.Authentication.Cookies" Version="2.3.0" />
<PackageReference Include="Microsoft.AspNetCore.Authentication.OpenIdConnect" Version="8.0.6" />
<PackageReference Include="Serilog.AspNetCore" Version="9.0.0" />
<PackageReference Include="Serilog.Sinks.File" Version="7.0.0" />
</ItemGroup>
</Project>