Skip to content

feat(site): add healthcheck page for provisioner daemons #11494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions codersdk/health.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ var HealthSections = []HealthSection{
HealthSectionWebsocket,
HealthSectionDatabase,
HealthSectionWorkspaceProxy,
HealthSectionProvisionerDaemons,
}

type HealthSettings struct {
Expand Down
48 changes: 48 additions & 0 deletions docs/admin/healthcheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,54 @@ _One or more Workspace Proxies Unhealthy_
**Solution:** Ensure that Coder can establish a connection to the configured
workspace proxies.

### EPD01

_No Provisioner Daemons Available_

**Problem:** No provisioner daemons are registered with Coder. No workspaces can
be built until there is at least one provisioner daemon running.

**Solution:**

If you are using
[External Provisioner Daemons](./provisioners.md#external-provisioners), ensure
that they are able to successfully connect to Coder. Otherwise, ensure
[`--provisioner-daemons`](../cli/server.md#provisioner-daemons) is set to a
value greater than 0.

> Note: This may be a transient issue if you are currently in the process of
> updating your deployment.

### EPD02

_Provisioner Daemon Version Mismatch_

**Problem:** One or more provisioner daemons are more than one major or minor
version out of date with the main deployment. It is important that provisioner
daemons are updated at the same time as the main deployment to minimize the risk
of API incompatibility.

**Solution:** Update the provisioner daemon to match the currently running
version of Coder.

> Note: This may be a transient issue if you are currently in the process of
> updating your deployment.

### EPD03

_Provisioner Daemon API Version Mismatch_

**Problem:** One or more provisioner daemons are using APIs that are marked as
deprecated. These deprecated APIs may be removed in a future release of Coder,
at which point the affected provisioner daemons will no longer be able to
connect to Coder.

**Solution:** Update the provisioner daemon to match the currently running
version of Coder.

> Note: This may be a transient issue if you are currently in the process of
> updating your deployment.

## EUNKNOWN

_Unknown Error_
Expand Down
7 changes: 7 additions & 0 deletions site/src/AppRouter.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,9 @@ const WebsocketPage = lazy(() => import("./pages/HealthPage/WebsocketPage"));
const WorkspaceProxyHealthPage = lazy(
() => import("./pages/HealthPage/WorkspaceProxyPage"),
);
const ProvisionerDaemonsHealthPage = lazy(
() => import("./pages/HealthPage/ProvisionerDaemonsPage"),
);

export const AppRouter: FC = () => {
return (
Expand Down Expand Up @@ -400,6 +403,10 @@ export const AppRouter: FC = () => {
path="workspace-proxy"
element={<WorkspaceProxyHealthPage />}
/>
<Route
path="provisioner-daemons"
element={<ProvisionerDaemonsHealthPage />}
/>
</Route>
{/* Using path="*"" means "match anything", so this route
acts like a catch-all for URLs that we don't have explicit
Expand Down
1 change: 1 addition & 0 deletions site/src/pages/HealthPage/HealthLayout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ export function HealthLayout() {
websocket: "Websocket",
database: "Database",
workspace_proxy: "Workspace Proxy",
provisioner_daemons: "Provisioner Daemons",
} as const;
const visibleSections = filterVisibleSections(sections);

Expand Down
16 changes: 16 additions & 0 deletions site/src/pages/HealthPage/ProvisionerDaemonsPage.stories.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { StoryObj, Meta } from "@storybook/react";
import { ProvisionerDaemonsPage } from "./ProvisionerDaemonsPage";
import { generateMeta } from "./storybook";

const meta: Meta = {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also add other stories to cover different conditions of this UI view?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, we need to do this for essentially all of the provisionerd healthchecks. I think this can be resolved in #10785

title: "pages/Health/ProvisionerDaemons",
...generateMeta({
path: "/health/provisioner-daemons",
element: <ProvisionerDaemonsPage />,
}),
};

export default meta;
type Story = StoryObj;

export const Default: Story = {};
166 changes: 166 additions & 0 deletions site/src/pages/HealthPage/ProvisionerDaemonsPage.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
import { Header, HeaderTitle, HealthyDot, Main, Pill } from "./Content";
import { Helmet } from "react-helmet-async";
import { pageTitle } from "utils/page";
import { useTheme } from "@mui/material/styles";
import { DismissWarningButton } from "./DismissWarningButton";
import { Alert } from "components/Alert/Alert";
import { HealthcheckReport } from "api/typesGenerated";
import { createDayString } from "utils/createDayString";

import { useOutletContext } from "react-router-dom";
import Business from "@mui/icons-material/Business";
import Person from "@mui/icons-material/Person";
import SwapHoriz from "@mui/icons-material/SwapHoriz";
import Tooltip from "@mui/material/Tooltip";
import Sell from "@mui/icons-material/Sell";

export const ProvisionerDaemonsPage = () => {
const healthStatus = useOutletContext<HealthcheckReport>();
const { provisioner_daemons: daemons } = healthStatus;
const theme = useTheme();
return (
<>
<Helmet>
<title>{pageTitle("Provisioner Daemons - Health")}</title>
</Helmet>

<Header>
<HeaderTitle>
<HealthyDot severity={daemons.severity} />
Provisioner Daemons
</HeaderTitle>
<DismissWarningButton healthcheck="ProvisionerDaemons" />
</Header>

<Main>
{daemons.warnings.map((warning) => {
return (
<Alert key={warning.code} severity="warning">
{warning.message}
</Alert>
);
})}

{daemons.items.map(({ provisioner_daemon: daemon, warnings }) => {
const daemonScope = daemon.tags["scope"] || "organization";
const iconScope =
daemonScope === "organization" ? <Business /> : <Person />;
const extraTags = Object.keys(daemon.tags)
.filter((key) => key !== "scope" && key !== "owner")
.reduce(
(acc, key) => {
acc[key] = daemon.tags[key];
return acc;
},
{} as Record<string, string>,
);
const isWarning = warnings.length > 0;
return (
<div
key={daemon.name}
css={{
borderRadius: 8,
border: `1px solid ${
isWarning
? theme.palette.warning.light
: theme.palette.divider
}`,
fontSize: 14,
}}
>
<header
css={{
padding: 24,
display: "flex",
alignItems: "center",
justifyContenxt: "space-between",
gap: 24,
}}
>
<div
css={{
display: "flex",
alignItems: "center",
gap: 24,
objectFit: "fill",
}}
>
<div css={{ lineHeight: "160%" }}>
<h4 css={{ fontWeight: 500, margin: 0 }}>{daemon.name}</h4>
<span css={{ color: theme.palette.text.secondary }}>
<code>{daemon.version}</code>
</span>
</div>
</div>
<div
css={{
marginLeft: "auto",
display: "flex",
flexWrap: "wrap",
gap: 12,
}}
>
<Tooltip title="API Version">
<Pill icon={<SwapHoriz />}>
<code>{daemon.api_version}</code>
</Pill>
</Tooltip>
<Tooltip title="Scope">
<Pill icon={iconScope}>
<span
css={{
":first-letter": { textTransform: "uppercase" },
}}
>
{daemonScope}
</span>
</Pill>
</Tooltip>
{Object.keys(extraTags).map((k) => (
<Tooltip key={k} title={k}>
<Pill key={k} icon={<Sell />}>
{extraTags[k]}
</Pill>
</Tooltip>
))}
</div>
</header>

<div
css={{
borderTop: `1px solid ${theme.palette.divider}`,
display: "flex",
alignItems: "center",
justifyContent: "space-between",
padding: "8px 24px",
fontSize: 12,
color: theme.palette.text.secondary,
}}
>
{warnings.length > 0 ? (
<div css={{ display: "flex", flexDirection: "column" }}>
{warnings.map((warning, i) => (
<span key={i}>{warning.message}</span>
))}
</div>
) : (
<span>No warnings</span>
)}
{daemon.last_seen_at && (
<span
css={{ color: theme.palette.text.secondary }}
data-chromatic="ignore"
>
Last seen {createDayString(daemon.last_seen_at)}
</span>
)}
</div>
</div>
);
})}
</Main>
</>
);
};

export default ProvisionerDaemonsPage;
41 changes: 38 additions & 3 deletions site/src/testHelpers/entities.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3103,25 +3103,60 @@ export const MockHealth: TypesGen.HealthcheckReport = {
},
provisioner_daemons: {
severity: "ok",
warnings: [],
warnings: [
{
message: "Something is wrong!",
code: "EUNKNOWN",
},
{
message: "This is also bad.",
code: "EPD01",
},
],
dismissed: false,
items: [
{
provisioner_daemon: {
id: "e455b582-ac04-4323-9ad6-ab71301fa006",
created_at: "2024-01-04T15:53:03.21563Z",
last_seen_at: "2024-01-04T16:05:03.967551Z",
name: "vvuurrkk-2",
version: "v2.6.0-devel+965ad5e96",
name: "ok",
version: "v2.3.4-devel+abcd1234",
api_version: "1.0",
provisioners: ["echo", "terraform"],
tags: {
owner: "",
scope: "organization",
custom_tag_name: "custom_tag_value",
},
},
warnings: [],
},
{
provisioner_daemon: {
id: "e455b582-ac04-4323-9ad6-ab71301fa006",
created_at: "2024-01-04T15:53:03.21563Z",
last_seen_at: "2024-01-04T16:05:03.967551Z",
name: "unhappy",
version: "v0.0.1",
api_version: "0.1",
provisioners: ["echo", "terraform"],
tags: {
owner: "",
scope: "organization",
},
},
warnings: [
{
message: "Something specific is wrong with this daemon.",
code: "EUNKNOWN",
},
{
message: "And now for something completely different.",
code: "EUNKNOWN",
},
],
},
],
},
coder_version: "v2.5.0-devel+5fad61102",
Expand Down