Skip to content
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.

Sign up for GitHub

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

feat: add docker healthchecks to server and ml #9583

Merged
merged 12 commits into from
May 22, 2024
Merged

feat: add docker healthchecks to server and ml #9583

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
d26ba62
add healthcheck
CodaBool May 18, 2024
83bf56d
format, import, IMMICH_PORT, and eslint change
CodaBool May 19, 2024
38ffce6
chore: clean up nodejs healthcheck
jrasm91 May 20, 2024
cb3d215
fix ruff formating
CodaBool May 21, 2024
6f2f3d1
add healthcheck
CodaBool May 18, 2024
3ad2a46
format, import, IMMICH_PORT, and eslint change
CodaBool May 19, 2024
715214a
chore: clean up nodejs healthcheck
jrasm91 May 20, 2024
daec35d
fix ruff formating
CodaBool May 21, 2024
f6f5491
merge + add to Dockerfile
CodaBool May 22, 2024
5082756
add healthcheck to dockerfile
CodaBool May 22, 2024
21e6f18
poetry run ruff check --fix
CodaBool May 22, 2024
7246bd3
removed 2 of 3 console calls
CodaBool May 22, 2024
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
14 changes: 14 additions & 0 deletions machine-learning/app/healthcheck.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import os
import sys

import requests

port = os.getenv("IMMICH_PORT", 3003)

try:
response = requests.get(f"http://localhost:{port}/ping", timeout=2)
if response.status_code == 200:
sys.exit(0)
sys.exit(1)
except requests.RequestException:
sys.exit(1)
1 change: 1 addition & 0 deletions server/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
"check": "tsc --noEmit",
"check:code": "npm run format && npm run lint && npm run check",
"check:all": "npm run check:code && npm run test:cov",
"healthcheck": "node ./dist/utils/healthcheck.js",
"test": "vitest",
"test:watch": "vitest --watch",
"test:cov": "vitest --coverage",
Expand Down
31 changes: 31 additions & 0 deletions server/src/utils/healthcheck.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
#!/usr/bin/env node
const port = Number(process.env.IMMICH_PORT) || 3001;
const controller = new AbortController();

jrasm91 marked this conversation as resolved.
Show resolved Hide resolved
const main = async () => {
const timeout = setTimeout(() => controller.abort(), 2000);
try {
const response = await fetch(`http://localhost:${port}/api/server-info/ping`, {
signal: controller.signal,
});

if (response.ok) {
const body = await response.json();
if (body.res === 'pong') {
console.log('Server is running');
Copy link
Contributor

Choose a reason for hiding this comment

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

Will this write to the docker logs every time the HC is run (default 30 seconds)? Is that desired?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Doing a watch on the immich_server container for 2 minutes and nothing showed up (healthchecks should by default happen every 30 seconds). There is no other logs than the container's stdout right?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hm, interesting. I guess that should be fine then

Copy link
Contributor

Choose a reason for hiding this comment

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

Imo just remove it anyway, if it doesn't get written anywhere then there's no point having it

Copy link
Contributor Author

@CodaBool CodaBool May 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

removed 2 of the 3 console calls. I left the last one in because there is a very minor usefulness to them. If healthchecks are failing when they shouldn't be you could exec in and run the file with node. Then look at the output for debugging.

Let me know what you think. I think either way is fine. Docker is likely redirecting stdout to dev/null anyways but that's speculation

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks good to me, thanks for making all these changes!

Copy link
Member

Choose a reason for hiding this comment

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

It's not really important here, but for future reference, healthcheck logs are captured separately by docker and listed in the container status next to healthcheck status changes.

process.exit();
}
}
} catch (error) {
if (error instanceof DOMException === false) {
console.error(error);
}
} finally {
clearTimeout(timeout);
}

console.log('Server is NOT reachable');
process.exit(1);
};

void main();
Loading