lgladsden/jellyfin-server
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added option to disable metrics collection and defaulted it to off

Browse Source
This commit is contained in:
sparky8251 2020-04-26 11:28:17 -04:00
parent 233337256f
commit 68c7a914c3
7 changed files with 56 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Emby.Server.Implementations/ApplicationHost.cs
View File

@ -106,6 +106,7 @@ using Microsoft.AspNetCore.Http.Extensions;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using OperatingSystem = MediaBrowser.Common.System.OperatingSystem;
using Prometheus.DotNetRuntime;
namespace Emby.Server.Implementations
{
@ -259,6 +260,12 @@ namespace Emby.Server.Implementations
_startupOptions = options;
// Initialize runtime stat collection
if (ServerConfigurationManager.Configuration.EnableMetrics)
{
IDisposable collector = DotNetRuntimeStatsBuilder.Default().StartCollecting();
}
fileSystem.AddShortcutHandler(new MbLinkShortcutHandler(fileSystem));
_networkManager.NetworkChanged += OnNetworkChanged;

1
Emby.Server.Implementations/Emby.Server.Implementations.csproj
View File

@ -39,6 +39,7 @@
<PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="3.1.3" />
<PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="3.1.3" />
<PackageReference Include="Mono.Nat" Version="2.0.1" />
<PackageReference Include="prometheus-net.DotNetRuntime" Version="3.3.1" />
<PackageReference Include="ServiceStack.Text.Core" Version="5.8.0" />
<PackageReference Include="sharpcompress" Version="0.25.0" />
<PackageReference Include="SQLitePCL.pretty.netstandard" Version="2.1.0" />

1
Jellyfin.Server/Jellyfin.Server.csproj
View File

@ -45,7 +45,6 @@
<PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="3.1.3" />
<PackageReference Include="prometheus-net" Version="3.5.0" />
<PackageReference Include="prometheus-net.AspNetCore" Version="3.5.0" />
<PackageReference Include="prometheus-net.DotNetRuntime" Version="3.3.1" />
<PackageReference Include="Serilog.AspNetCore" Version="3.2.0" />
<PackageReference Include="Serilog.Enrichers.Thread" Version="3.1.0" />
<PackageReference Include="Serilog.Settings.Configuration" Version="3.1.0" />

33
Jellyfin.Server/Migrations/Routines/DisableMetricsCollection.cs Normal file
View File

@ -0,0 +1,33 @@
using System;
using MediaBrowser.Common.Configuration;
using MediaBrowser.Model.Configuration;
using Microsoft.Extensions.Logging;
namespace Jellyfin.Server.Migrations.Routines
{
/// <summary>
/// Disable metrics collections for all installations since it can be a security risk if not properly secured.
/// </summary>
internal class DisableMetricsCollection : IMigrationRoutine
{
/// <inheritdoc/>
public Guid Id => Guid.Parse("{4124C2CD-E939-4FFB-9BE9-9B311C413638}");
/// <inheritdoc/>
public string Name => "DisableMetricsCollection";
/// <inheritdoc/>
public void Perform(CoreAppHost host, ILogger logger)
{
// Set EnableMetrics to false since it can leak sensitive information if not properly secured
var metrics = host.ServerConfigurationManager.Configuration.EnableMetrics;
if (metrics)
{
logger.LogInformation("Disabling metrics collection during migration");
metrics = false;
host.ServerConfigurationManager.SaveConfiguration("false", metrics);
}
}
}
}

4
Jellyfin.Server/Program.cs
View File

@ -28,7 +28,6 @@ using Microsoft.Extensions.DependencyInjection.Extensions;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Abstractions;
using Prometheus.DotNetRuntime;
using Serilog;
using Serilog.Extensions.Logging;
using SQLitePCL;
@ -162,9 +161,6 @@ namespace Jellyfin.Server
ApplicationHost.LogEnvironmentInfo(_logger, appPaths);
// Initialize runtime stat collection
IDisposable collector = DotNetRuntimeStatsBuilder.Default().StartCollecting();
// Make sure we have all the code pages we can get
// Ref: https://docs.microsoft.com/en-us/dotnet/api/system.text.codepagesencodingprovider.instance?view=netcore-3.0#remarks
Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);

11
Jellyfin.Server/Startup.cs
View File

@ -70,11 +70,18 @@ namespace Jellyfin.Server
app.UseJellyfinApiSwagger();
app.UseRouting();
app.UseAuthorization();
app.UseHttpMetrics(); // Must be registered after any middleware that could chagne HTTP response codes or the data will be bad
if (_serverConfigurationManager.Configuration.EnableMetrics)
{
app.UseHttpMetrics(); // Must be registered after any middleware that could chagne HTTP response codes or the data will be bad
}
app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
endpoints.MapMetrics();
if (_serverConfigurationManager.Configuration.EnableMetrics)
{
endpoints.MapMetrics();
}
});
app.Use(serverApplicationHost.ExecuteHttpHandlerAsync);

6
MediaBrowser.Model/Configuration/ServerConfiguration.cs
View File

@ -19,6 +19,11 @@ namespace MediaBrowser.Model.Configuration
/// </summary>
public bool EnableUPnP { get; set; }
/// <summary>
/// Gets or sets a value indicating whether to enable prometheus metrics exporting.
/// </summary>
public bool EnableMetrics { get; set; }
/// <summary>
/// Gets or sets the public mapped port.
/// </summary>
@ -246,6 +251,7 @@ namespace MediaBrowser.Model.Configuration
PublicHttpsPort = DefaultHttpsPort;
HttpServerPortNumber = DefaultHttpPort;
HttpsPortNumber = DefaultHttpsPort;
EnableMetrics = false;
EnableHttps = false;
EnableDashboardResponseCaching = true;
EnableCaseSensitiveItemIds = true;