goroutinefanout

Documentation

Overview

Package goroutinefanout detects goroutine launches repeated by loops without a statically proven organization-approved bound.

Index

• Variables
• func New(options Options) (*analysis.Analyzer, error)
• type Options
• type Policy

Variables

var Analyzer, _ = New(Options{})

Analyzer is inactive until package policies are configured.

var Rule = shared.Rule{
	ID:                ruleID,
	Category:          shared.CategoryLifecycle,
	Severity:          shared.SeverityWarning,
	DefaultStatus:     shared.StatusAdvisory,
	Rationale:         "Loop-driven goroutine launches can make concurrency scale with untrusted or unbounded work.",
	Remediation:       "Use a fixed worker pool, a proven bounded semaphore, or synchronous per-iteration completion.",
	IntroducedVersion: "0.1.0",
	Configuration: shared.ConfigurationSchema{Properties: map[string]shared.ConfigurationProperty{
		"goroutine_fanout": {
			Type:        shared.ConfigurationArray,
			Description: "Package trees and maximum statically expanded goroutine launches.",
		},
	}},
}

Rule is the stable metadata for goroutine fan-out policy.

Functions

func New

func New(options Options) (*analysis.Analyzer, error)

New validates fan-out policy and constructs an analyzer.

Types

type Options

type Options struct {
	Policies []Policy
}

Options configures package fan-out limits.

type Policy

type Policy struct {
	Package   string
	MaxStatic int
}

Policy opts one package or trailing /... tree into fan-out enforcement.