gsadmin/pulse
1
0
Fork 0
mirror of https://github.com/rcourtman/Pulse.git synced 2026-09-22 11:13:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: add sanitized export option for sharing diagnostics on GitHub

Browse Source 
Added two export options in Settings > System:
- Export Full: Complete diagnostic data for private troubleshooting
- Export for GitHub: Sanitized version with redacted sensitive information

The sanitized export:
- Replaces IP addresses with xxx.xxx.xxx.xxx (keeping first octet for context)
- Replaces hostnames with generic names (keeping .lan/.local suffix)
- Redacts API token names and cluster names
- Adds a notice that data has been sanitized
- Filenames clearly indicate 'sanitized' vs 'full'

This allows users to safely share diagnostic data on public GitHub issues
without exposing their network topology or internal naming conventions.
This commit is contained in:
Pulse Monitor
2025-08-24 08:12:13 +00:00
parent 4c4b89431d
commit 5b860bfe39
1 changed files with 87 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
frontend-modern/src/components/Settings/Settings.tsx
+87 -9
View File
@@ -1963,9 +1963,63 @@ const Settings: Component = () => {
<p class="text-xs text-gray-600 dark:text-gray-400 mb-4">
Export system diagnostics data for troubleshooting
</p>
<button type="button"
onClick={() => {
const diagnostics = {
{/* Helper function to sanitize sensitive data */}
{(() => {
const sanitizeForGitHub = (data: any) => {
// Deep clone the data
const sanitized = JSON.parse(JSON.stringify(data));
// Sanitize IP addresses (keep first octet for network type identification)
const sanitizeIP = (ip: string) => {
if (!ip) return ip;
const parts = ip.split('.');
if (parts.length === 4) {
return `${parts[0]}.xxx.xxx.xxx`;
}
return 'xxx.xxx.xxx.xxx';
};
// Sanitize hostname but keep domain suffix for context
const sanitizeHostname = (hostname: string) => {
if (!hostname) return hostname;
// Keep common suffixes like .lan, .local, .home
const suffixMatch = hostname.match(/\.(lan|local|home|internal)$/);
const suffix = suffixMatch ? suffixMatch[0] : '';
return `node-REDACTED${suffix}`;
};
// Sanitize nodes
if (sanitized.nodes) {
sanitized.nodes = sanitized.nodes.map((node: any, index: number) => ({
...node,
id: `${node.type}-${index}`,
name: sanitizeHostname(node.name),
host: node.host ? node.host.replace(/https?:\/\/[^:\/]+/, 'https://REDACTED') : node.host,
tokenName: node.tokenName ? 'token-REDACTED' : node.tokenName,
clusterName: node.clusterName ? 'cluster-REDACTED' : node.clusterName,
clusterEndpoints: node.clusterEndpoints ? node.clusterEndpoints.map((ep: any, epIndex: number) => ({
...ep,
NodeName: `node-${epIndex + 1}`,
Host: `node-${epIndex + 1}`,
IP: sanitizeIP(ep.IP)
})) : node.clusterEndpoints
}));
}
// Sanitize websocket URL
if (sanitized.websocket?.url) {
sanitized.websocket.url = sanitized.websocket.url.replace(/\/\/[^\/]+/, '//REDACTED');
}
// Add sanitization notice
sanitized._notice = 'This diagnostic data has been sanitized for sharing on GitHub. IP addresses, hostnames, and tokens have been redacted.';
return sanitized;
};
const exportDiagnostics = (sanitize: boolean) => {
let diagnostics = {
timestamp: new Date().toISOString(),
version: '2.0.0',
environment: {
@@ -1991,20 +2045,44 @@ const Settings: Component = () => {
}
};
if (sanitize) {
diagnostics = sanitizeForGitHub(diagnostics);
}
const blob = new Blob([JSON.stringify(diagnostics, null, 2)], { type: 'application/json' });
const url = URL.createObjectURL(blob);
const a = document.createElement('a');
a.href = url;
a.download = `pulse-diagnostics-${new Date().toISOString().split('T')[0]}.json`;
const type = sanitize ? 'sanitized' : 'full';
a.download = `pulse-diagnostics-${type}-${new Date().toISOString().split('T')[0]}.json`;
document.body.appendChild(a);
a.click();
document.body.removeChild(a);
URL.revokeObjectURL(url);
}}
class="px-4 py-2 text-sm bg-blue-600 text-white rounded-lg hover:bg-blue-700 transition-colors"
>
Export Diagnostics
</button>
};
return (
<div class="flex gap-2">
<button type="button"
onClick={() => exportDiagnostics(false)}
class="px-4 py-2 text-sm bg-blue-600 text-white rounded-lg hover:bg-blue-700 transition-colors"
>
Export Full
</button>
<button type="button"
onClick={() => exportDiagnostics(true)}
class="px-4 py-2 text-sm bg-green-600 text-white rounded-lg hover:bg-green-700 transition-colors"
>
Export for GitHub
</button>
</div>
);
})()}
<p class="text-xs text-gray-500 dark:text-gray-400 mt-3">
<strong>Export Full:</strong> Complete data for private troubleshooting<br/>
<strong>Export for GitHub:</strong> Sanitized data safe for public sharing
</p>
</div>
</div>
</div>