feat(web,server)!: runtime log level (#5672)

* feat: change log level at runtime

* chore: open api

* chore: prefer env over runtime

* chore: remove default env value
This commit is contained in:
Jason Rasmussen
2023-12-14 11:55:40 -05:00
committed by GitHub
parent f2270ad757
commit 9768931275
61 changed files with 771 additions and 117 deletions

View File

@@ -2175,6 +2175,24 @@ export const LibraryType = {
export type LibraryType = typeof LibraryType[keyof typeof LibraryType];
/**
*
* @export
* @enum {string}
*/
export const LogLevel = {
Verbose: 'verbose',
Debug: 'debug',
Log: 'log',
Warn: 'warn',
Error: 'error',
Fatal: 'fatal'
} as const;
export type LogLevel = typeof LogLevel[keyof typeof LogLevel];
/**
*
* @export
@@ -3577,6 +3595,12 @@ export interface SystemConfigDto {
* @memberof SystemConfigDto
*/
'library': SystemConfigLibraryDto;
/**
*
* @type {SystemConfigLoggingDto}
* @memberof SystemConfigDto
*/
'logging': SystemConfigLoggingDto;
/**
*
* @type {SystemConfigMachineLearningDto}
@@ -3860,6 +3884,27 @@ export interface SystemConfigLibraryScanDto {
*/
'enabled': boolean;
}
/**
*
* @export
* @interface SystemConfigLoggingDto
*/
export interface SystemConfigLoggingDto {
/**
*
* @type {boolean}
* @memberof SystemConfigLoggingDto
*/
'enabled': boolean;
/**
*
* @type {LogLevel}
* @memberof SystemConfigLoggingDto
*/
'level': LogLevel;
}
/**
*
* @export

View File

@@ -0,0 +1,110 @@
<script lang="ts">
import {
notificationController,
NotificationType,
} from '$lib/components/shared-components/notification/notification';
import { handleError } from '$lib/utils/handle-error';
import { api, LogLevel, SystemConfigLoggingDto } from '@api';
import { isEqual } from 'lodash-es';
import { fade } from 'svelte/transition';
import SettingButtonsRow from '../setting-buttons-row.svelte';
import SettingSwitch from '../setting-switch.svelte';
import SettingSelect from '../setting-select.svelte';
export let loggingConfig: SystemConfigLoggingDto; // this is the config that is being edited
export let disabled = false;
let savedConfig: SystemConfigLoggingDto;
let defaultConfig: SystemConfigLoggingDto;
async function getConfigs() {
[savedConfig, defaultConfig] = await Promise.all([
api.systemConfigApi.getConfig().then((res) => res.data.logging),
api.systemConfigApi.getConfigDefaults().then((res) => res.data.logging),
]);
}
async function saveSetting() {
try {
const { data: current } = await api.systemConfigApi.getConfig();
const { data: updated } = await api.systemConfigApi.updateConfig({
systemConfigDto: {
...current,
logging: loggingConfig,
},
});
loggingConfig = { ...updated.logging };
savedConfig = { ...updated.logging };
notificationController.show({ message: 'Settings saved', type: NotificationType.Info });
} catch (error) {
handleError(error, 'Unable to save settings');
}
}
async function reset() {
const { data: resetConfig } = await api.systemConfigApi.getConfig();
loggingConfig = { ...resetConfig.logging };
savedConfig = { ...resetConfig.logging };
notificationController.show({
message: 'Reset settings to the recent saved settings',
type: NotificationType.Info,
});
}
async function resetToDefault() {
const { data: configs } = await api.systemConfigApi.getConfigDefaults();
loggingConfig = { ...configs.logging };
defaultConfig = { ...configs.logging };
notificationController.show({
message: 'Reset password settings to default',
type: NotificationType.Info,
});
}
</script>
<div>
{#await getConfigs() then}
<div in:fade={{ duration: 500 }}>
<form autocomplete="off" on:submit|preventDefault>
<div class="ml-4 mt-4 flex flex-col gap-4">
<div class="ml-4">
<SettingSwitch title="ENABLED" {disabled} subtitle="Logging" bind:checked={loggingConfig.enabled} />
</div>
<div class="ml-4">
<SettingSelect
label="LEVEL"
desc="When enabled, what log level to use."
bind:value={loggingConfig.level}
options={[
{ value: LogLevel.Fatal, text: 'Fatal' },
{ value: LogLevel.Error, text: 'Error' },
{ value: LogLevel.Warn, text: 'Warn' },
{ value: LogLevel.Log, text: 'Log' },
{ value: LogLevel.Debug, text: 'Debug' },
{ value: LogLevel.Verbose, text: 'Verbose' },
]}
name="level"
isEdited={loggingConfig.level !== savedConfig.level}
disabled={disabled || !loggingConfig.enabled}
/>
<SettingButtonsRow
on:reset={reset}
on:save={saveSetting}
on:reset-to-default={resetToDefault}
showResetToDefault={!isEqual(savedConfig, defaultConfig)}
{disabled}
/>
</div>
</div>
</form>
</div>
{/await}
</div>

View File

@@ -21,6 +21,7 @@
import type { PageData } from './$types';
import NewVersionCheckSettings from '$lib/components/admin-page/settings/new-version-check-settings/new-version-check-settings.svelte';
import LibrarySettings from '$lib/components/admin-page/settings/library-settings/library-settings.svelte';
import LoggingSettings from '$lib/components/admin-page/settings/logging-settings/logging-settings.svelte';
import { mdiAlert, mdiContentCopy, mdiDownload } from '@mdi/js';
export let data: PageData;
@@ -74,6 +75,10 @@
<LibrarySettings disabled={$featureFlags.configFile} libraryConfig={configs.library} />
</SettingAccordion>
<SettingAccordion title="Logging" subtitle="Manage log settings">
<LoggingSettings disabled={$featureFlags.configFile} loggingConfig={configs.logging} />
</SettingAccordion>
<SettingAccordion title="Machine Learning Settings" subtitle="Manage machine learning features and settings">
<MachineLearningSettings disabled={$featureFlags.configFile} machineLearningConfig={configs.machineLearning} />
</SettingAccordion>