Compare commits

...

10 Commits

Author SHA1 Message Date
beatz174-bit 4d681021e1 Merge pull request #15 from beatz174-bit/codex/add-logging-output-for-grafana-zolp0e
Fix Node-RED unknown-project errors when Grafana alert labels are missing
2026-04-13 06:20:19 +10:00
beatz174-bit 30f53eb668 Harden unknown-project Node-RED functions for missing labels 2026-04-13 06:19:57 +10:00
beatz174-bit a9593d7589 Merge pull request #14 from beatz174-bit/codex/add-logging-output-for-grafana
Add Node-RED update-event logging and Telegraf ingestion for Grafana
2026-04-13 06:13:29 +10:00
beatz174-bit 232fdfbb36 Wire Node-RED update events to structured update log file 2026-04-13 06:12:59 +10:00
beatz174-bit 9f9cfaf4be Merge pull request #13 from beatz174-bit/codex/review-grafana-docker-safe-update-flow
Fix Node-RED Grafana safe update flow parsing and lockout notifications
2026-04-13 05:51:43 +10:00
beatz174-bit 8337b53da3 Fix Grafana docker update flow label parsing and lockout notifications 2026-04-13 05:51:28 +10:00
git d519139615 new file: monitoring/node-red/data/.config.nodes.json
new file:   monitoring/node-red/data/.config.runtime.json
	new file:   monitoring/node-red/data/.config.runtime.json.backup
	new file:   monitoring/node-red/data/.config.users.json
	new file:   monitoring/node-red/data/.config.users.json.backup
	new file:   monitoring/node-red/data/.flows.json.backup
	new file:   monitoring/node-red/data/.flows_cred.json.backup
	new file:   monitoring/node-red/data/.npm/_cacache/content-v2/sha512/b0/47/c1458664fa9b6a08e9035110b523127a96bd7285d19472dc702f5dc498b927412b0ecd3273708fbf9d61754520599ac0b0e11f3e4c4d4ac784e78d7d97fe
	new file:   monitoring/node-red/data/.npm/_cacache/content-v2/sha512/c2/c2/b64870ea5c5a42b5772106f51123cf684d3c8381de10ccc07d01168d111d0a1ab79ee26fda320b3027c76cfc856119f7b440845a83c9f22d7d731643e62f
	new file:   monitoring/node-red/data/.npm/_cacache/index-v5/15/a4/2638498d877ec2c8c3d88cb9c08d7867c52d3fceb6fc64cc5abde73b01a9
	new file:   monitoring/node-red/data/.npm/_cacache/index-v5/48/03/b8903b717bbc1ad41b3f37148db48f54e0828c1aef870973f6672895d689
	new file:   monitoring/node-red/data/.npm/_logs/2026-04-05T01_36_15_515Z-debug-0.log
	new file:   monitoring/node-red/data/context/00b02bbd01c91485/flow.json
	new file:   monitoring/node-red/data/context/global/global.json
	new file:   monitoring/node-red/data/flows.json
	new file:   monitoring/node-red/data/flows_cred.json
	new file:   monitoring/node-red/data/node_modules/.package-lock.json
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/CHANGELOG.md
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/LICENSE
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/README.md
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/dist/flow-debugger.html
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/dist/flow-debugger.js
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/dist/flow-debugger.js.map
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/dist/lib/MessageQueue.js
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/dist/lib/MessageQueue.js.map
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/dist/lib/debugger.js
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/dist/lib/debugger.js.map
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/dist/lib/location.js
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/dist/lib/location.js.map
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/dist/lib/types.js
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/dist/lib/types.js.map
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/dist/locales/en-US/flow-debugger.json
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/dist/locales/ja/flow-debugger.json
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/dist/nr-types.js
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/dist/nr-types.js.map
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/package.json
	new file:   monitoring/node-red/data/node_modules/node-red-debugger/resources/style.css
	new file:   monitoring/node-red/data/package-lock.json
	new file:   monitoring/node-red/data/package.json
	new file:   monitoring/node-red/data/settings.js
	new file:   monitoring/node-red/data/test-container.sh
	new file:   monitoring/node-red/data/test-container.sh.old
	new file:   monitoring/node-red/data/webhook.json
2026-04-13 05:36:20 +10:00
git 8c5a902613 modified: .gitignore
modified:   default-environment.env
	modified:   monitoring/portainer/docker-compose.yml
	modified:   monitoring/prometheus/docker-compose.yml
	modified:   update-containers.log
2026-04-13 05:35:12 +10:00
beatz174-bit f09ac96e06 Merge pull request #12 from beatz174-bit/codex/add-api-toggles-for-portainer
Enable missing docker-socket-proxy API toggles required by Portainer
2026-04-08 10:17:24 +10:00
beatz174-bit 4ff815e73e Enable additional docker-socket-proxy APIs for Portainer 2026-04-08 10:17:10 +10:00
50 changed files with 5016 additions and 15 deletions
+1 -1
View File
@@ -9,7 +9,7 @@
apps/nextcloud/config/
core/crowdsec/config/
**/.env
!monitoring/node-red/data/
apps/stockfill/
apps/shift-recorder/
+1 -1
View File
@@ -61,4 +61,4 @@ PORTAINER_GODEBUG=netdns=cgo
# Node-red
DOCKER_SOCKET_PROXY_HOST=tcp://docker-socket-proxy:2375
DOCKER_SOCKET_PROXY_LOG_LEVEL=info
DOCKER_SOCKET_PROXY_LOG_LEVEL=debug
@@ -0,0 +1,160 @@
# Node-RED update logging for Grafana
This guide adds structured update-event logging to your existing Node-RED + Telegraf + Prometheus + Grafana stack without introducing Loki.
## Goal
Track and surface (in Grafana) the latest update attempts from Node-RED, including:
- when an update attempt started,
- target container/project,
- success/failure,
- optional failure reason,
- elapsed duration.
## 1) Add a reusable logger function in Node-RED
Create a **Function** node named `Build update log event` and use:
```javascript
const nowIso = new Date().toISOString();
const startedAt = msg.update_started_at || Date.now();
const durationMs = Math.max(0, Date.now() - startedAt);
const payload = msg.payload || {};
const labels = payload.labels || {};
const status = (msg.update_status || payload.status || "unknown").toString().toLowerCase();
const success = status === "success" ? 1 : 0;
const failed = status === "failed" ? 1 : 0;
msg.payload = {
ts: nowIso,
flow: "docker-updates",
event: msg.update_event || "attempt",
container: msg.container || labels.container || "unknown",
project: labels.com_docker_compose_project || msg.project || "unknown",
host: msg.host || "unknown",
status,
success,
failed,
duration_ms: durationMs,
code: Number.isFinite(Number(payload.code)) ? Number(payload.code) : 0,
error: (msg.update_error || payload.error || "").toString().slice(0, 300)
};
// one JSON line per event for file output
msg.payload = JSON.stringify(msg.payload);
return msg;
```
### Wiring recommendation
Use the same logger function in these branches:
- before a pull/update command (`update_status=started`, `update_event=attempt`),
- success path (`update_status=success`, `update_event=completed`),
- failure path (`update_status=failed`, `update_event=completed`, and include `msg.update_error`).
Then route each branch into a **File** node configured as:
- Filename: `/data/update-events.ndjson`
- Action: append to file
- Add newline: enabled
## 2) Make update state explicit in existing update flow
In your current update flow (already present in `flows.json`), add/change **Change** nodes around your shell/docker nodes:
- At update start:
- `msg.update_started_at = $millis()`
- `msg.update_status = "started"`
- `msg.update_event = "attempt"`
- At success:
- `msg.update_status = "success"`
- `msg.update_event = "completed"`
- At failure:
- `msg.update_status = "failed"`
- `msg.update_event = "completed"`
- `msg.update_error = msg.payload.stderr` (or equivalent error field)
## 3) Let Telegraf ingest Node-RED event logs
Append this to `monitoring/telegraf/telegraf.conf`:
```toml
[[inputs.tail]]
files = ["/var/log/node-red/update-events.ndjson"]
from_beginning = false
name_override = "node_red_update_event"
data_format = "json_v2"
[[inputs.tail.json_v2]]
measurement_name = "node_red_update_event"
[[inputs.tail.json_v2.tag]]
path = "flow"
[[inputs.tail.json_v2.tag]]
path = "event"
[[inputs.tail.json_v2.tag]]
path = "container"
[[inputs.tail.json_v2.tag]]
path = "project"
[[inputs.tail.json_v2.tag]]
path = "host"
[[inputs.tail.json_v2.tag]]
path = "status"
[[inputs.tail.json_v2.field]]
path = "success"
type = "int"
[[inputs.tail.json_v2.field]]
path = "failed"
type = "int"
[[inputs.tail.json_v2.field]]
path = "duration_ms"
type = "int"
[[inputs.tail.json_v2.field]]
path = "code"
type = "int"
```
And mount the Node-RED data directory into Telegraf (read-only) in `monitoring/prometheus/docker-compose.yml` under `telegraf.volumes`:
```yaml
- ${PROJECT_ROOT}/monitoring/node-red/data:/var/log/node-red:ro
```
## 4) Prometheus scrape (already in place)
No Prometheus scrape change is required as long as it already scrapes Telegraf (`telegraf:9273`).
## 5) Grafana queries to start with
Use your Prometheus data source and try:
- Latest success/failure by container:
- `last_over_time(node_red_update_event_success[24h])`
- `last_over_time(node_red_update_event_failed[24h])`
- Failed updates in the last 24h:
- `sum by (container, project) (increase(node_red_update_event_failed[24h]))`
- Average update duration in last 24h:
- `avg by (container, project) (avg_over_time(node_red_update_event_duration_ms[24h]))`
Recommended panels:
- **Table**: container, project, status (last value), duration_ms (last value)
- **Time series**: failed count over time
- **Stat**: total failed updates in last 24h
## 6) Validation checklist
1. Trigger a known update path (including one failure if possible).
2. Check Node-RED log file:
- `tail -n 20 monitoring/node-red/data/update-events.ndjson`
3. Check Telegraf metrics endpoint for `node_red_update_event_` metrics.
4. Confirm Grafana panel values match the latest Node-RED run.
## Optional next step
If you want searchable raw log text and richer log UX, add Loki + Promtail later. Keep this structured metrics path for high-signal alerting even after adding logs.
+430
View File
@@ -0,0 +1,430 @@
{
"node-red": {
"name": "node-red",
"version": "4.1.8",
"local": false,
"user": false,
"nodes": {
"junction": {
"name": "junction",
"types": [
"junction"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/common/05-junction.js"
},
"inject": {
"name": "inject",
"types": [
"inject"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/common/20-inject.js"
},
"debug": {
"name": "debug",
"types": [
"debug"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/common/21-debug.js"
},
"complete": {
"name": "complete",
"types": [
"complete"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/common/24-complete.js"
},
"catch": {
"name": "catch",
"types": [
"catch"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/common/25-catch.js"
},
"status": {
"name": "status",
"types": [
"status"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/common/25-status.js"
},
"link": {
"name": "link",
"types": [
"link in",
"link out",
"link call"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/common/60-link.js"
},
"comment": {
"name": "comment",
"types": [
"comment"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/common/90-comment.js"
},
"global-config": {
"name": "global-config",
"types": [
"global-config"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/common/91-global-config.js"
},
"unknown": {
"name": "unknown",
"types": [
"unknown"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/common/98-unknown.js"
},
"function": {
"name": "function",
"types": [
"function"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/function/10-function.js"
},
"switch": {
"name": "switch",
"types": [
"switch"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/function/10-switch.js"
},
"change": {
"name": "change",
"types": [
"change"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/function/15-change.js"
},
"range": {
"name": "range",
"types": [
"range"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/function/16-range.js"
},
"template": {
"name": "template",
"types": [
"template"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/function/80-template.js"
},
"delay": {
"name": "delay",
"types": [
"delay"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/function/89-delay.js"
},
"trigger": {
"name": "trigger",
"types": [
"trigger"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/function/89-trigger.js"
},
"exec": {
"name": "exec",
"types": [
"exec"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/function/90-exec.js"
},
"rbe": {
"name": "rbe",
"types": [
"rbe"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/function/rbe.js"
},
"tls": {
"name": "tls",
"types": [
"tls-config"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/network/05-tls.js"
},
"httpproxy": {
"name": "httpproxy",
"types": [
"http proxy"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/network/06-httpproxy.js"
},
"mqtt": {
"name": "mqtt",
"types": [
"mqtt in",
"mqtt out",
"mqtt-broker"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/network/10-mqtt.js"
},
"httpin": {
"name": "httpin",
"types": [
"http in",
"http response"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/network/21-httpin.js"
},
"httprequest": {
"name": "httprequest",
"types": [
"http request"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/network/21-httprequest.js"
},
"websocket": {
"name": "websocket",
"types": [
"websocket in",
"websocket out",
"websocket-listener",
"websocket-client"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/network/22-websocket.js"
},
"tcpin": {
"name": "tcpin",
"types": [
"tcp in",
"tcp out",
"tcp request"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/network/31-tcpin.js"
},
"udp": {
"name": "udp",
"types": [
"udp in",
"udp out"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/network/32-udp.js"
},
"CSV": {
"name": "CSV",
"types": [
"csv"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/parsers/70-CSV.js"
},
"HTML": {
"name": "HTML",
"types": [
"html"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/parsers/70-HTML.js"
},
"JSON": {
"name": "JSON",
"types": [
"json"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/parsers/70-JSON.js"
},
"XML": {
"name": "XML",
"types": [
"xml"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/parsers/70-XML.js"
},
"YAML": {
"name": "YAML",
"types": [
"yaml"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/parsers/70-YAML.js"
},
"split": {
"name": "split",
"types": [
"split",
"join"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/sequence/17-split.js"
},
"sort": {
"name": "sort",
"types": [
"sort"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/sequence/18-sort.js"
},
"batch": {
"name": "batch",
"types": [
"batch"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/sequence/19-batch.js"
},
"file": {
"name": "file",
"types": [
"file",
"file in"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/storage/10-file.js"
},
"watch": {
"name": "watch",
"types": [
"watch"
],
"enabled": true,
"local": false,
"user": false,
"module": "node-red",
"file": "/usr/src/node-red/node_modules/@node-red/nodes/core/storage/23-watch.js"
}
}
}
}
@@ -0,0 +1,5 @@
{
"instanceId": "22480a0b20f99f0c",
"_credentialSecret": "c128ee08a3b994abec9602b578cc23c8a395fd1259896c0c21609b46861a093e",
"telemetryEnabled": true
}
@@ -0,0 +1,4 @@
{
"instanceId": "22480a0b20f99f0c",
"_credentialSecret": "c128ee08a3b994abec9602b578cc23c8a395fd1259896c0c21609b46861a093e"
}
@@ -0,0 +1,29 @@
{
"_": {
"editor": {
"view": {
"view-store-zoom": false,
"view-store-position": false,
"view-show-grid": true,
"view-snap-grid": true,
"view-grid-size": 20,
"view-node-status": true,
"view-node-info-icon": true,
"view-node-show-label": true,
"view-show-tips": true,
"view-show-welcome-tours": true
},
"tours": {
"welcome": "4.1.8"
},
"dialog": {
"export": {
"pretty": true,
"json-view": true
}
}
},
"menu-menu-item-sidebar": true,
"menu-menu-item-palette": true
}
}
@@ -0,0 +1,29 @@
{
"_": {
"editor": {
"view": {
"view-store-zoom": false,
"view-store-position": false,
"view-show-grid": true,
"view-snap-grid": true,
"view-grid-size": 20,
"view-node-status": true,
"view-node-info-icon": true,
"view-node-show-label": true,
"view-show-tips": true,
"view-show-welcome-tours": true
},
"tours": {
"welcome": "4.1.8"
},
"dialog": {
"export": {
"pretty": true,
"json-view": true
}
}
},
"menu-menu-item-sidebar": false,
"menu-menu-item-palette": true
}
}
File diff suppressed because one or more lines are too long
@@ -0,0 +1,3 @@
{
"$": "3a4824a80803ad539950f337d67e528bZGBrGLreu0SvnxrH7vE1YhegoHsDWV1xaC+K2ZKHKVkduSQVcOTDerb6wuXV"
}
@@ -0,0 +1,2 @@
910aac156dabb4fcf662d29b6bd825588e1e1844 {"key":"make-fetch-happen:request-cache:https://registry.npmjs.org/node-red-debugger/-/node-red-debugger-1.1.1.tgz","integrity":"sha512-sEfBRYZk+ptqCOkDURC1IxJ6lr1yhdGUctxwL13EmLknQSsOzTJzcI+/nWF1RSBZmsCw4R8+TE1Kx4TnjX2X/g==","time":1775352975936,"size":22123,"metadata":{"time":1775352975918,"url":"https://registry.npmjs.org/node-red-debugger/-/node-red-debugger-1.1.1.tgz","reqHeaders":{},"resHeaders":{"cache-control":"public, immutable, max-age=31557600","content-type":"application/octet-stream","date":"Sun, 05 Apr 2026 01:36:15 GMT","etag":"\"8d40a313fd218e46c3e4fe78121b9267\"","last-modified":"Wed, 21 Jul 2021 11:15:11 GMT","vary":"Accept-Encoding"},"options":{"compress":true}}}
@@ -0,0 +1,2 @@
aaa2f94f98f0490d343865ece4ec971006a4f1c3 {"key":"make-fetch-happen:request-cache:https://registry.npmjs.org/node-red-debugger","integrity":"sha512-wsK2SHDqXFpCtXchBvURI89oTTyDgd4QzMB9ARaNER0KGree4m/aMgswJ8ds/IVhGfe0QIRag8nyLX1zFkPmLw==","time":1775352975866,"size":15640,"metadata":{"time":1775352975857,"url":"https://registry.npmjs.org/node-red-debugger","reqHeaders":{"accept":"application/json"},"resHeaders":{"cache-control":"public, max-age=300","content-encoding":"gzip","content-type":"application/json","date":"Sun, 05 Apr 2026 01:36:15 GMT","etag":"W/\"907dbbf9d3078f923fc58d814f174384\"","last-modified":"Wed, 11 May 2022 04:22:14 GMT","vary":"accept-encoding, accept"},"options":{"compress":true}}}
@@ -0,0 +1,29 @@
0 verbose cli /usr/local/bin/node /usr/local/bin/npm
1 info using npm@10.8.2
2 info using node@v20.20.1
3 silly config load:file:/usr/local/lib/node_modules/npm/npmrc
4 silly config load:file:/data/.npmrc
5 silly config load:file:/usr/src/node-red/.npmrc
6 silly config load:file:/usr/local/etc/npmrc
7 verbose title npm install node-red-debugger@1.1.1
8 verbose argv "install" "--no-audit" "--no-update-notifier" "--no-fund" "--save" "--save-prefix" "~" "--omit" "dev" "--engine-strict" "node-red-debugger@1.1.1"
9 verbose logfile logs-max:10 dir:/data/.npm/_logs/2026-04-05T01_36_15_515Z-
10 verbose logfile /data/.npm/_logs/2026-04-05T01_36_15_515Z-debug-0.log
11 silly packumentCache heap:2111832064 maxSize:527958016 maxEntrySize:263979008
12 silly logfile done cleaning log files
13 silly idealTree buildDeps
14 silly fetch manifest node-red-debugger@1.1.1
15 silly packumentCache full:https://registry.npmjs.org/node-red-debugger cache-miss
16 http fetch GET 200 https://registry.npmjs.org/node-red-debugger 101ms (cache miss)
17 silly packumentCache full:https://registry.npmjs.org/node-red-debugger set size:undefined disposed:false
18 silly placeDep ROOT node-red-debugger@1.1.1 OK for: node-red-project@0.0.1 want: 1.1.1
19 silly reify moves {}
20 silly tarball no local data for node-red-debugger@https://registry.npmjs.org/node-red-debugger/-/node-red-debugger-1.1.1.tgz. Extracting by manifest.
21 http fetch GET 200 https://registry.npmjs.org/node-red-debugger/-/node-red-debugger-1.1.1.tgz 55ms (cache miss)
22 silly ADD node_modules/node-red-debugger
23 verbose cwd /data
24 verbose os Linux 6.12.78
25 verbose node v20.20.1
26 verbose npm v10.8.2
27 verbose exit 0
28 info ok
@@ -0,0 +1,44 @@
{
"dockerUpdateAttempts": {
"node-exporter|prom/node-exporter:latest|docker": {
"time": 1775631942178,
"status": "started"
},
"prometheus|prom/prometheus:latest|docker": {
"time": 1775631942180,
"status": "started"
},
"nextcloud-redis|redis:latest|docker": {
"time": 1775631942186,
"status": "started"
},
"searxng-webapp|searxng/searxng:latest|docker": {
"time": 1775631942187,
"status": "started"
},
"traefik|traefik:3|docker": {
"time": 1775631942188,
"status": "started"
},
"traefik|unknown|raspi": {
"time": 1775631942191,
"status": "started"
},
"telegraf|unknown|raspi": {
"time": 1775763342447,
"status": "started"
},
"authelia|authelia/authelia:latest|docker": {
"time": 1775804742531,
"status": "started"
},
"passbolt-webapp|passbolt/passbolt:latest-ce|docker": {
"time": 1775804742539,
"status": "started"
},
"gramps-web|ghcr.io/gramps-project/grampsweb:latest|docker": {
"time": 1775891142715,
"status": "started"
}
}
}
@@ -0,0 +1,3 @@
{
"dockerUpdateAttempts": {}
}
File diff suppressed because one or more lines are too long
+3
View File
@@ -0,0 +1,3 @@
{
"$": "793e894c453e963b28f6b2f601eb1089FMPGL4pXtRVHmXNPWy9/lr/WoWBaGVA="
}
+14
View File
@@ -0,0 +1,14 @@
{
"name": "node-red-project",
"version": "0.0.1",
"lockfileVersion": 3,
"requires": true,
"packages": {
"node_modules/node-red-debugger": {
"version": "1.1.1",
"resolved": "https://registry.npmjs.org/node-red-debugger/-/node-red-debugger-1.1.1.tgz",
"integrity": "sha512-sEfBRYZk+ptqCOkDURC1IxJ6lr1yhdGUctxwL13EmLknQSsOzTJzcI+/nWF1RSBZmsCw4R8+TE1Kx4TnjX2X/g==",
"license": "Apache-2"
}
}
}
+19
View File
@@ -0,0 +1,19 @@
### 1.1.1
- Do not send full message object in messageQueued event Fixes #8
### 1.1.0
- Require Node-RED 2.0.0-beta.2
- Allow debugger to pause just breakpoint nodes
- Better display >99 message queue count on node annotation
- Publish debugger state as retained to make resync easier
- Add Japanese translations (#7) @kazuhitoyokoi
### 1.0.1
- Fix case sensitivity of filenames due to TypeScript being TypeScript
### 1.0.0
- First public release of the Flow Debugger
+178
View File
@@ -0,0 +1,178 @@
Copyright OpenJS Foundation and other contributors, https://openjsf.org/
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
+105
View File
@@ -0,0 +1,105 @@
# Node-RED Flow Debugger
This module is a Plugin for Node-RED 2.x. It provides a flow debugger with the following
features:
- set breakpoints on node inputs or outputs
- pause the runtime manually or when a message arrives at a breakpoint
- once paused you can:
- inspect the queued up messages
- step forward individual messages
- drop messages
## Installation
Install this module in your Node-RED user directory or via the Palette Manager
then restart Node-RED
npm install node-red-debugger
## Usage
The Flow Debugger adds a new sidebar tab in the editor. Select it from the dropdown
menu.
By default, the debugger is disabled. Click the 'disabled' toggle button to enable it.
The sidebar has two sections - a list of the breakpoints you have set and a list
of any messages queued up in the runtime.
### Working with breakpoints
With the debugger enabled, when you hover over a node's port a breakpoint indicator
will appear. Move your mouse over the indicator and click once - it will turn solid blue
and an entry will appear in the sidebar.
If you click on it again, the breakpoint will be deactivated but remain in place (light blue).
Clicking on it again will remove the breakpoint entirely (dotted outline).
You can also deactive a breakpoint using its checkbox in the sidebar, and remove it by
clicking the `x` button.
### Pausing the runtime
The runtime will by paused whenever a message arrives at an active breakpoint. You
can also manually pause the runtime using the pause button in the sidebar.
Once paused, the flow will show how many messages are queued up at each node input
and output. Those messages will also be listed in the sidebar - in the order the
runtime will process them.
If you click the step button at the top of the sidebar, the runtime will process
the next message in the list. You can step individual messages by clicking the
step button that appears when you hover over the message.
You can also delete any message from the queue by clicking its delete button. This
will prevent the message from passing any further in the flow.
You can click the play button to resume the flows.
## Limitations
- Due to the way Subflows work, breakpoints on Subflow outputs will be ignored
## Roadmap
- Set conditions on individual breakpoints
- Allow queued messages to be edited
- Pause only selected nodes/flows/groups
## Development
This plugin has been developed using TypeScript. This means that when running
from the source code rather than npm, it must first be built.
git clone https://github.com/node-red/node-red-debugger.git
cd node-red-debugger
npm install
npm run build
This will generate all of the plugin files in the `dist` folder - which is where
Node-RED will expect to load the files from.
Then, in your Node-RED user directory (`~/.node-red`) run:
npm install `<path to node-red-debugger directory>`
### Themeing
The Debugger sidebar will use the active Node-RED theme. For the breakpoints
drawn within the flow workspace, the following CSS variables will be used if they
are set by the active theme.
- `--red-ui-flow-debugger-breakpoint-fill`
- `--red-ui-flow-debugger-breakpoint-stroke`
- `--red-ui-flow-debugger-breakpoint-active-fill`
- `--red-ui-flow-debugger-breakpoint-active-stroke`
- `--red-ui-flow-debugger-breakpoint-inactive-fill`
- `--red-ui-flow-debugger-breakpoint-inactive-stroke`
- `--red-ui-flow-debugger-breakpoint-label`
- `--red-ui-flow-debugger-breakpoint-label-active`
File diff suppressed because one or more lines are too long
@@ -0,0 +1,140 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const debugger_1 = require("./lib/debugger");
const location_1 = require("./lib/location");
module.exports = (RED) => {
const apiRoot = "/flow-debugger";
RED.plugins.registerPlugin("node-red-debugger", {
onadd: () => {
const flowDebugger = new debugger_1.Debugger(RED);
const routeAuthHandler = RED.auth.needsPermission("flow-debugger.write");
RED.comms.publish("flow-debugger/connected", true, true);
function publishState() {
RED.comms.publish("flow-debugger/state", flowDebugger.getState());
}
flowDebugger.on("paused", (event) => {
RED.comms.publish("flow-debugger/paused", event);
});
flowDebugger.on("resumed", (event) => {
RED.comms.publish("flow-debugger/resumed", event);
});
flowDebugger.on("messageQueued", (event) => {
// Don't include the full message on the event
// event.msg = RED.util.encodeObject({msg:event.msg}, {maxLength: 100});
delete event.msg;
RED.comms.publish("flow-debugger/messageQueued", event);
});
flowDebugger.on("messageDispatched", (event) => {
RED.comms.publish("flow-debugger/messageDispatched", event);
});
// flowDebugger.on("step", (event) => {
//
// });
RED.httpAdmin.get(`${apiRoot}`, (_, res) => {
res.json(flowDebugger.getState());
});
RED.httpAdmin.put(`${apiRoot}`, routeAuthHandler, (req, res) => {
let stateChanged = false;
if (req.body.hasOwnProperty("enabled")) {
const enabled = !!req.body.enabled;
if (enabled && !flowDebugger.enabled) {
flowDebugger.enable();
stateChanged = true;
}
else if (!enabled && flowDebugger.enabled) {
flowDebugger.disable();
stateChanged = true;
}
}
if (req.body.hasOwnProperty("config")) {
stateChanged = flowDebugger.setConfig(req.body.config);
}
if (stateChanged) {
publishState();
}
res.json(flowDebugger.getState());
});
RED.httpAdmin.get(`${apiRoot}/breakpoints`, routeAuthHandler, (_, res) => {
res.json(flowDebugger.getBreakpoints());
});
RED.httpAdmin.put(`${apiRoot}/breakpoints/:id`, routeAuthHandler, (req, res) => {
flowDebugger.setBreakpointActive(req.params.id, req.body.active);
res.json(flowDebugger.getBreakpoint(req.params.id));
});
RED.httpAdmin.delete(`${apiRoot}/breakpoints/:id`, routeAuthHandler, (req, res) => {
flowDebugger.clearBreakpoint(req.params.id);
res.sendStatus(200);
});
RED.httpAdmin.post(`${apiRoot}/breakpoints`, routeAuthHandler, (req, res) => {
// req.body.location
const breakpointId = flowDebugger.setBreakpoint(new location_1.Location(req.body.id, req.body.path, req.body.portType, req.body.portIndex));
res.json(flowDebugger.getBreakpoint(breakpointId));
});
RED.httpAdmin.get(`${apiRoot}/messages`, routeAuthHandler, (_, res) => {
res.json(Array.from(flowDebugger.getMessageQueue()).map(m => {
const result = {
id: m.id,
location: m.location.toString(),
destination: undefined,
msg: RED.util.encodeObject({ msg: m.event.msg }, { maxLength: 100 })
};
if (m.event.hasOwnProperty('source')) {
// SendEvent - so include the destination location id
result.destination = m.event.destination.id + "[i][0]";
}
return result;
}));
});
RED.httpAdmin.get(`${apiRoot}/messages/:id`, routeAuthHandler, (req, res) => {
const id = req.params.id;
const messageEvent = flowDebugger.getMessageQueue().get(parseInt(id, 10));
if (messageEvent) {
const result = {
id: messageEvent.id,
location: messageEvent.location,
destination: undefined,
msg: RED.util.encodeObject({ msg: messageEvent.event.msg }, { maxLength: 100 })
};
if (messageEvent.event.hasOwnProperty('source')) {
// SendEvent - so include the destination location id
result.destination = messageEvent.event.destination.id + "[i][0]";
}
res.json(result);
}
else {
res.sendStatus(404);
}
});
RED.httpAdmin.delete(`${apiRoot}/messages/:id`, routeAuthHandler, (req, res) => {
flowDebugger.deleteMessage(parseInt(req.params.id, 10));
res.sendStatus(200);
});
RED.httpAdmin.post(`${apiRoot}/pause`, routeAuthHandler, (_, res) => {
flowDebugger.pause();
res.sendStatus(200);
});
RED.httpAdmin.post(`${apiRoot}/step`, routeAuthHandler, (req, res) => {
let stepMessage = null;
if (req.body && req.body.message) {
stepMessage = req.body.message;
}
flowDebugger.step(stepMessage);
res.sendStatus(200);
});
RED.httpAdmin.post(`${apiRoot}/resume`, routeAuthHandler, (_, res) => {
flowDebugger.resume();
res.sendStatus(200);
});
}
});
};
/*
/flow-debugger/enable
/flow-debugger/disable
/flow-debugger/breakpoint
*/
//# sourceMappingURL=flow-debugger.js.map
File diff suppressed because one or more lines are too long
@@ -0,0 +1,83 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.MessageQueue = void 0;
class MessageQueue {
constructor(queueName) {
this.queueName = queueName;
this.previousName = `previousBy${queueName}`;
this.nextName = `nextBy${queueName}`;
this.length = 0;
}
enqueue(event) {
if (!this.head) {
this.head = event;
}
event[this.previousName] = this.tail;
if (this.tail) {
this.tail[this.nextName] = event;
}
this.tail = event;
this.length++;
}
next() {
const result = this.head;
if (result) {
this.remove(result);
this.length--;
}
return result;
}
peek() {
return this.head;
}
get(id) {
let p = this.head;
while (p) {
if (p.id === id) {
return p;
}
p = p[this.nextName];
}
}
remove(event) {
const previousEvent = event[this.previousName];
const nextEvent = event[this.nextName];
if (previousEvent) {
previousEvent[this.nextName] = nextEvent;
}
else {
this.head = nextEvent;
}
if (nextEvent) {
nextEvent[this.previousName] = previousEvent;
}
else {
this.tail = previousEvent;
}
this.length--;
}
*[Symbol.iterator]() {
let p = this.head;
while (p) {
yield p;
p = p[this.nextName];
}
}
dump() {
let result = `MessageQueue ${this.queueName} [${this.length}]
head: ${this.head.id}
tail: ${this.tail.id}
list: `;
let p = this.head;
while (p) {
result = result + p.id;
p = p[this.nextName];
if (p) {
result += " > ";
}
}
return result;
}
}
exports.MessageQueue = MessageQueue;
//# sourceMappingURL=MessageQueue.js.map
@@ -0,0 +1 @@
{"version":3,"file":"MessageQueue.js","sourceRoot":"","sources":["../../src/lib/MessageQueue.ts"],"names":[],"mappings":";;;AAEA,MAAa,YAAY;IAQrB,YAAY,SAAgB;QACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,YAAY,GAAG,aAAa,SAAS,EAAE,CAAA;QAC5C,IAAI,CAAC,QAAQ,GAAG,SAAS,SAAS,EAAE,CAAA;QACpC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IACpB,CAAC;IACD,OAAO,CAAC,KAAkB;QACtB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACZ,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;SACrB;QACD,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC;QACrC,IAAI,IAAI,CAAC,IAAI,EAAE;YACX,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;SACpC;QACD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;QAClB,IAAI,CAAC,MAAM,EAAE,CAAC;IAClB,CAAC;IACD,IAAI;QACA,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC;QACzB,IAAI,MAAM,EAAE;YACR,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACpB,IAAI,CAAC,MAAM,EAAE,CAAC;SACjB;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IACD,IAAI;QACA,OAAO,IAAI,CAAC,IAAI,CAAC;IACrB,CAAC;IACD,GAAG,CAAC,EAAS;QACT,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC;QAClB,OAAM,CAAC,EAAE;YACL,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE;gBACb,OAAO,CAAC,CAAC;aACZ;YACD,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;SACvB;IACL,CAAC;IACD,MAAM,CAAC,KAAkB;QACrB,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC/C,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,aAAa,EAAE;YACf,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;SAC5C;aAAM;YACH,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;SACzB;QACD,IAAI,SAAS,EAAE;YACX,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,aAAa,CAAC;SAChD;aAAM;YACH,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;SAC7B;QACD,IAAI,CAAC,MAAM,EAAE,CAAC;IAClB,CAAC;IACD,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;QACd,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC;QAClB,OAAM,CAAC,EAAE;YACL,MAAM,CAAC,CAAC;YACR,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACxB;IACL,CAAC;IACD,IAAI;QACA,IAAI,MAAM,GAAG,gBAAgB,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,MAAM;UACzD,IAAI,CAAC,IAAI,CAAC,EAAE;UACZ,IAAI,CAAC,IAAI,CAAC,EAAE;SACb,CAAC;QACF,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC;QAClB,OAAM,CAAC,EAAE;YACL,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;YACvB,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACrB,IAAI,CAAC,EAAE;gBACH,MAAM,IAAI,KAAK,CAAC;aACnB;SACJ;QACD,OAAO,MAAM,CAAA;IAEjB,CAAC;CACJ;AAnFD,oCAmFC"}
@@ -0,0 +1,370 @@
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Debugger = void 0;
const Location = __importStar(require("./location"));
const MessageQueue_1 = require("./MessageQueue");
const events_1 = require("events");
const DEBUGGER_PAUSED = Symbol("node-red-debugger: paused");
let BREAKPOINT_ID = 1;
class Debugger extends events_1.EventEmitter {
// Events:
// paused / resumed
constructor(RED) {
super();
this.config = {
breakpointAction: "pause-all"
};
this.RED = RED;
this.enabled = false;
this.breakpoints = new Map();
this.pausedLocations = new Set();
this.breakpointsByLocation = new Map();
this.queuesByLocation = {};
this.messageQueue = new MessageQueue_1.MessageQueue("Time");
this.eventNumber = 0;
}
log(message) {
this.RED.log.info(`[flow-debugger] ${message}`);
}
checkLocation(location, event, done) {
const breakpointId = location.getBreakpointLocation();
if (this.isNodePaused(location.id)) {
this.queueEvent(location, event, done);
}
else {
if (event.msg && event.msg[DEBUGGER_PAUSED]) {
this.pause({
reason: "step",
node: location.id
});
this.queueEvent(location, event, done);
}
else {
const bp = this.breakpointsByLocation.get(breakpointId);
if (bp && bp.active) {
this.pause({
reason: "breakpoint",
node: location.id,
breakpoint: bp.id
});
this.queueEvent(location, event, done);
}
else {
done();
}
}
}
}
enable() {
this.log("Enabled");
this.enabled = true;
this.RED.hooks.add("preRoute.flow-debugger", (sendEvent, done) => {
if (isNodeInSubflowModule(sendEvent.source.node)) {
// Inside a subflow module - don't pause the event
done();
return;
}
if (sendEvent.source.node._flow.TYPE !== "flow" && sendEvent.source.node.id === sendEvent.source.node._flow.id) {
// This is the subflow output which, in the current implementation
// means the message is actually about to be routed to the first node
// inside the subflow, not the output of actual subflow.
done();
return;
}
if (sendEvent.cloneMessage) {
sendEvent.msg = this.RED.util.cloneMessage(sendEvent.msg);
sendEvent.cloneMessage = false;
}
const eventLocation = Location.createLocation(sendEvent);
// console.log("preRoute",eventLocation.toString());
this.checkLocation(eventLocation, sendEvent, done);
});
this.RED.hooks.add("onReceive.flow-debugger", (receiveEvent, done) => {
if (receiveEvent.destination.node.type === "inject") {
// Never pause an Inject node's internal receive event
done();
return;
}
if (isNodeInSubflowModule(receiveEvent.destination.node)) {
// Inside a subflow module - don't pause the event
done();
return;
}
const eventLocation = Location.createLocation(receiveEvent);
// console.log("onReceive",eventLocation.toString());
this.checkLocation(eventLocation, receiveEvent, done);
});
}
disable() {
this.log("Disabled");
this.enabled = false;
this.RED.hooks.remove("*.flow-debugger");
this.pausedLocations.clear();
this.drainQueues(true);
}
pause(event) {
if (this.enabled) {
let logReason;
if (event) {
if (this.config.breakpointAction === "pause-all") {
this.pausedLocations.clear();
this.pausedLocations.add("*");
}
else {
this.pausedLocations.add(event.node);
}
if (event.reason === "breakpoint") {
logReason = "@" + this.breakpoints.get(event.breakpoint).location.toString();
}
else if (event.reason === "step") {
logReason = "@" + event.node;
}
event.pausedLocations = [...this.pausedLocations];
}
else {
// Manual pause
this.pausedLocations.clear();
this.pausedLocations.add("*");
logReason = "manual";
}
this.log(`Flows paused: ${logReason}`);
this.emit("paused", event || { reason: "manual" });
}
}
resume(nodeId) {
if (this.pausedLocations.size === 0) {
return;
}
if (!nodeId || nodeId === "*") {
console.log("resume - clear all locations");
this.pausedLocations.clear();
}
else if (nodeId && this.pausedLocations.has(nodeId)) {
this.pausedLocations.delete(nodeId);
}
else {
// Nothing has been unpaused
return;
}
this.log("Flows resumed");
this.emit("resumed", { node: nodeId });
this.drainQueues();
}
deleteMessage(messageId) {
const nextEvent = this.messageQueue.get(messageId);
if (nextEvent) {
this.messageQueue.remove(nextEvent);
const nextEventLocation = nextEvent.location.toString();
this.queuesByLocation[nextEventLocation].remove(nextEvent);
const queueDepth = this.queuesByLocation[nextEventLocation].length;
if (queueDepth === 0) {
delete this.queuesByLocation[nextEventLocation];
}
this.emit("messageDispatched", { id: nextEvent.id, location: nextEventLocation, depth: queueDepth });
// Call done with false to prevent any further processing
nextEvent.done(false);
}
}
isNodePaused(nodeId) {
return this.pausedLocations.has("*") || this.pausedLocations.has(nodeId);
}
drainQueues(quiet) {
for (const nextEvent of this.messageQueue) {
const eventNodeId = nextEvent.location.id;
if (!this.isNodePaused(eventNodeId)) {
const nextEventLocation = nextEvent.location.toString();
this.queuesByLocation[nextEventLocation].remove(nextEvent);
const queueDepth = this.queuesByLocation[nextEventLocation].length;
if (queueDepth === 0) {
delete this.queuesByLocation[nextEventLocation];
}
if (!quiet) {
this.emit("messageDispatched", { id: nextEvent.id, location: nextEventLocation, depth: queueDepth });
}
if (nextEvent.event.msg[DEBUGGER_PAUSED]) {
delete nextEvent.event.msg[DEBUGGER_PAUSED];
}
nextEvent.done();
this.messageQueue.remove(nextEvent);
}
}
}
setBreakpoint(location) {
const bp = {
id: (BREAKPOINT_ID++) + "",
location,
active: true,
mode: "all"
};
this.breakpoints.set(bp.id, bp);
this.breakpointsByLocation.set(location.toString(), bp);
return bp.id;
}
getBreakpoint(breakpointId) {
return this.breakpoints.get(breakpointId);
}
setBreakpointActive(breakpointId, state) {
const bp = this.breakpoints.get(breakpointId);
if (bp) {
bp.active = state;
}
}
clearBreakpoint(breakpointId) {
const bp = this.breakpoints.get(breakpointId);
if (bp) {
this.breakpoints.delete(breakpointId);
this.breakpointsByLocation.delete(bp.location.toString());
}
}
getBreakpoints() {
return Array.from(this.breakpoints.values());
}
step(messageId) {
if (this.enabled) {
let nextEvent;
if (messageId) {
nextEvent = this.messageQueue.get(messageId);
if (nextEvent) {
this.messageQueue.remove(nextEvent);
}
}
else {
nextEvent = this.messageQueue.next();
}
if (nextEvent) {
const nextEventLocation = nextEvent.location.toString();
this.log("Step: " + nextEventLocation);
this.queuesByLocation[nextEventLocation].remove(nextEvent);
const queueDepth = this.queuesByLocation[nextEventLocation].length;
if (queueDepth === 0) {
delete this.queuesByLocation[nextEventLocation];
}
nextEvent.event.msg[DEBUGGER_PAUSED] = true;
this.emit("messageDispatched", { id: nextEvent.id, location: nextEventLocation, depth: queueDepth });
nextEvent.done();
}
}
}
setConfig(newConfig) {
let changed = false;
for (const key in this.config) {
if (newConfig.hasOwnProperty(key) && this.config[key] !== newConfig[key]) {
changed = true;
this.config[key] = newConfig[key];
}
}
return changed;
}
getState() {
if (!this.enabled) {
return { enabled: false };
}
return {
enabled: true,
pausedLocations: [...this.pausedLocations],
config: this.config,
breakpoints: this.getBreakpoints(),
queues: this.getMessageQueueDepths()
};
}
getMessageSummary() {
return Array.from(this.messageQueue).map(m => {
return {
id: m.id,
location: m.location
};
});
}
getMessageQueue() {
return this.messageQueue;
}
getMessageQueueDepths() {
if (!this.enabled) {
return {};
}
const result = {};
for (const [locationId, queue] of Object.entries(this.queuesByLocation)) {
result[locationId] = { depth: queue.length };
}
return result;
}
dump() {
let result = `Debugger State
---
${this.messageQueue.dump()}
`;
const locationIds = Object.keys(this.queuesByLocation);
locationIds.forEach(id => {
result += `---
Location: ${id}
${this.queuesByLocation[id].dump()}
`;
});
return result;
}
queueEvent(location, event, done) {
const locationId = location.toString();
if (!this.queuesByLocation[locationId]) {
this.queuesByLocation[locationId] = new MessageQueue_1.MessageQueue("Location");
}
const messageEvent = {
id: this.eventNumber++,
event,
location,
done,
nextByLocation: null,
previousByLocation: null,
nextByTime: null,
previousByTime: null
};
this.queuesByLocation[locationId].enqueue(messageEvent);
this.messageQueue.enqueue(messageEvent);
const queuedEvent = {
id: messageEvent.id,
location: locationId,
msg: event.msg,
depth: this.queuesByLocation[locationId].length,
destination: null,
};
if (event.hasOwnProperty('source')) {
// SendEvent - so include the destination location id
queuedEvent.destination = "/" + event.destination.id + "[i][0]";
}
this.emit("messageQueued", queuedEvent);
}
}
exports.Debugger = Debugger;
const MODULE_TYPE_RE = /^module:/;
function isNodeInSubflowModule(node) {
let f = node._flow;
do {
if (f.TYPE === "flow") {
return false;
}
if (MODULE_TYPE_RE.test(f.TYPE)) {
return true;
}
f = f.parent;
} while (f && f.TYPE);
return false;
}
//# sourceMappingURL=debugger.js.map
File diff suppressed because one or more lines are too long
@@ -0,0 +1,46 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.createLocation = exports.Location = void 0;
class Location {
constructor(nodeId, nodePath, portType = "o", portIndex = 0) {
this.inSubflow = false;
this.id = nodeId;
this.path = nodePath;
this.portType = portType;
this.portIndex = portIndex;
}
getBreakpointLocation() {
if (this.inSubflow) {
return `*/${this.id}[${this.portType}][${this.portIndex}]`;
}
else {
return this.toString();
}
}
toString() {
return `${this.path}/${this.id}[${this.portType}][${this.portIndex}]`;
}
}
exports.Location = Location;
function createLocation(event) {
let node;
let portType;
let portIndex;
if (event.hasOwnProperty("source")) {
node = event.source.node;
portType = "o";
portIndex = event.source.port;
}
else {
node = event.destination.node;
portType = "i";
portIndex = 0;
}
const l = new Location(node._alias || node.id, node._flow.path, portType, portIndex);
if (node._alias) {
l.inSubflow = true;
}
return l;
}
exports.createLocation = createLocation;
//# sourceMappingURL=location.js.map
@@ -0,0 +1 @@
{"version":3,"file":"location.js","sourceRoot":"","sources":["../../src/lib/location.ts"],"names":[],"mappings":";;;AAIA,MAAa,QAAQ;IAYjB,YAAY,MAAa,EAAE,QAAe,EAAE,WAAkB,GAAG,EAAE,SAAS,GAAC,CAAC;QAF9E,cAAS,GAAW,KAAK,CAAC;QAGtB,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;IACD,qBAAqB;QACjB,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,OAAO,KAAK,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,SAAS,GAAG,CAAA;SAC7D;aAAM;YACH,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;SAC1B;IACL,CAAC;IACD,QAAQ;QACJ,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,SAAS,GAAG,CAAA;IACzE,CAAC;CACJ;AA5BD,4BA4BC;AAED,SAAgB,cAAc,CAAC,KAA4B;IACvD,IAAI,IAAQ,CAAC;IACb,IAAI,QAAiB,CAAC;IACtB,IAAI,SAAgB,CAAC;IACrB,IAAI,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;QAChC,IAAI,GAAI,KAAmB,CAAC,MAAM,CAAC,IAAI,CAAC;QACxC,QAAQ,GAAG,GAAG,CAAC;QACf,SAAS,GAAI,KAAmB,CAAC,MAAM,CAAC,IAAI,CAAC;KAChD;SAAM;QACH,IAAI,GAAI,KAAsB,CAAC,WAAW,CAAC,IAAI,CAAC;QAChD,QAAQ,GAAG,GAAG,CAAC;QACf,SAAS,GAAG,CAAC,CAAC;KACjB;IACD,MAAM,CAAC,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IACrF,IAAI,IAAI,CAAC,MAAM,EAAE;QACb,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;KACtB;IACD,OAAO,CAAC,CAAC;AACb,CAAC;AAlBD,wCAkBC"}
@@ -0,0 +1,3 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
//# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,27 @@
{
"label": {
"debugger": "Flow Debugger",
"debuggerShort": "debugger",
"breakpoints": "Breakpoints",
"messages":"Messages",
"output": "output",
"input": "input",
"paused": "Flows paused",
"resume": "Resume flows",
"step": "Step flows",
"pause": "Pause flows",
"deleteMessage": "Delete message",
"stepMessage": "Step message",
"filter": {
"label": "Filter messages",
"all": "all nodes",
"flow": "current flow"
},
"settings": "Debugger options",
"breakpointAction": {
"label": "Breakpoint action",
"pause-all": "pause all nodes",
"pause-bp": "pause at breakpoint"
}
}
}
@@ -0,0 +1,27 @@
{
"label": {
"debugger": "フローデバッガ",
"debuggerShort": "デバッガ",
"breakpoints": "ブレイクポイント",
"messages": "メッセージ",
"output": "出力",
"input": "入力",
"paused": "フローを停止しました",
"resume": "フローを再開",
"step": "フローをステップ実行",
"pause": "フローを停止",
"deleteMessage": "メッセージを削除",
"stepMessage": "メッセージをステップ実行",
"filter": {
"label": "メッセージの絞り込み",
"all": "全てのノード",
"flow": "現在のフロー"
},
"settings": "デバッガオプション",
"breakpointAction": {
"label": "ブレイクポイントの動作",
"pause-all": "全てのノードを停止",
"pause-bp": "ブレイクポイントで停止"
}
}
}
@@ -0,0 +1,3 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
//# sourceMappingURL=nr-types.js.map
@@ -0,0 +1 @@
{"version":3,"file":"nr-types.js","sourceRoot":"","sources":["../src/nr-types.ts"],"names":[],"mappings":""}
+37
View File
@@ -0,0 +1,37 @@
{
"name": "node-red-debugger",
"version": "1.1.1",
"description": "A flow debugger for Node-RED 2.x",
"repository": {
"type": "git",
"url": "https://github.com/node-red/node-red-debugger.git"
},
"scripts": {
"build": "(tsc || exit 1) && npm run tslint && npm run copyAssets",
"tslint": "tslint -c tslint.json -p tsconfig.json",
"copyAssets": "node scripts/copy-static-assets.js",
"dev": "nodemon --exec 'npm run build' -i dist -i resources -e 'ts html css'",
"test": "npm run build"
},
"keywords": ["node-red","debugger"],
"author": "Nick O'Leary <nick.oleary@gmail.com>",
"files": [
"dist",
"resources"
],
"license": "Apache-2",
"node-red": {
"version": ">=2.0.0",
"plugins": {
"flow-debugger": "dist/flow-debugger.js"
}
},
"devDependencies": {
"@types/node": "^15.12.2",
"fs-extra": "^10.0.0",
"html-minifier": "^4.0.0",
"nodemon": "^2.0.7",
"tslint": "^6.1.3",
"typescript": "^4.3.2"
}
}
File diff suppressed because one or more lines are too long
+21
View File
@@ -0,0 +1,21 @@
{
"name": "node-red-project",
"version": "0.0.1",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "node-red-project",
"version": "0.0.1",
"dependencies": {
"node-red-debugger": "~1.1.1"
}
},
"node_modules/node-red-debugger": {
"version": "1.1.1",
"resolved": "https://registry.npmjs.org/node-red-debugger/-/node-red-debugger-1.1.1.tgz",
"integrity": "sha512-sEfBRYZk+ptqCOkDURC1IxJ6lr1yhdGUctxwL13EmLknQSsOzTJzcI+/nWF1RSBZmsCw4R8+TE1Kx4TnjX2X/g==",
"license": "Apache-2"
}
}
}
+9
View File
@@ -0,0 +1,9 @@
{
"name": "node-red-project",
"description": "A Node-RED Project",
"version": "0.0.1",
"private": true,
"dependencies": {
"node-red-debugger": "~1.1.1"
}
}
+623
View File
@@ -0,0 +1,623 @@
/**
* This is the default settings file provided by Node-RED.
*
* It can contain any valid JavaScript code that will get run when Node-RED
* is started.
*
* Lines that start with // are commented out.
* Each entry should be separated from the entries above and below by a comma ','
*
* For more information about individual settings, refer to the documentation:
* https://nodered.org/docs/user-guide/runtime/configuration
*
* The settings are split into the following sections:
* - Flow File and User Directory Settings
* - Security
* - Server Settings
* - Runtime Settings
* - Editor Settings
* - Node Settings
*
**/
module.exports = {
/*******************************************************************************
* Flow File and User Directory Settings
* - flowFile
* - credentialSecret
* - flowFilePretty
* - userDir
* - nodesDir
******************************************************************************/
/** The file containing the flows. If not set, defaults to flows_<hostname>.json **/
flowFile: 'flows.json',
/** By default, credentials are encrypted in storage using a generated key. To
* specify your own secret, set the following property.
* If you want to disable encryption of credentials, set this property to false.
* Note: once you set this property, do not change it - doing so will prevent
* node-red from being able to decrypt your existing credentials and they will be
* lost.
*/
//credentialSecret: "a-secret-key",
/** By default, the flow JSON will be formatted over multiple lines making
* it easier to compare changes when using version control.
* To disable pretty-printing of the JSON set the following property to false.
*/
flowFilePretty: true,
/** By default, all user data is stored in a directory called `.node-red` under
* the user's home directory. To use a different location, the following
* property can be used
*/
//userDir: '/home/nol/.node-red/',
/** Node-RED scans the `nodes` directory in the userDir to find local node files.
* The following property can be used to specify an additional directory to scan.
*/
//nodesDir: '/home/nol/.node-red/nodes',
/*******************************************************************************
* Security
* - adminAuth
* - https
* - httpsRefreshInterval
* - requireHttps
* - httpNodeAuth
* - httpStaticAuth
******************************************************************************/
/** To password protect the Node-RED editor and admin API, the following
* property can be used. See https://nodered.org/docs/security.html for details.
*/
//adminAuth: {
// type: "credentials",
// users: [{
// username: "admin",
// password: "$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN.",
// permissions: "*"
// }]
//},
/** The following property can be used to enable HTTPS
* This property can be either an object, containing both a (private) key
* and a (public) certificate, or a function that returns such an object.
* See http://nodejs.org/api/https.html#https_https_createserver_options_requestlistener
* for details of its contents.
*/
/** Option 1: static object */
//https: {
// key: require("fs").readFileSync('privkey.pem'),
// cert: require("fs").readFileSync('cert.pem')
//},
/** Option 2: function that returns the HTTP configuration object */
// https: function() {
// // This function should return the options object, or a Promise
// // that resolves to the options object
// return {
// key: require("fs").readFileSync('privkey.pem'),
// cert: require("fs").readFileSync('cert.pem')
// }
// },
/** If the `https` setting is a function, the following setting can be used
* to set how often, in hours, the function will be called. That can be used
* to refresh any certificates.
*/
//httpsRefreshInterval : 12,
/** The following property can be used to cause insecure HTTP connections to
* be redirected to HTTPS.
*/
//requireHttps: true,
/** To password protect the node-defined HTTP endpoints (httpNodeRoot),
* including node-red-dashboard, or the static content (httpStatic), the
* following properties can be used.
* The `pass` field is a bcrypt hash of the password.
* See https://nodered.org/docs/security.html#generating-the-password-hash
*/
//httpNodeAuth: {user:"user",pass:"$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN."},
//httpStaticAuth: {user:"user",pass:"$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN."},
/*******************************************************************************
* Server Settings
* - uiPort
* - uiHost
* - apiMaxLength
* - httpServerOptions
* - httpAdminRoot
* - httpAdminMiddleware
* - httpAdminCookieOptions
* - httpNodeRoot
* - httpNodeCors
* - httpNodeMiddleware
* - httpStatic
* - httpStaticRoot
* - httpStaticCors
******************************************************************************/
/** the tcp port that the Node-RED web server is listening on */
uiPort: process.env.PORT || 1880,
/** By default, the Node-RED UI accepts connections on all IPv4 interfaces.
* To listen on all IPv6 addresses, set uiHost to "::",
* The following property can be used to listen on a specific interface. For
* example, the following would only allow connections from the local machine.
*/
//uiHost: "127.0.0.1",
/** The maximum size of HTTP request that will be accepted by the runtime api.
* Default: 5mb
*/
//apiMaxLength: '5mb',
/** The following property can be used to pass custom options to the Express.js
* server used by Node-RED. For a full list of available options, refer
* to http://expressjs.com/en/api.html#app.settings.table
*/
//httpServerOptions: { },
/** By default, the Node-RED UI is available at http://localhost:1880/
* The following property can be used to specify a different root path.
* If set to false, this is disabled.
*/
//httpAdminRoot: '/admin',
/** The following property can be used to add a custom middleware function
* in front of all admin http routes. For example, to set custom http
* headers. It can be a single function or an array of middleware functions.
*/
// httpAdminMiddleware: function(req,res,next) {
// // Set the X-Frame-Options header to limit where the editor
// // can be embedded
// //res.set('X-Frame-Options', 'sameorigin');
// next();
// },
/** The following property can be used to set addition options on the session
* cookie used as part of adminAuth authentication system
* Available options are documented here: https://www.npmjs.com/package/express-session#cookie
*/
// httpAdminCookieOptions: { },
/** Some nodes, such as HTTP In, can be used to listen for incoming http requests.
* By default, these are served relative to '/'. The following property
* can be used to specify a different root path. If set to false, this is
* disabled.
*/
//httpNodeRoot: '/red-nodes',
/** The following property can be used to configure cross-origin resource sharing
* in the HTTP nodes.
* See https://github.com/troygoode/node-cors#configuration-options for
* details on its contents. The following is a basic permissive set of options:
*/
//httpNodeCors: {
// origin: "*",
// methods: "GET,PUT,POST,DELETE"
//},
/** If you need to set an http proxy please set an environment variable
* called http_proxy (or HTTP_PROXY) outside of Node-RED in the operating system.
* For example - http_proxy=http://myproxy.com:8080
* (Setting it here will have no effect)
* You may also specify no_proxy (or NO_PROXY) to supply a comma separated
* list of domains to not proxy, eg - no_proxy=.acme.co,.acme.co.uk
*/
/** The following property can be used to add a custom middleware function
* in front of all http in nodes. This allows custom authentication to be
* applied to all http in nodes, or any other sort of common request processing.
* It can be a single function or an array of middleware functions.
*/
//httpNodeMiddleware: function(req,res,next) {
// // Handle/reject the request, or pass it on to the http in node by calling next();
// // Optionally skip our rawBodyParser by setting this to true;
// //req.skipRawBodyParser = true;
// next();
//},
/** When httpAdminRoot is used to move the UI to a different root path, the
* following property can be used to identify a directory of static content
* that should be served at http://localhost:1880/.
* When httpStaticRoot is set differently to httpAdminRoot, there is no need
* to move httpAdminRoot
*/
//httpStatic: '/home/nol/node-red-static/', //single static source
/**
* OR multiple static sources can be created using an array of objects...
* Each object can also contain an options object for further configuration.
* See https://expressjs.com/en/api.html#express.static for available options.
* They can also contain an option `cors` object to set specific Cross-Origin
* Resource Sharing rules for the source. `httpStaticCors` can be used to
* set a default cors policy across all static routes.
*/
//httpStatic: [
// {path: '/home/nol/pics/', root: "/img/"},
// {path: '/home/nol/reports/', root: "/doc/"},
// {path: '/home/nol/videos/', root: "/vid/", options: {maxAge: '1d'}}
//],
/**
* All static routes will be appended to httpStaticRoot
* e.g. if httpStatic = "/home/nol/docs" and httpStaticRoot = "/static/"
* then "/home/nol/docs" will be served at "/static/"
* e.g. if httpStatic = [{path: '/home/nol/pics/', root: "/img/"}]
* and httpStaticRoot = "/static/"
* then "/home/nol/pics/" will be served at "/static/img/"
*/
//httpStaticRoot: '/static/',
/** The following property can be used to configure cross-origin resource sharing
* in the http static routes.
* See https://github.com/troygoode/node-cors#configuration-options for
* details on its contents. The following is a basic permissive set of options:
*/
//httpStaticCors: {
// origin: "*",
// methods: "GET,PUT,POST,DELETE"
//},
/** The following property can be used to modify proxy options */
// proxyOptions: {
// mode: "legacy", // legacy mode is for non-strict previous proxy determination logic (node-red < v4 compatible)
// },
/*******************************************************************************
* Runtime Settings
* - lang
* - runtimeState
* - telemetry
* - diagnostics
* - logging
* - contextStorage
* - exportGlobalContextKeys
* - externalModules
******************************************************************************/
/** Uncomment the following to run node-red in your preferred language.
* Available languages include: en-US (default), ja, de, zh-CN, zh-TW, ru, ko
* Some languages are more complete than others.
*/
// lang: "de",
/** Configure diagnostics options
* - enabled: When `enabled` is `true` (or unset), diagnostics data will
* be available at http://localhost:1880/diagnostics
* - ui: When `ui` is `true` (or unset), the action `show-system-info` will
* be available to logged in users of node-red editor
*/
diagnostics: {
/** enable or disable diagnostics endpoint. Must be set to `false` to disable */
enabled: true,
/** enable or disable diagnostics display in the node-red editor. Must be set to `false` to disable */
ui: true,
},
/** Configure runtimeState options
* - enabled: When `enabled` is `true` flows runtime can be Started/Stopped
* by POSTing to available at http://localhost:1880/flows/state
* - ui: When `ui` is `true`, the action `core:start-flows` and
* `core:stop-flows` will be available to logged in users of node-red editor
* Also, the deploy menu (when set to default) will show a stop or start button
*/
runtimeState: {
/** enable or disable flows/state endpoint. Must be set to `false` to disable */
enabled: false,
/** show or hide runtime stop/start options in the node-red editor. Must be set to `false` to hide */
ui: false,
},
telemetry: {
/**
* By default, telemetry is disabled until the user provides consent the first
* time they open the editor.
*
* The following property can be uncommented and set to true/false to enable/disable
* telemetry without seeking further consent in the editor.
* The user can override this setting via the user settings dialog within the editor
*/
// enabled: true,
/**
* If telemetry is enabled, the editor will notify the user if a new version of Node-RED
* is available. Set the following property to false to disable this notification.
*/
// updateNotification: true
},
/** Configure the logging output */
logging: {
/** Only console logging is currently supported */
console: {
/** Level of logging to be recorded. Options are:
* fatal - only those errors which make the application unusable should be recorded
* error - record errors which are deemed fatal for a particular request + fatal errors
* warn - record problems which are non fatal + errors + fatal errors
* info - record information about the general running of the application + warn + error + fatal errors
* debug - record information which is more verbose than info + info + warn + error + fatal errors
* trace - record very detailed logging + debug + info + warn + error + fatal errors
* off - turn off all logging (doesn't affect metrics or audit)
*/
level: "info",
/** Whether or not to include metric events in the log output */
metrics: false,
/** Whether or not to include audit events in the log output */
audit: false
}
},
/** Context Storage
* The following property can be used to enable context storage. The configuration
* provided here will enable file-based context that flushes to disk every 30 seconds.
* Refer to the documentation for further options: https://nodered.org/docs/api/context/
*/
contextStorage: {
default: {
module:"localfilesystem"
},
},
/** `global.keys()` returns a list of all properties set in global context.
* This allows them to be displayed in the Context Sidebar within the editor.
* In some circumstances it is not desirable to expose them to the editor. The
* following property can be used to hide any property set in `functionGlobalContext`
* from being list by `global.keys()`.
* By default, the property is set to false to avoid accidental exposure of
* their values. Setting this to true will cause the keys to be listed.
*/
exportGlobalContextKeys: false,
/** Configure how the runtime will handle external npm modules.
* This covers:
* - whether the editor will allow new node modules to be installed
* - whether nodes, such as the Function node are allowed to have their
* own dynamically configured dependencies.
* The allow/denyList options can be used to limit what modules the runtime
* will install/load. It can use '*' as a wildcard that matches anything.
*/
externalModules: {
// autoInstall: false, /** Whether the runtime will attempt to automatically install missing modules */
// autoInstallRetry: 30, /** Interval, in seconds, between reinstall attempts */
// palette: { /** Configuration for the Palette Manager */
// allowInstall: true, /** Enable the Palette Manager in the editor */
// allowUpdate: true, /** Allow modules to be updated in the Palette Manager */
// allowUpload: true, /** Allow module tgz files to be uploaded and installed */
// allowList: ['*'],
// denyList: [],
// allowUpdateList: ['*'],
// denyUpdateList: []
// },
// modules: { /** Configuration for node-specified modules */
// allowInstall: true,
// allowList: [],
// denyList: []
// }
},
/*******************************************************************************
* Editor Settings
* - disableEditor
* - editorTheme
******************************************************************************/
/** The following property can be used to disable the editor. The admin API
* is not affected by this option. To disable both the editor and the admin
* API, use either the httpRoot or httpAdminRoot properties
*/
//disableEditor: false,
/** Customising the editor
* See https://nodered.org/docs/user-guide/runtime/configuration#editor-themes
* for all available options.
*/
editorTheme: {
/** The following property can be used to set a custom theme for the editor.
* See https://github.com/node-red-contrib-themes/theme-collection for
* a collection of themes to chose from.
*/
//theme: "",
/** To disable the 'Welcome to Node-RED' tour that is displayed the first
* time you access the editor for each release of Node-RED, set this to false
*/
//tours: false,
palette: {
/** The following property can be used to order the categories in the editor
* palette. If a node's category is not in the list, the category will get
* added to the end of the palette.
* If not set, the following default order is used:
*/
//categories: ['subflows', 'common', 'function', 'network', 'sequence', 'parser', 'storage'],
},
projects: {
/** To enable the Projects feature, set this value to true */
enabled: false,
workflow: {
/** Set the default projects workflow mode.
* - manual - you must manually commit changes
* - auto - changes are automatically committed
* This can be overridden per-user from the 'Git config'
* section of 'User Settings' within the editor
*/
mode: "manual"
}
},
codeEditor: {
/** Select the text editor component used by the editor.
* As of Node-RED V3, this defaults to "monaco", but can be set to "ace" if desired
*/
lib: "monaco",
options: {
/** The follow options only apply if the editor is set to "monaco"
*
* theme - must match the file name of a theme in
* packages/node_modules/@node-red/editor-client/src/vendor/monaco/dist/theme
* e.g. "tomorrow-night", "upstream-sunburst", "github", "my-theme"
*/
// theme: "vs",
/** other overrides can be set e.g. fontSize, fontFamily, fontLigatures etc.
* for the full list, see https://microsoft.github.io/monaco-editor/docs.html#interfaces/editor.IStandaloneEditorConstructionOptions.html
*/
//fontSize: 14,
//fontFamily: "Cascadia Code, Fira Code, Consolas, 'Courier New', monospace",
//fontLigatures: true,
}
},
markdownEditor: {
mermaid: {
/** enable or disable mermaid diagram in markdown document
*/
enabled: true
}
},
multiplayer: {
/** To enable the Multiplayer feature, set this value to true */
enabled: false
},
},
/*******************************************************************************
* Node Settings
* - fileWorkingDirectory
* - functionGlobalContext
* - functionExternalModules
* - globalFunctionTimeout
* - functionTimeout
* - nodeMessageBufferMaxLength
* - ui (for use with Node-RED Dashboard)
* - debugUseColors
* - debugMaxLength
* - debugStatusLength
* - execMaxBufferSize
* - httpRequestTimeout
* - mqttReconnectTime
* - serialReconnectTime
* - socketReconnectTime
* - socketTimeout
* - tcpMsgQueueSize
* - inboundWebSocketTimeout
* - tlsConfigDisableLocalFiles
* - webSocketNodeVerifyClient
******************************************************************************/
/** The working directory to handle relative file paths from within the File nodes
* defaults to the working directory of the Node-RED process.
*/
//fileWorkingDirectory: "",
/** Allow the Function node to load additional npm modules directly */
functionExternalModules: true,
/**
* The default timeout (in seconds) for all Function nodes.
* Individual nodes can set their own timeout value within their configuration.
*/
globalFunctionTimeout: 0,
/**
* Default timeout, in seconds, for the Function node. 0 means no timeout is applied
* This value is applied when the node is first added to the workspace - any changes
* must then be made with the individual node configurations.
* To set a global timeout value, use `globalFunctionTimeout`
*/
functionTimeout: 0,
/** The following property can be used to set predefined values in Global Context.
* This allows extra node modules to be made available with in Function node.
* For example, the following:
* functionGlobalContext: { os:require('os') }
* will allow the `os` module to be accessed in a Function node using:
* global.get("os")
*/
functionGlobalContext: {
// os:require('os'),
},
/** The maximum number of messages nodes will buffer internally as part of their
* operation. This applies across a range of nodes that operate on message sequences.
* defaults to no limit. A value of 0 also means no limit is applied.
*/
//nodeMessageBufferMaxLength: 0,
/** If you installed the optional node-red-dashboard you can set it's path
* relative to httpNodeRoot
* Other optional properties include
* readOnly:{boolean},
* middleware:{function or array}, (req,res,next) - http middleware
* ioMiddleware:{function or array}, (socket,next) - socket.io middleware
*/
//ui: { path: "ui" },
/** Colourise the console output of the debug node */
//debugUseColors: true,
/** The maximum length, in characters, of any message sent to the debug sidebar tab */
debugMaxLength: 1000,
/** The maximum length, in characters, of status messages under the debug node */
//debugStatusLength: 32,
/** Maximum buffer size for the exec node. Defaults to 10Mb */
//execMaxBufferSize: 10000000,
/** Timeout in milliseconds for HTTP request connections. Defaults to 120s */
//httpRequestTimeout: 120000,
/** Retry time in milliseconds for MQTT connections */
mqttReconnectTime: 15000,
/** Retry time in milliseconds for Serial port connections */
serialReconnectTime: 15000,
/** Retry time in milliseconds for TCP socket connections */
//socketReconnectTime: 10000,
/** Timeout in milliseconds for TCP server socket connections. Defaults to no timeout */
//socketTimeout: 120000,
/** Maximum number of messages to wait in queue while attempting to connect to TCP socket
* defaults to 1000
*/
//tcpMsgQueueSize: 2000,
/** Timeout in milliseconds for inbound WebSocket connections that do not
* match any configured node. Defaults to 5000
*/
//inboundWebSocketTimeout: 5000,
/** To disable the option for using local files for storing keys and
* certificates in the TLS configuration node, set this to true.
*/
//tlsConfigDisableLocalFiles: true,
/** The following property can be used to verify WebSocket connection attempts.
* This allows, for example, the HTTP request headers to be checked to ensure
* they include valid authentication information.
*/
//webSocketNodeVerifyClient: function(info) {
// /** 'info' has three properties:
// * - origin : the value in the Origin header
// * - req : the HTTP request
// * - secure : true if req.connection.authorized or req.connection.encrypted is set
// *
// * The function should return true if the connection should be accepted, false otherwise.
// *
// * Alternatively, if this function is defined to accept a second argument, callback,
// * it can be used to verify the client asynchronously.
// * The callback takes three arguments:
// * - result : boolean, whether to accept the connection or not
// * - code : if result is false, the HTTP error status to return
// * - reason: if result is false, the HTTP reason string to return
// */
//},
}
+47
View File
@@ -0,0 +1,47 @@
#!/usr/bin/env bash
# test-container.sh
# Usage: ./test-container.sh container_name host
container="$1"
host="$2"
test_name="testing-${container}"
compose_script="/compose/${host}/services-up.sh"
# Run container in detached mode
$compose_script --profile all run -d --name "$test_name" --build "$container" >/dev/null 2>&1
# Poll health status
timeout=60 # seconds
interval=2 # seconds
elapsed=0
result=1 # default to failure
while [ $elapsed -lt $timeout ]; do
status=$(docker inspect --format='{{.State.Health.Status}}' "$test_name" 2>/dev/null)
if [ "$status" == "healthy" ]; then
# echo "healthy"
result=0 # success
break
elif [ "$status" == "unhealthy" ]; then
# echo "unhealthy"
result=1 # failure
break
fi
sleep $interval
elapsed=$((elapsed + interval))
done
# Timeout case
if [ $elapsed -ge $timeout ]; then
# echo "timeout"
result=1
fi
# Cleanup
docker rm "$test_name" --force >/dev/null 2>&1
#echo "Exiting with $result" >&2
echo $result
exit $result
+31
View File
@@ -0,0 +1,31 @@
#!/usr/bin/env bash
# test-container.sh
# Usage: ./test-container.sh container_name
container="$1"
test_name="testing-${container}"
compose_script="/home/nixos/docker/services-up.sh"
# Run container in detached mode
$compose_script --profile all run -d --name "$test_name" --rm --build "$container"
# Poll health status
timeout=60 # seconds
interval=2 # seconds
elapsed=0
while [ $elapsed -lt $timeout ]; do
status=$(docker inspect --format='{{.State.Health.Status}}' "$test_name" 2>/dev/null)
if [ "$status" == "healthy" ]; then
echo "healthy"
break
elif [ "$status" == "unhealthy" ]; then
echo "unhealthy"
break
fi
sleep $interval
elapsed=$((elapsed + interval))
done
# Cleanup
docker rm -f "$test_name" >/dev/null 2>&1
File diff suppressed because one or more lines are too long
+2
View File
@@ -26,6 +26,8 @@ services:
environment:
- GODEBUG=${PORTAINER_GODEBUG}
- TZ=${TZ}
- DOCKER_HOST=tcp://docker-socket-proxy:2375
# healthcheck:
# test: ["CMD", "wget", "--spider", "-q", "https://portainer.lan.ddnsgeek.com/api/status"]
# interval: 30s
+19
View File
@@ -5,6 +5,7 @@ services:
profiles: ["monitoring","all","prometheus","prometheus-exporters"]
image: tecnativa/docker-socket-proxy:latest
container_name: docker-socket-proxy
hostname: docker-socket-proxy
restart: unless-stopped
environment:
LOG_LEVEL: ${DOCKER_SOCKET_PROXY_LOG_LEVEL}
@@ -16,10 +17,27 @@ services:
NETWORKS: 1
PING: 1
POST: 1
AUTH: 1
EXEC: 1
SYSTEM: 1
SERVICES: 1
SWARM: 1
NODES: 1
SECRETS: 1
TASKS: 1
VERSION: 1
VOLUMES: 1
ALLOW_START: 1 # for better security, set to 0
ALLOW_STOP: 1 # for better security, set to 0
ALLOW_RESTARTS: 1 # for better security, set to 0
BUILD: 0
COMMIT: 0
CONFIGS: 0
DELETE: 1
DISABLE_IPV6: 0
PLUGINS: 0
SESSION: 0
volumes:
- /var/run/docker.sock:/var/run/docker.sock:ro
cap_drop:
@@ -179,6 +197,7 @@ services:
- no-new-privileges:true
volumes:
- ${PROJECT_ROOT}/monitoring/telegraf/telegraf.conf:/etc/telegraf/telegraf.conf:ro
- ${PROJECT_ROOT}/monitoring/node-red/data:/var/log/node-red:ro
networks:
# - edge
- monitor
+36
View File
@@ -7,3 +7,39 @@
[[outputs.prometheus_client]]
listen = ":9273"
# Node-RED update-event logs (structured NDJSON) -> Prometheus metrics for Grafana
[[inputs.tail]]
files = ["/var/log/node-red/update-events.ndjson"]
from_beginning = false
name_override = "node_red_update_event"
data_format = "json_v2"
[[inputs.tail.json_v2]]
measurement_name = "node_red_update_event"
[[inputs.tail.json_v2.tag]]
path = "flow"
[[inputs.tail.json_v2.tag]]
path = "event"
[[inputs.tail.json_v2.tag]]
path = "container"
[[inputs.tail.json_v2.tag]]
path = "project"
[[inputs.tail.json_v2.tag]]
path = "host"
[[inputs.tail.json_v2.tag]]
path = "status"
[[inputs.tail.json_v2.field]]
path = "success"
type = "int"
[[inputs.tail.json_v2.field]]
path = "failed"
type = "int"
[[inputs.tail.json_v2.field]]
path = "duration_ms"
type = "int"
[[inputs.tail.json_v2.field]]
path = "code"
type = "int"
+13 -13
View File
@@ -1,13 +1,13 @@
12:23:36 INFO: === Update started: 2026-04-04 12:23:36 ===
12:23:36 WARNING: Skipping traefik (directory does not exist)
12:23:36 WARNING: Skipping nextcloud (directory does not exist)
12:23:36 WARNING: Skipping passbolt (directory does not exist)
12:23:36 WARNING: Skipping searxng (directory does not exist)
12:23:36 WARNING: Skipping gitea (directory does not exist)
12:23:36 WARNING: Skipping gotify (directory does not exist)
12:23:36 WARNING: Skipping grafana (directory does not exist)
12:23:36 WARNING: Skipping gramps (directory does not exist)
12:23:36 WARNING: Skipping portainer (directory does not exist)
12:23:36 WARNING: Skipping prometheus (directory does not exist)
12:23:36 WARNING: Skipping uptime-kuma (directory does not exist)
12:23:36 INFO: Pruning unused containers, images, networks, and volumes...
12:02:41 INFO: === Update started: 2026-04-12 12:02:41 ===
12:02:41 WARNING: Skipping traefik (directory does not exist)
12:02:41 WARNING: Skipping nextcloud (directory does not exist)
12:02:41 WARNING: Skipping passbolt (directory does not exist)
12:02:41 WARNING: Skipping searxng (directory does not exist)
12:02:41 WARNING: Skipping gitea (directory does not exist)
12:02:41 WARNING: Skipping gotify (directory does not exist)
12:02:41 WARNING: Skipping grafana (directory does not exist)
12:02:41 WARNING: Skipping gramps (directory does not exist)
12:02:41 WARNING: Skipping portainer (directory does not exist)
12:02:41 WARNING: Skipping prometheus (directory does not exist)
12:02:41 WARNING: Skipping uptime-kuma (directory does not exist)
12:02:41 INFO: Pruning unused containers, images, networks, and volumes...