Support packages

​

Current implementation status

GET /api/admin/diagnostics
GET /api/admin/diagnostics/export
GET /api/admin/diagnostics/health
POST /api/admin/diagnostics/support-package

​

Export diagnostics from Admin UI

1. Open Diagnostics.
2. Review health checks and system cards.
3. Select Export JSON.
4. Attach the downloaded diagnostics-<timestamp>.json file to the support ticket.

​

Generate a support package from Admin UI

1. Open Diagnostics.
2. Select Support Package.
3. Select the affected clusters. If no cluster is selected, the server collects all clusters.
4. Add a short issue summary with what failed, when it started, and visible symptoms.
5. Optionally set a contact email, log tail line count, and whether to include pod logs and metrics.
6. Select Download package.
7. Send the downloaded falkordb-support-<timestamp>.zip file to the support team.

​

Generate a support package from API

curl -f -X POST http://localhost:3000/api/admin/diagnostics/support-package \
	-H 'Content-Type: application/json' \
	-d '{
		"clusters": [{ "name": "demo", "namespace": "demo" }],
		"issueDescription": "Cluster is degraded after upgrade",
		"includeLogs": true,
		"includeMetrics": true,
		"logTailLines": 500
	}' \
	-o falkordb-support.zip

​

What the JSON export contains

• Export timestamp.
• Server uptime, package version, Node.js version, platform, architecture, CPU count, and memory summary.
• Health status for Kubernetes API access, KubeBlocks/version catalog access, and audit database access.
• Resource summary with total cluster count.
• Recent audit activity count.
• Recent errors only if the audit service provides them.

​

What the support package contains

• issue.json: user-provided issue description and optional contact email.
• manifest.json: schema version, generation metadata, installed versions and release channel, selected scope, content list, warnings, and redaction strategy.
• system/: runtime, settings, namespaces, storage classes, and FalkorDB version catalog.
• kubernetes/: nodes, pods, persistent volumes, and persistent volume claims in selected namespaces.
• platform/kubeblocks/crds.json: KubeBlocks CRD definitions installed in the cluster.
• platform/kubeblocks/resources/: known KubeBlocks custom resources, split by cluster-scoped resources and namespace-scoped resources for selected cluster namespaces and platform namespaces.
• platform/kubeblocks/logs/: KubeBlocks controller and data protection controller logs from platform namespaces when log collection is enabled.
• backups/: backup repository metadata.
• audit/: recent audit entries.
• clusters/<namespace>__<name>/: cluster summary, KubeBlocks cluster YAML, pods, ops requests, Redis config, backup resources, restore resources, metrics, and pod logs.

​

Versions and release channel

{
  "versions": {
    "chart": "0.5.0",
    "channel": "stable",
    "appVersion": "1.0.0",
    "server": "0.5.0",
    "ui": "0.5.0",
    "addon": "1.7.5"
  }
}

​

Inspect a support package

pnpm --filter @falkordb/support-viewer dev

​

Health status meaning

• healthy: all checks passed.
• degraded: at least one check failed.
• unhealthy: all checks failed, or the health endpoint hit an unexpected error.

​

Validate from the API

curl -f http://localhost:3000/api/admin/diagnostics/health
curl -f http://localhost:3000/api/admin/diagnostics/export -o diagnostics.json

​

Remaining work