Files
troubleshoot/cmd/analyze/cli/run.go
Marc Campbell 35759c47af V1beta3 (#1873)
* Change workflow branch from 'main' to 'v1beta3'

* Auto updater (#1849)

* added auto updater

* updated docs

* commit to trigger actions

* Auto-collectors: foundational discovery, image metadata, CLI integrat… (#1845)

* Auto-collectors: foundational discovery, image metadata, CLI integration; reset PRD markers

* Address PR review feedback

- Implement missing namespace exclude patterns functionality
- Fix image facts collector to use empty Data field instead of static string
- Correct APIVersion to use troubleshoot.sh/v1beta2 consistently

* Fix bug bot issues: API parsing, EOF error, and API group corrections

- Fix RBAC API parsing errors in rbac_checker.go (getAPIGroup/getAPIVersion functions)
- Fix FakeReader EOF error to use standard io.EOF instead of custom error
- Fix incorrect API group from troubleshoot.sh to troubleshoot.replicated.com in run.go

These changes address the issues identified by the bug bot and ensure proper
interface compliance and consistent API group usage.

* Fix multiple bug bot issues

- Fix RBAC API parsing errors in rbac_checker.go (getAPIGroup/getAPIVersion functions)
- Fix FakeReader EOF error to use standard io.EOF instead of custom error
- Fix incorrect API group from troubleshoot.sh to troubleshoot.replicated.com in run.go
- Fix image facts collector Data field to contain structured JSON instead of static strings

These changes address all issues identified by the bug bot and ensure proper
interface compliance, consistent API usage, and meaningful data fields.

* Update auto_discovery.go

* Fix TODO comments in Auto-collector section

Fixed 3 of 4 TODOs as requested in PR review:

1. pkg/collect/images/registry_client.go (line 46):
   - Implement custom CA certificate loading
   - Add x509 import and certificate parsing logic
   - Enables image collection from private registries with custom CAs

2. cmd/troubleshoot/cli/diff.go (line 209):
   - Implement bundle file count functionality
   - Add tar/gzip imports and getFileCountFromBundle() function
   - Properly counts files in support bundle archives (.gz/.tgz)

3. cmd/troubleshoot/cli/run.go (line 338):
   - Replace TODO with clarifying comment about RemoteCollectors usage
   - Confirmed RemoteCollectors are still actively used in preflights

The 4th TODO (diff.go line 196) is left as-is since it's explicitly marked
as Phase 4 future work (Support Bundle Differencing implementation).

Addresses PR review feedback about unimplemented TODO comments.

---------

Co-authored-by: Benjamin Yang <benjaminyang@Benjamins-MacBook-Pro.local>

* resetting make targets and github workflows to support v1beta3 releas… (#1853)

* resetting make targets and github workflows to support v1beta3 release later

* removing generate

* remove

* removing

* removing

* Support bundle diff (#1855)

implemented support bundle diff command

* Preflight docs and template subcommands (#1847)

* Added docs and template subcommands with test files

* uses helm templating preflight yaml files

* merge doc requirements for multiple inputs

* Helm aware rendering and markdown output

* v1beta3 yaml structure better mirrors beta2

* Update sample-preflight-templated.yaml

* Added docs and template subcommands with test files

* uses helm templating preflight yaml files

* merge doc requirements for multiple inputs

* Helm aware rendering and markdown output

* v1beta3 yaml structure better mirrors beta2

* Update sample-preflight-templated.yaml

* Added/updated documentation on subcommands

* Update docs.go

* commit to trigger actions

* Updated yaml spec (#1851)

* v1beta3 spec can be read by preflight

* added test files for ease of testing

* updated v1beta3 guide doc and added tests

* fixed not removing tmp files from v1beta3 processing

* created v1beta2 to v1beta3 converter

* Updated yaml spec (#1863)

* v1beta3 spec can be read by preflight

* added test files for ease of testing

* v1beta3 renderer fixes

* fixed gitignore issue

* Auto support bundle upload (#1860)

* basic auto uploading support bundles

* added upload command

* added default vendor endpoint

* added auth system from replicated cli

* fixed case sensitivity issue in YAML parsing

* support bundle uploads for end customers

* app slug flag and detection without licenseID

* moved v1beta3 examples to proper directory

* does not auto update for package managers (#1850)

* V1beta3 cleanup (#1869)

* moving some files around

* more cleanup

* removing more unused

* update ci for v1beta3 (#1870)

* fmt:

* removing unused examples

* add a v1beta3 fixture

* removing coverage reporting

* adding brew (#1872)

* Fixing testing errors (#1871)

fix: resolve failing unit tests and diff consistency in v1beta3

- Fix readLinesFromReader to return lines WITH newlines (like difflib.SplitLines)
- Update test expectations to match correct function behavior with newlines
- This ensures consistency between streaming and non-streaming diff paths
- Fix timeout test by changing from 10ms to 500ms to eliminate flaky failures

Fixes TestReadLinesFromReader and Test_loadSupportBundleSpecsFromURIs_TimeoutError
Resolves diff output inconsistency between code paths

* Fix/exec textanalyze path clean (#1865)

* created roadmap and yaml claude agent

* Update roadmap.md

* Fix textAnalyze analyzer to auto-match exec collector nested paths

- Auto-detect exec output files (*-stdout.txt, *-stderr.txt, *-errors.json)
- Convert simple filenames to wildcard patterns automatically
- Preserve existing wildcard patterns
- Fixes 'No matching file' errors for exec + textAnalyze workflows

---------

Co-authored-by: Noah Campbell <noah.edward.campbell@gmail.com>

* bump goreleaser to v2

* remove collect binary and risc binary

* remove this check

* add debug logging

* larger runner for release

* dropping goreleaser

* fix syntax

* fix syntax

* goreleaser

* larger

* prerelease auto and more

* publish to directory:

* some more goreleaser/homebrew stuffs

* removing risc

* bump example

* Advanced analysis clean (#1868)

* created roadmap and yaml claude agent

* Update roadmap.md

* feat: Clean advanced analysis implementation - core agents, engine, artifacts

* Remove unrelated files - keep only advanced analysis implementation

* fix: Fix goroutine leak in hosted agent rate limiter

- Added stop channel and stopped flag to RateLimiter struct
- Modified replenishTokens to listen for stop signal and exit cleanly
- Added Stop() method to gracefully shutdown rate limiter
- Added Stop() method to HostedAgent to cleanup rate limiter on shutdown

Fixes cursor bot issue: Rate Limiter Goroutine Leak

* fix: Fix analyzer config and model validation bugs

Bug 1: Analyzer Config Missing File Path
- Added filePath to DeploymentStatus analyzer config in convertAnalyzerToSpec
- Sets namespace-specific path (cluster-resources/deployments/{namespace}.json)
- Falls back to generic path (cluster-resources/deployments.json) if no namespace
- Fixes LocalAgent.analyzeDeploymentStatus backward compatibility

Bug 2: HealthCheck Fails Model Validation
- Changed Ollama model validation from prefix match to exact match
- Prevents false positives where llama2:13b would match request for llama2:7b
- Ensures agent only reports healthy when exact model is available

Both fixes address cursor bot reported issues and maintain backward compatibility.

* fixing lint errors

* fixing lint errors

* adding CLI flags

* fix: resolve linting errors for CI

- Remove unnecessary nil check in host_kernel_configs.go (len() for nil slices is zero)
- Remove unnecessary fmt.Sprintf() calls in ceph.go for static strings
- Apply go fmt formatting fixes

Fixes failing lint CI check

* fix: resolve CI failures in build-test workflow and Ollama tests

1. Fix GitHub Actions workflow logic error:
   - Replace problematic contains() expression with explicit job result checks
   - Properly handle failure and cancelled states for each job
   - Prevents false positive failures in success summary job

2. Fix Ollama agent parseLLMResponse panics:
   - Add proper error handling for malformed JSON in LLM responses
   - Return error when JSON is found but invalid (instead of silent fallback)
   - Add error when no meaningful content can be parsed from response
   - Prevents nil pointer dereference in test assertions

Fixes failing build-test/success and build-test/test CI checks

* fix: resolve all CI failures and cursor bot issues

1. Fix disable-ollama flag logic bug:
   - Remove disable-ollama from advanced analysis trigger condition
   - Prevents unintended advanced analysis mode when no agents registered
   - Allows proper fallback to legacy analysis

2. Fix diff test consistency:
   - Update test expectations to match function behavior (lines with newlines)
   - Ensures consistency between streaming and non-streaming diff paths

3. Fix Ollama agent error handling:
   - Add proper error return for malformed JSON in LLM responses
   - Add meaningful content validation for markdown parsing
   - Prevents nil pointer panics in test assertions

4. Fix analysis engine mock agent:
   - Mock agent now processes and returns results for all provided analyzers
   - Fixes test expectation mismatch (expected 8 results, got 1)

Resolves all failing CI checks: lint, test, and success workflow logic

---------

Co-authored-by: Noah Campbell <noah.edward.campbell@gmail.com>

* Auto-Collect (#1867)

* Fix auto-collector missing files issue

- Add KOTS-aware detection for diagnostic files
- Replace silent RBAC filtering with user warnings
- Enhance error file collection for troubleshooting
- Achieve parity with traditional support bundles

Resolves issue where auto-collector was missing:
- KOTS diagnostic files (now 4 vs 3)
- ConfigMaps (now 6 vs 6)
- Maintains superior log collection (24 vs 0)

Final result: [SUCCESS] comprehensive collection achieved

* fixing bugbog

* fix: resolve production readiness issues in auto-collect branch

1. Fix diff test expectations (lines should have newlines for difflib consistency)
2. Fix preflight tests to use existing v1beta3 example file
3. Fix autodiscovery test context parameter (function signature update)

Resolves TestReadLinesFromReader and preflight v1beta3 test failures

* fix: resolve autodiscovery tests and cursor bot image matching issues

1. Fix cursor bot image matching bug in isKotsadmImage:
   - Replace flawed prefix matching with proper image component detection
   - Handle private registries correctly (registry.company.com/kotsadm/kotsadm:v1.0.0)
   - Prevent false positives with proper delimiter checking
   - Add helper functions: containsImageComponent, splitImagePath, removeTagAndDigest

2. Fix autodiscovery test failures:
   - Add TestMode flag to DiscoveryOptions to control KOTS diagnostic collection
   - Tests use TestMode=true to get only foundational collectors (no KOTS diagnostics)
   - Preserves production behavior while enabling clean testing

Resolves failing TestDiscoverer_DiscoverFoundational tests and cursor bot issues

* Cron job clean (#1862)

* created roadmap and yaml claude agent

* Update roadmap.md

* chore(deps): bump sigstore/cosign-installer from 3.9.2 to 3.10.0 (#1857)

Bumps [sigstore/cosign-installer](https://github.com/sigstore/cosign-installer) from 3.9.2 to 3.10.0.
- [Release notes](https://github.com/sigstore/cosign-installer/releases)
- [Commits](https://github.com/sigstore/cosign-installer/compare/v3.9.2...v3.10.0)

---
updated-dependencies:
- dependency-name: sigstore/cosign-installer
  dependency-version: 3.10.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump the security group with 2 updates (#1858)

Bumps the security group with 2 updates: [github.com/vmware-tanzu/velero](https://github.com/vmware-tanzu/velero) and [helm.sh/helm/v3](https://github.com/helm/helm).


Updates `github.com/vmware-tanzu/velero` from 1.16.2 to 1.17.0
- [Release notes](https://github.com/vmware-tanzu/velero/releases)
- [Changelog](https://github.com/vmware-tanzu/velero/blob/main/CHANGELOG.md)
- [Commits](https://github.com/vmware-tanzu/velero/compare/v1.16.2...v1.17.0)

Updates `helm.sh/helm/v3` from 3.18.6 to 3.19.0
- [Release notes](https://github.com/helm/helm/releases)
- [Commits](https://github.com/helm/helm/compare/v3.18.6...v3.19.0)

---
updated-dependencies:
- dependency-name: github.com/vmware-tanzu/velero
  dependency-version: 1.17.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: security
- dependency-name: helm.sh/helm/v3
  dependency-version: 3.19.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: security
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump helm.sh/helm/v3 from 3.18.6 to 3.19.0 in /examples/sdk/helm-template in the security group (#1859)

chore(deps): bump helm.sh/helm/v3

Bumps the security group in /examples/sdk/helm-template with 1 update: [helm.sh/helm/v3](https://github.com/helm/helm).


Updates `helm.sh/helm/v3` from 3.18.6 to 3.19.0
- [Release notes](https://github.com/helm/helm/releases)
- [Commits](https://github.com/helm/helm/compare/v3.18.6...v3.19.0)

---
updated-dependencies:
- dependency-name: helm.sh/helm/v3
  dependency-version: 3.19.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: security
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Add cron job support bundle scheduler

Complete implementation with K8s integration:
- pkg/schedule/job.go: Job management and persistence
- pkg/schedule/daemon.go: Real-time scheduler daemon
- pkg/schedule/cli.go: CLI commands (create, list, delete, daemon)
- pkg/schedule/schedule_test.go: Comprehensive unit tests
- cmd/troubleshoot/cli/root.go: CLI integration

* fixing bugbot

* Fix all bugbot errors: auto-update stability, job cooldown timing, and daemon execution

* Deleting Agent

* removed unused flags

* fixing auto-upload

* fixing markdown files

* namespace not required flag for auto collectors to work

* loosened cron job validation

* writes logs to logfile

* fix: resolve autoFromEnv variable scoping issue for CI

- Ensure autoFromEnv variable and its usage are in correct scope
- Fix build errors: declared and not used / undefined variable
- All functionality preserved and tested locally
- Force add to override gitignore

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Noah Campbell <noah.edward.campbell@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* feat: clean tokenization system implementation (#1874)

Core tokenization functionality with minimal file changes:

 Core Features:
- Intelligent tokenization engine (tokenizer.go)
- Context-aware secret classification (PASSWORD, APIKEY, DATABASE, etc.)
- Cross-file correlation with deterministic HMAC-SHA256 tokens
- Optional encrypted mapping for token→original value resolution

 Integration:
- CLI flags: --tokenize, --redaction-map, --encrypt-redaction-map
- Updated all redactor types: literal, single-line, multi-line, YAML
- Support bundle integration with auto-upload compatibility
- Backward compatibility: preserves ***HIDDEN*** when disabled

 Production Ready:
- Only 11 essential files (vs 31 in original PR)
- No excessive test files or documentation
- Clean build, all functionality verified
- Maintains existing redaction behavior by default

Token format: ***TOKEN_<TYPE>_<HASH>*** (e.g., ***TOKEN_PASSWORD_A1B2C3***)

* Removes silent failing (#1877)

* preserves stdout and stderr from collectors

* Delete eliminate-silent-failures.md

* Update host_kernel_modules_test.go

* added error logs when a collector fails to start

* Update host_filesystem_performance_linux.go

* fixed error saving logic inconsistency

* Update collect.go

* Improved error handling for support bundles and redactors for windows (#1878)

* improved error handling and window locking

* Delete all-windows-collectors.yaml

* addressing bugbot concerns

* Update host_tcpportstatus.go

* Update redact.go

* Add regression test suite to github actions

* Update regression-test.yaml

* Update regression-test.yaml

* Update regression-test.yaml

* create test/output directory

* handle node-specific files and multiple report arguments

* simplify comparison to detect code regressions only

* handle empty structural_compare rules

* removed v1beta3 branch from github workflow

* Update Makefile

* removed outdated actions

* Update Makefile

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Noah Campbell <noah.edward.campbell@gmail.com>
Co-authored-by: Benjamin Yang <82779168+bennyyang11@users.noreply.github.com>
Co-authored-by: Benjamin Yang <benjaminyang@Benjamins-MacBook-Pro.local>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-10-08 10:22:11 -07:00

758 lines
21 KiB
Go
Raw Permalink Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
package cli
import (
"archive/tar"
"compress/gzip"
"context"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"net/http"
"os"
"os/exec"
"path/filepath"
"strings"
"time"
"github.com/pkg/errors"
"github.com/replicatedhq/troubleshoot/internal/util"
analyzer "github.com/replicatedhq/troubleshoot/pkg/analyze"
"github.com/replicatedhq/troubleshoot/pkg/analyze/agents/local"
"github.com/replicatedhq/troubleshoot/pkg/analyze/agents/ollama"
troubleshootv1beta2 "github.com/replicatedhq/troubleshoot/pkg/apis/troubleshoot/v1beta2"
"github.com/spf13/viper"
"k8s.io/klog/v2"
"sigs.k8s.io/yaml"
)
func runAnalyzers(v *viper.Viper, bundlePath string) error {
// Handle Ollama-specific commands first (these don't require a bundle)
if v.GetBool("setup-ollama") {
return handleOllamaSetup(v)
}
if v.GetBool("check-ollama") {
return handleOllamaStatus(v)
}
if v.GetBool("list-models") {
return handleListModels(v)
}
if v.GetBool("pull-model") {
return handlePullModel(v)
}
// For all other operations, we need a bundle path
if bundlePath == "" {
return errors.New("bundle path is required for analysis operations")
}
// Check if advanced analysis is requested
useAdvanced := v.GetBool("advanced-analysis") ||
v.GetBool("enable-ollama") ||
(len(v.GetStringSlice("agents")) > 1 ||
(len(v.GetStringSlice("agents")) == 1 && v.GetStringSlice("agents")[0] != "local"))
if useAdvanced {
return runAdvancedAnalysis(v, bundlePath)
}
// Only fall back to legacy analysis if no advanced flags are used at all
return runLegacyAnalysis(v, bundlePath)
}
// handleOllamaSetup automatically sets up Ollama for the user
func handleOllamaSetup(v *viper.Viper) error {
fmt.Println("🚀 Ollama Setup Assistant")
fmt.Println("=" + strings.Repeat("=", 50))
helper := analyzer.NewOllamaHelper()
// Check current status
status := helper.GetHealthStatus()
fmt.Print(status.String())
if !status.Installed {
fmt.Println("\n🔧 Installing Ollama...")
if err := helper.DownloadAndInstall(); err != nil {
return errors.Wrap(err, "failed to install Ollama")
}
fmt.Println("✅ Ollama installed successfully!")
}
if !status.Running {
fmt.Println("\n🚀 Starting Ollama service...")
if err := helper.StartService(); err != nil {
return errors.Wrap(err, "failed to start Ollama service")
}
fmt.Println("✅ Ollama service started!")
}
if len(status.Models) == 0 {
fmt.Println("\n📚 Downloading recommended model...")
helper.PrintModelRecommendations()
model := v.GetString("ollama-model")
if model == "" {
model = "llama2:7b"
}
fmt.Printf("\n⬇ Pulling model: %s (this may take several minutes)...\n", model)
if err := helper.PullModel(model); err != nil {
return errors.Wrapf(err, "failed to pull model %s", model)
}
}
fmt.Println("\n🎉 Ollama setup complete!")
fmt.Println("\n💡 Next steps:")
fmt.Printf(" troubleshoot analyze --enable-ollama %s\n", filepath.Base(os.Args[len(os.Args)-1]))
return nil
}
// handleOllamaStatus shows current Ollama installation and service status
func handleOllamaStatus(v *viper.Viper) error {
helper := analyzer.NewOllamaHelper()
status := helper.GetHealthStatus()
fmt.Println("🔍 Ollama Status Report")
fmt.Println("=" + strings.Repeat("=", 50))
fmt.Print(status.String())
if !status.Installed {
fmt.Println("\n🔧 Setup Instructions:")
fmt.Println(helper.GetInstallInstructions())
return nil
}
if !status.Running {
fmt.Println("\n🚀 To start Ollama service:")
fmt.Println(" ollama serve &")
fmt.Println(" # or")
fmt.Println(" troubleshoot analyze --setup-ollama")
return nil
}
if len(status.Models) == 0 {
fmt.Println("\n📚 No models installed. Recommended models:")
helper.PrintModelRecommendations()
} else {
fmt.Println("\n✅ Ready for AI-powered analysis!")
fmt.Printf(" troubleshoot analyze --enable-ollama your-bundle.tar.gz\n")
}
return nil
}
// handleListModels lists available and installed Ollama models
func handleListModels(v *viper.Viper) error {
helper := analyzer.NewOllamaHelper()
status := helper.GetHealthStatus()
fmt.Println("🤖 Ollama Model Management")
fmt.Println("=" + strings.Repeat("=", 50))
if !status.Installed {
fmt.Println("❌ Ollama is not installed")
fmt.Println("💡 Install with: troubleshoot analyze --setup-ollama")
return nil
}
if !status.Running {
fmt.Println("⚠️ Ollama service is not running")
fmt.Println("🚀 Start with: ollama serve &")
return nil
}
// Show installed models
fmt.Println("📚 Installed Models:")
if len(status.Models) == 0 {
fmt.Println(" No models installed")
} else {
for _, model := range status.Models {
fmt.Printf(" ✅ %s\n", model)
}
}
// Show available models for download
fmt.Println("\n🌐 Available Models:")
helper.PrintModelRecommendations()
// Show usage examples
fmt.Println("💡 Usage Examples:")
fmt.Println(" # Use specific model:")
fmt.Printf(" troubleshoot analyze --ollama-model llama2:13b bundle.tar.gz\n")
fmt.Println(" # Use preset models:")
fmt.Printf(" troubleshoot analyze --use-codellama bundle.tar.gz\n")
fmt.Printf(" troubleshoot analyze --use-mistral bundle.tar.gz\n")
fmt.Println(" # Pull a new model:")
fmt.Printf(" troubleshoot analyze --ollama-model llama2:13b --pull-model\n")
return nil
}
// handlePullModel pulls a specific model
func handlePullModel(v *viper.Viper) error {
helper := analyzer.NewOllamaHelper()
status := helper.GetHealthStatus()
if !status.Installed {
fmt.Println("❌ Ollama is not installed")
fmt.Println("💡 Install with: troubleshoot analyze --setup-ollama")
return errors.New("Ollama must be installed to pull models")
}
if !status.Running {
fmt.Println("❌ Ollama service is not running")
fmt.Println("🚀 Start with: ollama serve &")
return errors.New("Ollama service must be running to pull models")
}
// Determine which model to pull
model := determineOllamaModel(v)
fmt.Printf("📥 Pulling model: %s\n", model)
fmt.Println("=" + strings.Repeat("=", 50))
if err := helper.PullModel(model); err != nil {
return errors.Wrapf(err, "failed to pull model %s", model)
}
fmt.Printf("\n✅ Model %s ready for analysis!\n", model)
fmt.Println("\n💡 Test it with:")
fmt.Printf(" troubleshoot analyze --ollama-model %s bundle.tar.gz\n", model)
return nil
}
// runAdvancedAnalysis uses the new analysis engine with agent support
func runAdvancedAnalysis(v *viper.Viper, bundlePath string) error {
ctx := context.Background()
// Create the analysis engine
engine := analyzer.NewAnalysisEngine()
// Determine which agents to use
agents := v.GetStringSlice("agents")
// Handle Ollama flags
enableOllama := v.GetBool("enable-ollama")
disableOllama := v.GetBool("disable-ollama")
if enableOllama && !disableOllama {
// Add ollama to agents if not already present
hasOllama := false
for _, agent := range agents {
if agent == "ollama" {
hasOllama = true
break
}
}
if !hasOllama {
agents = append(agents, "ollama")
}
}
if disableOllama {
// Remove ollama from agents
filteredAgents := []string{}
for _, agent := range agents {
if agent != "ollama" {
filteredAgents = append(filteredAgents, agent)
}
}
agents = filteredAgents
}
// Register requested agents
registeredAgents := []string{}
for _, agentName := range agents {
switch agentName {
case "ollama":
if err := registerOllamaAgent(engine, v); err != nil {
return err
}
registeredAgents = append(registeredAgents, agentName)
case "local":
opts := &local.LocalAgentOptions{}
agent := local.NewLocalAgent(opts)
if err := engine.RegisterAgent("local", agent); err != nil {
return errors.Wrap(err, "failed to register local agent")
}
registeredAgents = append(registeredAgents, agentName)
default:
klog.Warningf("Unknown agent type: %s", agentName)
}
}
if len(registeredAgents) == 0 {
return errors.New("no analysis agents available - check your configuration")
}
fmt.Printf("🔍 Using analysis agents: %s\n", strings.Join(registeredAgents, ", "))
// Load support bundle
bundle, err := loadSupportBundle(bundlePath)
if err != nil {
return errors.Wrap(err, "failed to load support bundle")
}
// Load analyzer specs if provided
var customAnalyzers []*troubleshootv1beta2.Analyze
if specPath := v.GetString("analyzers"); specPath != "" {
customAnalyzers, err = loadAnalyzerSpecs(specPath)
if err != nil {
return errors.Wrap(err, "failed to load analyzer specs")
}
}
// Configure analysis options
opts := analyzer.AnalysisOptions{
Agents: registeredAgents,
IncludeRemediation: v.GetBool("include-remediation"),
CustomAnalyzers: customAnalyzers,
Timeout: 5 * time.Minute,
Concurrency: 2,
}
// Run analysis
fmt.Printf("🚀 Starting advanced analysis of bundle: %s\n", bundlePath)
result, err := engine.Analyze(ctx, bundle, opts)
if err != nil {
return errors.Wrap(err, "analysis failed")
}
// Display results
return displayAdvancedResults(result, v.GetString("output"), v.GetString("output-file"))
}
// registerOllamaAgent creates and registers an Ollama agent
func registerOllamaAgent(engine analyzer.AnalysisEngine, v *viper.Viper) error {
// Check if Ollama is available
helper := analyzer.NewOllamaHelper()
status := helper.GetHealthStatus()
if !status.Installed {
return showOllamaSetupHelp("Ollama is not installed")
}
if !status.Running {
return showOllamaSetupHelp("Ollama service is not running")
}
if len(status.Models) == 0 {
return showOllamaSetupHelp("No Ollama models are installed")
}
// Determine which model to use
selectedModel := determineOllamaModel(v)
// Auto-pull model if requested and not available
if v.GetBool("auto-pull-model") {
if err := ensureModelAvailable(selectedModel); err != nil {
return errors.Wrapf(err, "failed to ensure model %s is available", selectedModel)
}
}
// Create Ollama agent
opts := &ollama.OllamaAgentOptions{
Endpoint: v.GetString("ollama-endpoint"),
Model: selectedModel,
Timeout: 5 * time.Minute,
MaxTokens: 2000,
Temperature: 0.2,
}
agent, err := ollama.NewOllamaAgent(opts)
if err != nil {
return errors.Wrap(err, "failed to create Ollama agent")
}
// Register with engine
if err := engine.RegisterAgent("ollama", agent); err != nil {
return errors.Wrap(err, "failed to register Ollama agent")
}
return nil
}
// showOllamaSetupHelp displays helpful setup instructions when Ollama is not available
func showOllamaSetupHelp(reason string) error {
fmt.Printf("❌ Ollama AI analysis not available: %s\n\n", reason)
helper := analyzer.NewOllamaHelper()
fmt.Println("🔧 Quick Setup:")
fmt.Println(" troubleshoot analyze --setup-ollama")
fmt.Println()
fmt.Println("📋 Manual Setup:")
fmt.Println(" 1. Install: curl -fsSL https://ollama.ai/install.sh | sh")
fmt.Println(" 2. Start service: ollama serve &")
fmt.Println(" 3. Pull model: ollama pull llama2:7b")
fmt.Println(" 4. Retry analysis with: --enable-ollama")
fmt.Println()
fmt.Println("💡 Check status: troubleshoot analyze --check-ollama")
fmt.Println()
fmt.Println(helper.GetInstallInstructions())
return errors.New("Ollama setup required for AI-powered analysis")
}
// runLegacyAnalysis runs the original analysis logic for backward compatibility
func runLegacyAnalysis(v *viper.Viper, bundlePath string) error {
specPath := v.GetString("analyzers")
specContent := ""
var err error
if _, err = os.Stat(specPath); err == nil {
b, err := os.ReadFile(specPath)
if err != nil {
return err
}
specContent = string(b)
} else {
if !util.IsURL(specPath) {
// TODO: Better error message when we do not have a file/url etc
return fmt.Errorf("%s is not a URL and was not found", specPath)
}
req, err := http.NewRequest("GET", specPath, nil)
if err != nil {
return err
}
req.Header.Set("User-Agent", "Replicated_Analyzer/v1beta1")
resp, err := http.DefaultClient.Do(req)
if err != nil {
return err
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return err
}
specContent = string(body)
}
analyzeResults, err := analyzer.DownloadAndAnalyze(bundlePath, specContent)
if err != nil {
return errors.Wrap(err, "failed to download and analyze bundle")
}
for _, analyzeResult := range analyzeResults {
if analyzeResult.IsPass {
fmt.Printf("Pass: %s\n %s\n", analyzeResult.Title, analyzeResult.Message)
} else if analyzeResult.IsWarn {
fmt.Printf("Warn: %s\n %s\n", analyzeResult.Title, analyzeResult.Message)
} else if analyzeResult.IsFail {
fmt.Printf("Fail: %s\n %s\n", analyzeResult.Title, analyzeResult.Message)
}
}
return nil
}
// loadSupportBundle loads and parses a support bundle from file
func loadSupportBundle(bundlePath string) (*analyzer.SupportBundle, error) {
if _, err := os.Stat(bundlePath); os.IsNotExist(err) {
return nil, errors.Errorf("support bundle not found: %s", bundlePath)
}
klog.Infof("Loading support bundle: %s", bundlePath)
// Open the tar.gz file
file, err := os.Open(bundlePath)
if err != nil {
return nil, errors.Wrap(err, "failed to open support bundle")
}
defer file.Close()
// Create gzip reader
gzipReader, err := gzip.NewReader(file)
if err != nil {
return nil, errors.Wrap(err, "failed to create gzip reader")
}
defer gzipReader.Close()
// Create tar reader
tarReader := tar.NewReader(gzipReader)
// Create bundle structure
bundle := &analyzer.SupportBundle{
Files: make(map[string][]byte),
Metadata: &analyzer.SupportBundleMetadata{
CreatedAt: time.Now(),
Version: "1.0.0",
GeneratedBy: "troubleshoot-cli",
},
}
// Extract all files from tar
for {
header, err := tarReader.Next()
if err == io.EOF {
break
}
if err != nil {
return nil, errors.Wrap(err, "failed to read tar entry")
}
// Skip directories
if header.Typeflag == tar.TypeDir {
continue
}
// Read file content
content, err := io.ReadAll(tarReader)
if err != nil {
return nil, errors.Wrapf(err, "failed to read file %s", header.Name)
}
// Remove bundle directory prefix from file path for consistent access
// e.g., "live-cluster-bundle/cluster-info/version.json" → "cluster-info/version.json"
cleanPath := header.Name
if parts := strings.SplitN(header.Name, "/", 2); len(parts) == 2 {
cleanPath = parts[1]
}
bundle.Files[cleanPath] = content
klog.V(2).Infof("Loaded file: %s (%d bytes)", cleanPath, len(content))
}
klog.Infof("Successfully loaded support bundle with %d files", len(bundle.Files))
return bundle, nil
}
// loadAnalyzerSpecs loads analyzer specifications from file or URL
func loadAnalyzerSpecs(specPath string) ([]*troubleshootv1beta2.Analyze, error) {
klog.Infof("Loading analyzer specs from: %s", specPath)
// Read the analyzer spec file (same logic as runLegacyAnalysis)
specContent := ""
var err error
if _, err = os.Stat(specPath); err == nil {
b, err := os.ReadFile(specPath)
if err != nil {
return nil, errors.Wrap(err, "failed to read analyzer spec file")
}
specContent = string(b)
} else {
if !util.IsURL(specPath) {
return nil, errors.Errorf("analyzer spec %s is not a URL and was not found", specPath)
}
req, err := http.NewRequest("GET", specPath, nil)
if err != nil {
return nil, errors.Wrap(err, "failed to create HTTP request")
}
req.Header.Set("User-Agent", "Replicated_Analyzer/v1beta2")
resp, err := http.DefaultClient.Do(req)
if err != nil {
return nil, errors.Wrap(err, "failed to fetch analyzer spec")
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return nil, errors.Wrap(err, "failed to read analyzer spec response")
}
specContent = string(body)
}
// Parse the YAML/JSON into troubleshoot analyzer struct
var analyzerSpec troubleshootv1beta2.Analyzer
if err := yaml.Unmarshal([]byte(specContent), &analyzerSpec); err != nil {
return nil, errors.Wrap(err, "failed to parse analyzer spec")
}
// Return the analyzer specs from the parsed document
return analyzerSpec.Spec.Analyzers, nil
}
// displayAdvancedResults formats and displays analysis results
func displayAdvancedResults(result *analyzer.AnalysisResult, outputFormat, outputFile string) error {
if result == nil {
return errors.New("no analysis results to display")
}
// Display summary
fmt.Println("\n📊 Analysis Summary")
fmt.Println("=" + strings.Repeat("=", 50))
fmt.Printf("Total Analyzers: %d\n", result.Summary.TotalAnalyzers)
fmt.Printf("✅ Pass: %d\n", result.Summary.PassCount)
fmt.Printf("⚠️ Warn: %d\n", result.Summary.WarnCount)
fmt.Printf("❌ Fail: %d\n", result.Summary.FailCount)
fmt.Printf("🚫 Errors: %d\n", result.Summary.ErrorCount)
fmt.Printf("⏱️ Duration: %s\n", result.Summary.Duration)
fmt.Printf("🤖 Agents Used: %s\n", strings.Join(result.Summary.AgentsUsed, ", "))
if result.Summary.Confidence > 0 {
fmt.Printf("🎯 Confidence: %.1f%%\n", result.Summary.Confidence*100)
}
// Display results based on format
switch outputFormat {
case "json":
jsonData, err := json.MarshalIndent(result, "", " ")
if err != nil {
return errors.Wrap(err, "failed to marshal results to JSON")
}
fmt.Println("\n📄 Full Results (JSON):")
fmt.Println(string(jsonData))
default:
// Human-readable format
fmt.Println("\n🔍 Analysis Results")
fmt.Println("=" + strings.Repeat("=", 50))
for _, analyzerResult := range result.Results {
status := "❓"
if analyzerResult.IsPass {
status = "✅"
} else if analyzerResult.IsWarn {
status = "⚠️"
} else if analyzerResult.IsFail {
status = "❌"
}
fmt.Printf("\n%s %s", status, analyzerResult.Title)
if analyzerResult.AgentName != "" {
fmt.Printf(" [%s]", analyzerResult.AgentName)
}
if analyzerResult.Confidence > 0 {
fmt.Printf(" (%.0f%% confidence)", analyzerResult.Confidence*100)
}
fmt.Println()
if analyzerResult.Message != "" {
fmt.Printf(" %s\n", analyzerResult.Message)
}
if analyzerResult.Category != "" {
fmt.Printf(" Category: %s\n", analyzerResult.Category)
}
// Display insights if available
if len(analyzerResult.Insights) > 0 {
fmt.Println(" 💡 Insights:")
for _, insight := range analyzerResult.Insights {
fmt.Printf(" • %s\n", insight)
}
}
// Display remediation if available
if analyzerResult.Remediation != nil {
fmt.Printf(" 🔧 Remediation: %s\n", analyzerResult.Remediation.Description)
if analyzerResult.Remediation.Command != "" {
fmt.Printf(" 💻 Command: %s\n", analyzerResult.Remediation.Command)
}
}
}
// Display overall remediation suggestions
if len(result.Remediation) > 0 {
fmt.Println("\n🔧 Recommended Actions")
fmt.Println("=" + strings.Repeat("=", 50))
for i, remedy := range result.Remediation {
fmt.Printf("%d. %s\n", i+1, remedy.Description)
if remedy.Command != "" {
fmt.Printf(" Command: %s\n", remedy.Command)
}
if remedy.Documentation != "" {
fmt.Printf(" Docs: %s\n", remedy.Documentation)
}
}
}
// Display errors if any
if len(result.Errors) > 0 {
fmt.Println("\n⚠ Errors During Analysis")
fmt.Println("=" + strings.Repeat("=", 30))
for _, analysisError := range result.Errors {
fmt.Printf("• [%s] %s: %s\n", analysisError.Agent, analysisError.Category, analysisError.Error)
}
}
// Display agent metadata
if len(result.Metadata.Agents) > 0 {
fmt.Println("\n🤖 Agent Performance")
fmt.Println("=" + strings.Repeat("=", 40))
for _, agent := range result.Metadata.Agents {
fmt.Printf("• %s: %d results, %s duration", agent.Name, agent.ResultCount, agent.Duration)
if agent.ErrorCount > 0 {
fmt.Printf(" (%d errors)", agent.ErrorCount)
}
fmt.Println()
}
}
}
// Save results to file if requested
if outputFile != "" {
jsonData, err := json.MarshalIndent(result, "", " ")
if err != nil {
return errors.Wrap(err, "failed to marshal results for file output")
}
if err := os.WriteFile(outputFile, jsonData, 0644); err != nil {
return errors.Wrapf(err, "failed to write results to %s", outputFile)
}
fmt.Printf("\n💾 Analysis results saved to: %s\n", outputFile)
}
return nil
}
// determineOllamaModel selects the appropriate model based on flags
func determineOllamaModel(v *viper.Viper) string {
// Check for specific model flags first
if v.GetBool("use-codellama") {
return "codellama:7b"
}
if v.GetBool("use-mistral") {
return "mistral:7b"
}
// Fall back to explicit model specification or default
return v.GetString("ollama-model")
}
// ensureModelAvailable checks if model exists and pulls it if needed
func ensureModelAvailable(model string) error {
// Check if model is already available
cmd := exec.Command("ollama", "list")
output, err := cmd.Output()
if err != nil {
return errors.Wrap(err, "failed to check available models")
}
// Parse model list to see if our model exists
lines := strings.Split(string(output), "\n")
for _, line := range lines {
if strings.Contains(line, model) {
klog.Infof("Model %s is already available", model)
return nil
}
}
// Model not found, pull it
fmt.Printf("📚 Model %s not found, pulling automatically...\n", model)
pullCmd := exec.Command("ollama", "pull", model)
pullCmd.Stdout = os.Stdout
pullCmd.Stderr = os.Stderr
if err := pullCmd.Run(); err != nil {
return errors.Wrapf(err, "failed to pull model %s", model)
}
fmt.Printf("✅ Model %s pulled successfully!\n", model)
return nil
}