Files
misskey/packages/frontend/src/pages/admin/job-queue.vue

371 lines
11 KiB
Vue

<!--
SPDX-FileCopyrightText: syuilo and misskey-project
SPDX-License-Identifier: AGPL-3.0-only
-->
<template>
<PageWithHeader v-model:tab="tab" :actions="headerActions" :tabs="headerTabs">
<div class="_spacer">
<div v-if="tab === '-'" class="_gaps">
<div :class="$style.queues">
<div v-for="q in queueInfos" :key="q.name" :class="$style.queue" @click="tab = q.name">
<div style="display: flex; align-items: center; font-weight: bold;"><i class="ti ti-http-que" style="margin-right: 0.5em;"></i>{{ q.name }}<i v-if="!q.isPaused" style="color: var(--MI_THEME-success); margin-left: auto;" class="ti ti-player-play"></i></div>
<div :class="$style.queueCounts">
<MkKeyValue>
<template #key>Active</template>
<template #value>{{ kmg(q.counts.active, 2) }}</template>
</MkKeyValue>
<MkKeyValue>
<template #key>Delayed</template>
<template #value>{{ kmg(q.counts.delayed, 2) }}</template>
</MkKeyValue>
<MkKeyValue>
<template #key>Waiting</template>
<template #value>{{ kmg(q.counts.waiting, 2) }}</template>
</MkKeyValue>
</div>
<XChart :dataSet="{ completed: q.metrics.completed.data, failed: q.metrics.failed.data }"/>
</div>
</div>
</div>
<div v-else-if="queueInfo" class="_gaps">
<MkFolder :defaultOpen="true">
<template #label>Overview: {{ tab }}</template>
<template #icon><i class="ti ti-http-que"></i></template>
<template #suffix>#{{ queueInfo.db.processId }}:{{ queueInfo.db.port }} / {{ queueInfo.db.runId }}</template>
<template #caption>{{ queueInfo.qualifiedName }}</template>
<template #footer>
<div class="_buttons">
<MkButton rounded @click="promoteAllJobs"><i class="ti ti-player-track-next"></i> Promote all jobs</MkButton>
<MkButton rounded @click="createJob"><i class="ti ti-plus"></i> Add job</MkButton>
<MkButton v-if="queueInfo.isPaused" rounded @click="resumeQueue"><i class="ti ti-player-play"></i> Resume queue</MkButton>
<MkButton v-else rounded danger @click="pauseQueue"><i class="ti ti-player-pause"></i> Pause queue</MkButton>
<MkButton rounded danger @click="clearQueue"><i class="ti ti-trash"></i> Empty queue</MkButton>
</div>
</template>
<div class="_gaps">
<XChart :dataSet="{ completed: queueInfo.metrics.completed.data, failed: queueInfo.metrics.failed.data }" :aspectRatio="5"/>
<div style="display: grid; grid-template-columns: repeat(auto-fill, minmax(200px, 1fr)); gap: 12px;">
<MkKeyValue>
<template #key>Active</template>
<template #value>{{ kmg(queueInfo.counts.active, 2) }}</template>
</MkKeyValue>
<MkKeyValue>
<template #key>Delayed</template>
<template #value>{{ kmg(queueInfo.counts.delayed, 2) }}</template>
</MkKeyValue>
<MkKeyValue>
<template #key>Waiting</template>
<template #value>{{ kmg(queueInfo.counts.waiting, 2) }}</template>
</MkKeyValue>
</div>
<hr>
<div style="display: grid; grid-template-columns: repeat(auto-fill, minmax(200px, 1fr)); gap: 12px;">
<MkKeyValue>
<template #key>Clients: Connected</template>
<template #value>{{ queueInfo.db.clients.connected }}</template>
</MkKeyValue>
<MkKeyValue>
<template #key>Clients: Blocked</template>
<template #value>{{ queueInfo.db.clients.blocked }}</template>
</MkKeyValue>
<MkKeyValue>
<template #key>Memory: Peak</template>
<template #value>{{ bytes(queueInfo.db.memory.peak, 1) }}</template>
</MkKeyValue>
<MkKeyValue>
<template #key>Memory: Total</template>
<template #value>{{ bytes(queueInfo.db.memory.total, 1) }}</template>
</MkKeyValue>
<MkKeyValue>
<template #key>Memory: Used</template>
<template #value>{{ bytes(queueInfo.db.memory.used, 1) }}</template>
</MkKeyValue>
<MkKeyValue>
<template #key>Uptime</template>
<template #value>{{ queueInfo.db.uptime }}</template>
</MkKeyValue>
</div>
</div>
</MkFolder>
<MkFolder :defaultOpen="true" :withSpacer="false">
<template #label>Jobs: {{ tab }}</template>
<template #icon><i class="ti ti-list-check"></i></template>
<template #suffix>&lt;A:{{ kmg(queueInfo.counts.active, 2) }}&gt; &lt;D:{{ kmg(queueInfo.counts.delayed, 2) }}&gt; &lt;W:{{ kmg(queueInfo.counts.waiting, 2) }}&gt;</template>
<template #header>
<MkTabs
v-model:tab="jobState"
:class="$style.jobsTabs" :tabs="[{
key: 'all',
title: 'All',
icon: 'ti ti-code-asterisk',
}, {
key: 'latest',
title: 'Latest',
icon: 'ti ti-logs',
}, {
key: 'completed',
title: 'Completed',
icon: 'ti ti-check',
}, {
key: 'failed',
title: 'Failed',
icon: 'ti ti-circle-x',
}, {
key: 'active',
title: 'Active',
icon: 'ti ti-player-play',
}, {
key: 'delayed',
title: 'Delayed',
icon: 'ti ti-clock',
}, {
key: 'wait',
title: 'Waiting',
icon: 'ti ti-hourglass-high',
}, {
key: 'paused',
title: 'Paused',
icon: 'ti ti-player-pause',
}]"
/>
</template>
<template #footer>
<div class="_buttons">
<MkButton rounded @click="fetchJobs()"><i class="ti ti-reload"></i> Refresh view</MkButton>
<MkButton rounded danger style="margin-left: auto;" @click="removeJobs"><i class="ti ti-trash"></i> Remove jobs</MkButton>
</div>
</template>
<div class="_spacer">
<MkInput
v-model="searchQuery"
:placeholder="i18n.ts.search"
type="search"
style="margin-bottom: 16px;"
>
<template #prefix><i class="ti ti-search"></i></template>
</MkInput>
<MkLoading v-if="jobsFetching"/>
<MkTl
v-else
:events="jobs.map((job) => ({
id: job.id,
timestamp: job.finishedOn ?? job.processedOn ?? job.timestamp,
data: job,
}))"
class="_monospace"
>
<template #right="{ event: job }">
<XJob :job="job" :queueType="tab" style="margin: 4px 0;" @needRefresh="refreshJob(job.id)"/>
</template>
</MkTl>
</div>
</MkFolder>
</div>
</div>
</PageWithHeader>
</template>
<script lang="ts" setup>
import { ref, computed, watch } from 'vue';
import JSON5 from 'json5';
import { debounce } from 'throttle-debounce';
import { useInterval } from '@@/js/use-interval.js';
import XChart from './job-queue.chart.vue';
import XJob from './job-queue.job.vue';
import type { Ref } from 'vue';
import * as os from '@/os.js';
import { i18n } from '@/i18n.js';
import { definePage } from '@/page.js';
import MkButton from '@/components/MkButton.vue';
import { misskeyApi } from '@/utility/misskey-api.js';
import MkTabs from '@/components/MkTabs.vue';
import MkFolder from '@/components/MkFolder.vue';
import MkCode from '@/components/MkCode.vue';
import MkKeyValue from '@/components/MkKeyValue.vue';
import MkTl from '@/components/MkTl.vue';
import kmg from '@/filters/kmg.js';
import MkInput from '@/components/MkInput.vue';
import bytes from '@/filters/bytes.js';
import { copyToClipboard } from '@/utility/copy-to-clipboard.js';
const QUEUE_TYPES = [
'system',
'endedPollNotification',
'deliver',
'inbox',
'db',
'relationship',
'objectStorage',
'userWebhookDeliver',
'systemWebhookDeliver',
] as const;
const tab: Ref<typeof QUEUE_TYPES[number] | '-'> = ref('-');
const jobState = ref('all');
const jobs = ref([]);
const jobsFetching = ref(true);
const queueInfos = ref([]);
const queueInfo = ref();
const searchQuery = ref('');
async function fetchQueues() {
if (tab.value !== '-') return;
queueInfos.value = await misskeyApi('admin/queue/queues');
}
async function fetchCurrentQueue() {
if (tab.value === '-') return;
queueInfo.value = await misskeyApi('admin/queue/queue-stats', { queue: tab.value });
}
async function fetchJobs() {
jobsFetching.value = true;
const state = jobState.value;
jobs.value = await misskeyApi('admin/queue/jobs', {
queue: tab.value,
state: state === 'all' ? ['completed', 'failed', 'active', 'delayed', 'wait'] : state === 'latest' ? ['completed', 'failed'] : [state],
search: searchQuery.value.trim() === '' ? undefined : searchQuery.value,
}).then(res => {
if (state === 'all') {
res.sort((a, b) => (a.processedOn ?? a.timestamp) > (b.processedOn ?? b.timestamp) ? -1 : 1);
} else if (state === 'latest') {
res.sort((a, b) => a.processedOn > b.processedOn ? -1 : 1);
} else if (state === 'delayed') {
res.sort((a, b) => (a.processedOn ?? a.timestamp) > (b.processedOn ?? b.timestamp) ? -1 : 1);
}
return res;
});
jobsFetching.value = false;
}
watch([tab], async () => {
if (tab.value === '-') {
fetchQueues();
} else {
fetchCurrentQueue();
fetchJobs();
}
}, { immediate: true });
watch([jobState], () => {
fetchJobs();
});
const search = debounce(1000, () => {
fetchJobs();
});
watch([searchQuery], () => {
search();
});
useInterval(() => {
if (tab.value === '-') {
fetchQueues();
} else {
fetchCurrentQueue();
}
}, 1000 * 10, {
immediate: false,
afterMounted: true,
});
async function clearQueue() {
const { canceled } = await os.confirm({
type: 'warning',
title: i18n.ts.areYouSure,
});
if (canceled) return;
os.apiWithDialog('admin/queue/clear', { queue: tab.value, state: '*' });
fetchCurrentQueue();
fetchJobs();
}
async function promoteAllJobs() {
const { canceled } = await os.confirm({
type: 'warning',
title: i18n.ts.areYouSure,
});
if (canceled) return;
os.apiWithDialog('admin/queue/promote-jobs', { queue: tab.value });
fetchCurrentQueue();
fetchJobs();
}
async function removeJobs() {
const { canceled } = await os.confirm({
type: 'warning',
title: i18n.ts.areYouSure,
});
if (canceled) return;
os.apiWithDialog('admin/queue/clear', { queue: tab.value, state: jobState.value });
fetchCurrentQueue();
fetchJobs();
}
async function refreshJob(jobId: string) {
const newJob = await misskeyApi('admin/queue/show-job', { queue: tab.value, jobId });
const index = jobs.value.findIndex((job) => job.id === jobId);
if (index !== -1) {
jobs.value[index] = newJob;
}
}
const headerActions = computed(() => []);
const headerTabs = computed(() =>
[{
key: '-',
title: i18n.ts.overview,
icon: 'ti ti-dashboard',
}].concat(QUEUE_TYPES.map((t) => ({
key: t,
title: t,
}))),
);
definePage(() => ({
title: i18n.ts.jobQueue,
icon: 'ti ti-clock-play',
needWideArea: true,
}));
</script>
<style lang="scss" module>
.queues {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(320px, 1fr));
gap: 14px;
}
.queue {
padding: 14px 18px;
background-color: var(--MI_THEME-panel);
border-radius: 8px;
cursor: pointer;
}
.queueCounts {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(80px, 1fr));
gap: 8px;
font-size: 85%;
margin: 6px 0;
}
.jobsTabs {
}
</style>