feat: logging

This commit is contained in:
Arman committed 2025-03-25 15:47:00 +01:00
1 parent 95181d8c23
commit 191ceeec3e
15 files changed
+169 -323

No files matched your search

+2
View File
@@ -0,0 +1,2 @@
export { default as LogsRequest } from './logsRequest.svelte';
export { default as LogsResponse } from './logsResponse.svelte';
@@ -0,0 +1,26 @@
<script lang="ts">
import { base } from '$app/paths';
import { page } from '$app/stores';
import { Link } from '$lib/elements';
import { Alert } from '@appwrite.io/pink-svelte';
export let product: 'site' | 'function';
</script>
{#if product === 'site'}
<Alert.Inline status="info" title="Your logs are disabled">
To view logs and errors, enable them in your
<Link
href={`${base}/project-${$page.params.project}/sites/site-${$page.params.site}/settings`}>
site settings</Link
>.
</Alert.Inline>
{:else if product === 'function'}
<Alert.Inline status="info" title="Your execution logs are disabled">
To view execution logs and errors, enable them in your
<Link
href={`${base}/project-${$page.params.project}/functions/function-${$page.params.function}/settings`}>
function settings</Link
>.
</Alert.Inline>
{/if}
@@ -14,9 +14,11 @@
Typography
} from '@appwrite.io/pink-svelte';
import { onMount } from 'svelte';
import LoggingAlert from './loggingAlert.svelte';
export let selectedLog: Models.Execution;
export let product: 'site' | 'function';
export let logging: boolean;
let responseTab: 'logs' | 'errors' | 'headers' | 'body' = 'logs';
onMount(() => {
@@ -37,12 +39,14 @@
on:click={() => (responseTab = 'logs')}>
Logs
</Tabs.Item.Button>
<Tabs.Item.Button
{root}
active={responseTab === 'errors'}
on:click={() => (responseTab = 'errors')}>
Errors
</Tabs.Item.Button>
{#if product !== 'site'}
<Tabs.Item.Button
{root}
active={responseTab === 'errors'}
on:click={() => (responseTab = 'errors')}>
Errors
</Tabs.Item.Button>
{/if}
<Tabs.Item.Button
{root}
active={responseTab === 'headers'}
@@ -52,18 +56,22 @@
size="s"
content={selectedLog?.responseHeaders?.length?.toString()} />
</Tabs.Item.Button>
<Tabs.Item.Button
{root}
active={responseTab === 'body'}
on:click={() => (responseTab = 'body')}>
Body
</Tabs.Item.Button>
{#if product !== 'site'}
<Tabs.Item.Button
{root}
active={responseTab === 'body'}
on:click={() => (responseTab = 'body')}>
Body
</Tabs.Item.Button>
{/if}
</Tabs.Root>
<Divider />
</Layout.Stack>
{#if responseTab === 'logs'}
{#if !logging}
<LoggingAlert {product} />
{/if}
{#if selectedLog.logs}
<Logs logs={selectedLog.logs} />
{:else}
@@ -72,6 +80,9 @@
</Card>
{/if}
{:else if responseTab === 'errors'}
{#if !logging}
<LoggingAlert {product} />
{/if}
{#if selectedLog.errors}
<Logs logs={selectedLog.errors} />
{:else}
@@ -120,8 +131,8 @@
<Logs logs={selectedLog.responseBody} />
{:else}
<Card padding="xs" radius="s">
<Typography.Text
>Body data is not captured by Appwrite for your user's security and privacy. To
<Typography.Text>
Body data is not captured by Appwrite for your user's security and privacy. To
display body data in the Logs tab, use <InlineCode
code="context.log()"
size="s" />. <Link
@@ -9,7 +9,7 @@
import { project } from '$routes/(console)/project-[project]/store';
import { base } from '$app/paths';
import { View } from '$lib/helpers/load';
import { Alert, Icon, Layout, Link, Tooltip } from '@appwrite.io/pink-svelte';
import { Icon, Layout, Tooltip } from '@appwrite.io/pink-svelte';
import { IconPlus } from '@appwrite.io/pink-icons-svelte';
import Table from './table.svelte';
import { columns } from './store';
@@ -54,17 +54,6 @@
<ParsedTagList />
</Layout.Stack>
{#if !data.func.logging}
<div class="common-section">
<Alert.Inline status="info" title="Your execution logs are disabled">
To view execution logs and errors, enable them in your
<Link.Anchor
href={`${base}/project-${$project.$id}/functions/function-${data.func.$id}/settings`}>
Function settings</Link.Anchor
>.
</Alert.Inline>
</div>
{/if}
{#if data?.executions?.total}
<Table columns={$columns} logs={data.executions} />
@@ -19,12 +19,12 @@
import { capitalize } from '$lib/helpers/string';
import { Copy } from '$lib/components';
import { logStatusConverter } from './store';
import LogsResponse from './(components)/LogsResponse.svelte';
import LogsRequest from './(components)/LogsRequest.svelte';
import { LogsRequest, LogsResponse } from '$lib/components/logs';
export let open = false;
export let selectedLogId: string;
export let logs: Models.Execution[];
export let logging: boolean;
function nextLog() {
const currentIndex = logs.findIndex((log) => log.$id === selectedLogId);
@@ -160,7 +160,7 @@
<LogsRequest {selectedLog} />
</Accordion>
<Accordion title="Response" open hideDivider>
<LogsResponse {selectedLog} />
<LogsResponse {selectedLog} product="function" {logging} />
</Accordion>
</Layout.Stack>
{/if}
@@ -9,6 +9,7 @@
import { formatTimeDetailed } from '$lib/helpers/timeConversion';
import { logStatusConverter } from './store';
import DualTimeView from '$lib/components/dualTimeView.svelte';
import { func } from '../store';
export let columns: Column[];
export let logs: Models.ExecutionList;
@@ -82,4 +83,4 @@
{/each}
</Table.Root>
<Sheet bind:open={openSheet} bind:selectedLogId logs={logs.executions} />
<Sheet bind:open={openSheet} bind:selectedLogId logs={logs.executions} logging={$func.logging} />
@@ -108,7 +108,7 @@
<UpdateEvents />
<UpdateSchedule />
<UpdateTimeout />
<UpdateLogging />
<UpdateLogging func={data.function} />
<UpdateScopes />
<DangerZone />
</Container>
@@ -1,60 +1,49 @@
<script lang="ts">
import { invalidate } from '$app/navigation';
import { page } from '$app/stores';
import { Submit, trackError, trackEvent } from '$lib/actions/analytics';
import { CardGrid } from '$lib/components';
import { Dependencies } from '$lib/constants';
import { Button, Form } from '$lib/elements/forms';
import InputSwitch from '$lib/elements/forms/inputSwitch.svelte';
import { Button, Form, InputSwitch } from '$lib/elements/forms';
import { addNotification } from '$lib/stores/notifications';
import { sdk } from '$lib/stores/sdk';
import { project } from '$routes/(console)/project-[project]/store';
import { onMount } from 'svelte';
import { func } from '../store';
import { isValueOfStringEnum } from '$lib/helpers/types';
import { Runtime } from '@appwrite.io/console';
import { base } from '$app/paths';
import { Runtime, type Models } from '@appwrite.io/console';
import { Typography } from '@appwrite.io/pink-svelte';
import { Link } from '$lib/elements';
const functionId = $page.params.function;
let functionLogging: boolean = null;
export let func: Models.Function;
let logging = func.logging;
onMount(async () => {
functionLogging ??= $func.logging;
});
async function updateLogging() {
async function update() {
try {
if (!isValueOfStringEnum(Runtime, $func.runtime)) {
throw new Error(`Invalid runtime: ${$func.runtime}`);
if (!isValueOfStringEnum(Runtime, func.runtime)) {
throw new Error(`Invalid runtime: ${func.runtime}`);
}
await sdk.forProject.functions.update(
functionId,
$func.name,
$func.runtime,
$func.execute || undefined,
$func.events || undefined,
$func.schedule || undefined,
$func.timeout || undefined,
$func.enabled || undefined,
functionLogging,
$func.entrypoint || undefined,
$func.commands || undefined,
$func.scopes || undefined,
$func.installationId || undefined,
$func.providerRepositoryId || undefined,
$func.providerBranch || undefined,
$func.providerSilentMode || undefined,
$func.providerRootDirectory || undefined
func.$id,
func.name,
func.runtime,
func.execute || undefined,
func.events || undefined,
func.schedule || undefined,
func.timeout || undefined,
func.enabled || undefined,
logging,
func.entrypoint || undefined,
func.commands || undefined,
func.scopes || undefined,
func.installationId || undefined,
func.providerRepositoryId || undefined,
func.providerBranch || undefined,
func.providerSilentMode || undefined,
func.providerRootDirectory || undefined
);
await invalidate(Dependencies.FUNCTION);
addNotification({
type: 'success',
message:
$func.name +
func.name +
' execution logs settings have been ' +
(functionLogging ? 'enabled' : 'disabled')
(logging ? 'enabled' : 'disabled')
});
trackEvent(Submit.FunctionUpdateLogging);
} catch (error) {
@@ -67,20 +56,18 @@
}
</script>
<Form onSubmit={updateLogging}>
<Form onSubmit={update}>
<CardGrid>
<svelte:fragment slot="title">Execution logs</svelte:fragment>
<svelte:fragment slot="aside">
<InputSwitch label="Logs" id="logging" bind:value={functionLogging} />
<InputSwitch label="Logs" id="logging" bind:value={logging} />
<Typography.Text>
When disabled, execution logs and errors will not be shown in the <Link
href={`${base}/project-${$project.$id}/functions/function-${$func.$id}/executions`}>
Executions</Link> tab. We recommend disabling them for better performance in production.
When disabled, executions will exclude logs and errors, and will be slightly faster.
</Typography.Text>
</svelte:fragment>
<svelte:fragment slot="actions">
<Button disabled={$func.logging === functionLogging} submit>Update</Button>
<Button disabled={func.logging === logging} submit>Update</Button>
</svelte:fragment>
</CardGrid>
</Form>
@@ -96,7 +96,11 @@
<Table.Root
let:root
columns={[{ id: 'repo' }, { id: 'updated' }, { id: 'actions', width: 20 }]}>
columns={[
{ id: 'repo', width: { min: 150, max: 500 } },
{ id: 'updated', width: { min: 150, max: 500 } },
{ id: 'actions', width: 60 }
]}>
<svelte:fragment slot="header" let:root>
<Table.Header.Cell column="repo" {root}>Repository</Table.Header.Cell>
<Table.Header.Cell column="updated" {root}>Updated</Table.Header.Cell>
@@ -1,124 +0,0 @@
<script lang="ts">
import { Card } from '$lib/components';
import { Link } from '$lib/elements';
import type { Models } from '@appwrite.io/console';
import {
Badge,
Divider,
Input,
Layout,
Table,
Tabs,
Typography
} from '@appwrite.io/pink-svelte';
import { onMount } from 'svelte';
export let selectedLog: Models.Execution;
let requestTab: 'parameters' | 'headers' = 'parameters';
let parameters = [];
onMount(() => {
try {
// Add dummy base URL to parse relative paths
const url = new URL(selectedLog.requestPath, 'http://dummy.local');
if (url.search) {
parameters = Array.from(url.searchParams.entries()).map(([name, value]) => ({
name,
value: decodeURIComponent(value)
}));
}
} catch (error) {
parameters = [];
}
});
onMount(() => {
if (parameters?.length) {
requestTab = 'parameters';
} else if (selectedLog.requestHeaders?.length) {
requestTab = 'headers';
}
});
</script>
<Layout.Stack>
<Layout.Stack gap="none">
<Tabs.Root variant="secondary" let:root>
<Tabs.Item.Button
{root}
active={requestTab === 'parameters'}
on:click={() => (requestTab = 'parameters')}>
Parameters
<Badge variant="secondary" size="s" content={parameters?.length?.toString()} />
</Tabs.Item.Button>
<Tabs.Item.Button
{root}
active={requestTab === 'headers'}
on:click={() => (requestTab = 'headers')}>
Headers <Badge
variant="secondary"
size="s"
content={selectedLog?.requestHeaders?.length?.toString()} />
</Tabs.Item.Button>
</Tabs.Root>
<Divider />
</Layout.Stack>
{#if requestTab === 'parameters'}
{#if parameters?.length}
<Table.Root columns={2} let:root>
<svelte:fragment slot="header" let:root>
<Table.Header.Cell {root}>Key</Table.Header.Cell>
<Table.Header.Cell {root}>Value</Table.Header.Cell>
</svelte:fragment>
{#each parameters as parameter}
<Table.Row.Base {root}>
<Table.Cell {root}>{parameter.name}</Table.Cell>
<Table.Cell {root}>{parameter.value}</Table.Cell>
</Table.Row.Base>
{/each}
</Table.Root>
{:else}
<Card padding="xs" radius="s">
<Typography.Code>No parameters found.</Typography.Code>
</Card>
{/if}
{:else if requestTab === 'headers'}
{#if selectedLog.requestHeaders?.length}
<Table.Root
columns={[
{
id: 'key',
width: 200
},
{
id: 'value'
}
]}
let:root>
<svelte:fragment slot="header" let:root>
<Table.Header.Cell {root}>Key</Table.Header.Cell>
<Table.Header.Cell {root}>Value</Table.Header.Cell>
</svelte:fragment>
{#each selectedLog.requestHeaders as request}
<Table.Row.Base {root}>
<Table.Cell {root}>{request.name}</Table.Cell>
<Table.Cell {root}>{request.value}</Table.Cell>
</Table.Row.Base>
{/each}
</Table.Root>
<Input.Helper state="default">
<span>
Missing headers? Check the <Link variant="muted" href="#" external>docs</Link> to
see the supported data and how to log it.
</span>
</Input.Helper>
{:else}
<Card padding="xs" radius="s">
<Typography.Code>No headers found.</Typography.Code>
</Card>
{/if}
{/if}
</Layout.Stack>
@@ -1,119 +0,0 @@
<script lang="ts">
import { Card } from '$lib/components';
import { Link } from '$lib/elements';
import type { Models } from '@appwrite.io/console';
import {
Badge,
Divider,
Input,
Layout,
Logs,
Table,
Tabs,
Typography
} from '@appwrite.io/pink-svelte';
import { onMount } from 'svelte';
export let selectedLog: Models.Execution;
let responseTab: 'logs' | 'errors' | 'headers' | 'body' = 'logs';
onMount(() => {
if (selectedLog?.logs) {
responseTab = 'logs';
} else if (selectedLog.requestHeaders?.length) {
responseTab = 'headers';
}
});
</script>
<Layout.Stack>
<Layout.Stack gap="none">
<Tabs.Root variant="secondary" let:root>
<Tabs.Item.Button
{root}
active={responseTab === 'logs'}
on:click={() => (responseTab = 'logs')}>
Logs
</Tabs.Item.Button>
<!-- <Tabs.Item.Button
{root}
active={responseTab === 'errors'}
on:click={() => (responseTab = 'errors')}>
Errors
</Tabs.Item.Button> -->
<Tabs.Item.Button
{root}
active={responseTab === 'headers'}
on:click={() => (responseTab = 'headers')}>
Headers <Badge
variant="secondary"
size="s"
content={selectedLog?.responseHeaders?.length?.toString()} />
</Tabs.Item.Button>
</Tabs.Root>
<Divider />
</Layout.Stack>
{#if responseTab === 'logs'}
{#if selectedLog.logs}
<Logs logs={selectedLog.logs} />
{:else}
<Card padding="xs" radius="s">
<Typography.Code>No logs found.</Typography.Code>
</Card>
{/if}
{:else if responseTab === 'errors'}
{#if selectedLog.errors}
<Logs logs={selectedLog.errors} />
{:else}
<Card padding="xs" radius="s">
<Typography.Code>No errors found.</Typography.Code>
</Card>
{/if}
{:else if responseTab === 'headers'}
{#if selectedLog.responseHeaders?.length}
<Table.Root
columns={[
{
id: 'key',
width: 200
},
{
id: 'value'
}
]}
let:root>
<svelte:fragment slot="header" let:root>
<Table.Header.Cell {root}>Key</Table.Header.Cell>
<Table.Header.Cell {root}>Value</Table.Header.Cell>
</svelte:fragment>
{#each selectedLog.responseHeaders as request}
<Table.Row.Base {root}>
<Table.Cell {root}>{request.name}</Table.Cell>
<Table.Cell {root}>{request.value}</Table.Cell>
</Table.Row.Base>
{/each}
</Table.Root>
<Input.Helper state="default">
<span>
Missing headers? Check the <Link variant="muted" href="#" external>docs</Link> to
see the supported data and how to log it.
</span>
</Input.Helper>
{:else}
<Card padding="xs" radius="s">
<Typography.Code>No headers found.</Typography.Code>
</Card>
{/if}
{:else if responseTab === 'body'}
{#if selectedLog.responseBody}
<Logs logs={selectedLog.responseBody} />
{:else}
<Card padding="xs" radius="s">
<Typography.Code>No parameters found.</Typography.Code>
</Card>
{/if}
{/if}
</Layout.Stack>
@@ -14,10 +14,10 @@
Typography
} from '@appwrite.io/pink-svelte';
import { timeFromNow } from '$lib/helpers/date';
import LogsRequest from './(components)/LogsRequest.svelte';
import LogsResponse from './(components)/LogsResponse.svelte';
import { capitalize } from '$lib/helpers/string';
import { Copy } from '$lib/components';
import { LogsRequest, LogsResponse } from '$lib/components/logs';
import { site } from '../store';
export let open = false;
export let selectedLogId: string;
@@ -127,7 +127,7 @@
<LogsRequest {selectedLog} />
</Accordion>
<Accordion title="Response" open hideDivider>
<LogsResponse {selectedLog} />
<LogsResponse {selectedLog} logging={$site?.logging} product="site" />
</Accordion>
</Layout.Stack>
{/if}
@@ -15,6 +15,7 @@
import { isCloud } from '$lib/system';
import UpdateResourceLimits from './updateResourceLimits.svelte';
import UpdateVariables from '$routes/(console)/project-[project]/updateVariables.svelte';
import UpdateLogging from './updateLogging.svelte';
export let data;
@@ -74,5 +75,6 @@
<UpdateResourceLimits site={data.site} specs={data.specificationsList} />
{/if}
<UpdateTimeout site={data.site} />
<UpdateLogging site={data.site} />
<DangerZone site={data.site} />
</Container>
@@ -0,0 +1,67 @@
<script lang="ts">
import { invalidate } from '$app/navigation';
import { Submit, trackError, trackEvent } from '$lib/actions/analytics';
import { CardGrid } from '$lib/components';
import { Dependencies } from '$lib/constants';
import { Button, Form, InputSwitch } from '$lib/elements/forms';
import { addNotification } from '$lib/stores/notifications';
import { sdk } from '$lib/stores/sdk';
import { Adapter, BuildRuntime, Framework, type Models } from '@appwrite.io/console';
import { Typography } from '@appwrite.io/pink-svelte';
export let site: Models.Site;
let logging = site.logging;
async function update() {
try {
await sdk.forProject.sites.update(
site.$id,
site.name,
site.framework as Framework,
site.enabled || undefined,
site.timeout || undefined,
site.installCommand || undefined,
site.buildCommand || undefined,
site.outputDirectory || undefined,
(site?.buildRuntime as BuildRuntime) || undefined,
site.adapter as Adapter,
site.fallbackFile || undefined,
site.installationId || undefined,
site.providerRepositoryId || undefined,
site.providerBranch || undefined,
site.providerSilentMode || undefined,
site.providerRootDirectory || undefined
);
await invalidate(Dependencies.FUNCTION);
addNotification({
type: 'success',
message:
site.name + ' logs settings have been ' + (logging ? 'enabled' : 'disabled')
});
trackEvent(Submit.SiteUpdateLogging);
} catch (error) {
addNotification({
type: 'error',
message: error.message
});
trackError(error, Submit.SiteUpdateLogging);
}
}
</script>
<Form onSubmit={update}>
<CardGrid>
<svelte:fragment slot="title">Execution logs</svelte:fragment>
<svelte:fragment slot="aside">
<InputSwitch label="Logs" id="logging" bind:value={logging} />
<Typography.Text>
When disabled, request logs will exclude logs and errors, and site responses will be
slightly faster.
</Typography.Text>
</svelte:fragment>
<svelte:fragment slot="actions">
<Button disabled={site.logging === logging} submit>Update</Button>
</svelte:fragment>
</CardGrid>
</Form>