fix(docker): keep synchronous I/O off the Docker tab render path #2641
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| #!/usr/bin/php -q | ||
| <?PHP | ||
| /* Copyright 2005-2025, Lime Technology | ||
| * Copyright 2012-2025, Bergware International. | ||
| * | ||
| * This program is free software; you can redistribute it and/or | ||
| * modify it under the terms of the GNU General Public License version 2, | ||
| * as published by the Free Software Foundation. | ||
| * | ||
| * A JSON cache of Tailscale status for each running container, plus some | ||
| * container agnostic metadata pulled from the network. | ||
| */ | ||
| ?> | ||
| <? | ||
| $docroot ??= ($_SERVER['DOCUMENT_ROOT'] ?: '/usr/local/emhttp'); | ||
| require_once "$docroot/webGui/include/publish.php"; | ||
|
|
||
| const TS_CACHE_FILE = '/var/lib/docker/unraid-tailscale-status.json'; | ||
| const TS_DERP_URL = 'https://login.tailscale.com/derpmap/default'; | ||
| const TS_VERSION_URL = 'https://pkgs.tailscale.com/stable/?mode=json'; | ||
| const TS_METADATA_REFRESH_S = 6 * 60 * 60; | ||
| const TS_POLL_INTERVAL_S = 10; | ||
| const TS_IDLE_INTERVAL_S = 60; | ||
| const TS_EXEC_TIMEOUT_S = 1; | ||
|
|
||
| function ts_fetch_json(string $url, int $timeout = 5) { | ||
| $ch = curl_init($url); | ||
| curl_setopt_array($ch, [ | ||
| CURLOPT_RETURNTRANSFER => true, | ||
| CURLOPT_CONNECTTIMEOUT => $timeout, | ||
| CURLOPT_TIMEOUT => $timeout, | ||
| CURLOPT_FOLLOWLOCATION => true, | ||
| CURLOPT_FAILONERROR => true, | ||
| ]); | ||
| $out = curl_exec($ch); | ||
| curl_close($ch); | ||
| if (!$out) return null; | ||
| $data = json_decode($out, true); | ||
| return is_array($data) ? $data : null; | ||
| } | ||
|
|
||
| // Gather containers with the label "tailscale.hostname" or "tailscale.webui", since | ||
| // these are what trigger a request for status upstream | ||
| function ts_list_containers(): array { | ||
| $names = []; | ||
| foreach (['hostname', 'webui'] as $kind) { | ||
| $raw = shell_exec('docker ps --filter "label=net.unraid.docker.tailscale.' . $kind . '" --format "{{.Names}}" 2>/dev/null') ?? ''; | ||
| foreach (preg_split('/\R/', $raw, -1, PREG_SPLIT_NO_EMPTY) as $name) { | ||
| $names[trim($name)] = true; | ||
| } | ||
| } | ||
| return array_keys($names); | ||
| } | ||
|
|
||
| function ts_container_status(string $name) { | ||
| $out = []; | ||
| $rc = 0; | ||
| $cmd = sprintf( | ||
| 'timeout %ds docker exec -i %s /bin/sh -c %s 2>/dev/null', | ||
| TS_EXEC_TIMEOUT_S, | ||
| escapeshellarg($name), | ||
| escapeshellarg('tailscale status --peers=false --json') | ||
| ); | ||
| exec($cmd, $out, $rc); | ||
| if ($rc !== 0 || empty($out)) return null; | ||
| $data = json_decode(implode("\n", $out), true); | ||
| return is_array($data) ? $data : null; | ||
| } | ||
|
|
||
| function ts_load_state(): array { | ||
| $state = ['derp' => null, 'derp_ts' => 0, 'version' => null, 'version_ts' => 0, 'containers' => [], 'ts' => 0]; | ||
| if (is_file(TS_CACHE_FILE)) { | ||
| $existing = @json_decode(@file_get_contents(TS_CACHE_FILE), true); | ||
| if (is_array($existing)) $state = array_replace($state, array_intersect_key($existing, $state)); | ||
| } | ||
| return $state; | ||
| } | ||
|
|
||
| function ts_save_state(array $state): void { | ||
| $tmp = TS_CACHE_FILE . '.tmp'; | ||
| if (@file_put_contents($tmp, json_encode($state, JSON_UNESCAPED_SLASHES)) !== false) { | ||
| @rename($tmp, TS_CACHE_FILE); | ||
| } | ||
| } | ||
|
|
||
| $state = ts_load_state(); | ||
|
|
||
| while (true) { | ||
| $now = time(); | ||
|
|
||
| // Tailscale metadata | ||
| if ($now - ($state['derp_ts'] ?? 0) > TS_METADATA_REFRESH_S) { | ||
| $derp = ts_fetch_json(TS_DERP_URL); | ||
| if ($derp) { $state['derp'] = $derp; $state['derp_ts'] = $now; } | ||
| } | ||
| if ($now - ($state['version_ts'] ?? 0) > TS_METADATA_REFRESH_S) { | ||
| $version = ts_fetch_json(TS_VERSION_URL); | ||
| if ($version) { $state['version'] = $version; $state['version_ts'] = $now; } | ||
| } | ||
|
|
||
| // Per-container status | ||
| $containers = ts_list_containers(); | ||
| $fresh = []; | ||
| foreach ($containers as $name) { | ||
| $status = ts_container_status($name); | ||
| if ($status !== null) { | ||
| $fresh[$name] = ['data' => $status, 'ts' => $now]; | ||
| } elseif (isset($state['containers'][$name]) && ($now - $state['containers'][$name]['ts']) < 60) { | ||
| $fresh[$name] = $state['containers'][$name]; | ||
| } | ||
| } | ||
| $state['containers'] = $fresh; | ||
| $state['ts'] = $now; | ||
|
|
||
| ts_save_state($state); | ||
|
Member
There was a problem hiding this comment. If this state hasn't changed, probably not worth saving, you can do the MD5 comparison and share the logic with the publish call as well.
Contributor
There was a problem hiding this comment. Instead of saving it at all, just store it in a static var. Also has the advantage of not having anything cached that survives an array stop / start or reboot |
||
|
|
||
| // Notify any watchers that the cache moved. We could push actual data here | ||
| // to get live tooltip updates, but that's overkill. A notification is all | ||
| // that we really want. | ||
| publish('tailscalestatus', json_encode(['ts' => $now]), 1, true); | ||
|
|
||
|
Contributor
There was a problem hiding this comment. For save and publish maybe worth only doing if it has changed.
Member
There was a problem hiding this comment. For clarification - we typically save an MD5 of the payload and then compare before publishing again, to preserve publish cycles. This is a simple optimization that may help out here.
Contributor
There was a problem hiding this comment. Publishing has to be done @SimonFair @elibosley @tspader See my full comment #2641 (comment) |
||
| sleep(empty($containers) ? TS_IDLE_INTERVAL_S : TS_POLL_INTERVAL_S); | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This new subscription assumes a publisher is already running, but
DockerContainers.pagestill declares onlyNchan="docker_load"in its header, soDefaultPageLayoutnever startsnchan/tailscale_status. On a normal page load there is therefore no process publishingtailscalestatus, the cache file is never refreshed, and Tailscale status/tooltips regress to stale or empty data for running containers.Useful? React with 👍 / 👎.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tspader - this seems like a legitimate finding to me, can you verify and look into adding this to the dockercontainers.page
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is required for dynamix to be able to stop the scripts on array stop etc.