alpha: monitoring plugin support

Author: 23doors

cmd/deploy.go

@@ -103,6 +103,7 @@ func (e *Executor) newDeployCmd() *cobra.Command {
 	f.StringSliceVarP(&skipApps, "skip-apps", "s", nil, "skip specified apps (if they exist), can specify multiple or separate values with comma in a form of <app type>.<name>, e.g.: static.website,service.api")
 	f.BoolVar(&opts.SkipAllApps, "skip-all-apps", false, "skip all apps (if they exist)")
 	f.BoolVar(&opts.SkipDNS, "skip-dns", false, "skip DNS setup (including self managed certificates)")
+	f.BoolVar(&opts.SkipMonitoring, "skip-monitoring", false, "skip monitoring setup")
 
 	return cmd
 }

cmd/status.go

@@ -22,6 +22,7 @@ func (e *Executor) newStatusCmd() *cobra.Command {
 				SkipAllApps:     true,
 				SkipBuild:       true,
 				SkipDNS:         true,
+				SkipMonitoring:  true,
 				SkipApply:       true,
 				SkipDiff:        true,
 				SkipStateCreate: true,

go.mod

@@ -21,7 +21,7 @@ require (
 	github.com/mholt/archiver/v3 v3.5.1
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/otiai10/copy v1.7.0
-	github.com/outblocks/outblocks-plugin-go v0.0.0-20220712161354-7d8111dfc469
+	github.com/outblocks/outblocks-plugin-go v0.0.0-20220803192450-7744c1c50028
 	github.com/pkg/errors v0.9.1
 	github.com/pterm/pterm v0.12.41
 	github.com/santhosh-tekuri/jsonschema/v5 v5.0.0

go.sum

@@ -339,8 +339,8 @@ github.com/otiai10/curr v1.0.0/go.mod h1:LskTG5wDwr8Rs+nNQ+1LlxRjAtTZZjtJW4rMXl6
 github.com/otiai10/mint v1.3.0/go.mod h1:F5AjcsTsWUqX+Na9fpHb52P8pcRX2CI6A3ctIT91xUo=
 github.com/otiai10/mint v1.3.3 h1:7JgpsBaN0uMkyju4tbYHu0mnM55hNKVYLsXmwr15NQI=
 github.com/otiai10/mint v1.3.3/go.mod h1:/yxELlJQ0ufhjUwhshSj+wFjZ78CnZ48/1wtmBH1OTc=
-github.com/outblocks/outblocks-plugin-go v0.0.0-20220712161354-7d8111dfc469 h1:KviouI7jaoEij8qlvLlKf6EMcUwCWWrwtQ7kqFo+OnY=
-github.com/outblocks/outblocks-plugin-go v0.0.0-20220712161354-7d8111dfc469/go.mod h1:Wnb50otE4YCKHxyxpnJi1G3iYVW5pnTAeLHpo3Mu0Lk=
+github.com/outblocks/outblocks-plugin-go v0.0.0-20220803192450-7744c1c50028 h1:PjHUEGVTudKUesESpBm9ukAIwvMYvTZTsOpBOQqITGI=
+github.com/outblocks/outblocks-plugin-go v0.0.0-20220803192450-7744c1c50028/go.mod h1:Wnb50otE4YCKHxyxpnJi1G3iYVW5pnTAeLHpo3Mu0Lk=
 github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
 github.com/pelletier/go-toml v1.9.5 h1:4yBQzkHv+7BHq2PQUZF3Mx0IYxG7LsP222s7Agd3ve8=
 github.com/pelletier/go-toml v1.9.5/go.mod h1:u1nR/EPcESfeI/szUZKdtJ0xRNbUoANCkoOuaOx1Y+c=

internal/statefile/state.go

@@ -99,8 +99,9 @@ type StateData struct {
 	Dependencies map[string]*apiv1.DependencyState `json:"dependencies"`
 	Plugins      map[string]*PluginState           `json:"plugins_state"` // plugin name -> object -> state
 
-	DNSRecords  DNSRecordMap        `json:"dns_records"`
-	DomainsInfo []*apiv1.DomainInfo `json:"domains_info"`
+	DNSRecords  DNSRecordMap          `json:"dns_records"`
+	DomainsInfo []*apiv1.DomainInfo   `json:"domains_info"`
+	Monitoring  *apiv1.MonitoringData `json:"monitoring"`
 }
 
 func NewStateData() *StateData {

pkg/actions/deploy.go

@@ -68,6 +68,7 @@ type DeployOptions struct {
 	TargetApps, SkipApps []string
 	SkipAllApps          bool
 	SkipDNS              bool
+	SkipMonitoring       bool
 	SkipDiff             bool
 	SkipApply            bool
 	SkipStateCreate      bool
@@ -104,7 +105,7 @@ func (d *Deploy) stateLockDeploy(ctx context.Context, state *statefile.StateData
 		return nil, err
 	}
 
-	res, err := d.planAndApplyDeploy(ctx, verify, state, nil, false)
+	res, err := d.planAndApply(ctx, verify, state, nil, false)
 	if res == nil && err != nil {
 		return nil, err
 	}
@@ -255,7 +256,7 @@ func (d *Deploy) checkIfDNSAreUsed(stateApps map[string]*apiv1.AppState, showWar
 			continue
 		}
 
-		u, _ := config.ParseAppURL(app.App.Url)
+		u, _ := config.ParseURL(app.App.Url, false)
 		if u == nil {
 			continue
 		}
@@ -374,7 +375,7 @@ func (d *Deploy) multilockPlanAndApplyDeploy(ctx context.Context, state *statefi
 
 		showWarnings = false
 
-		res, err := d.planAndApplyDeploy(ctx, verify, state, acquiredLocks, true)
+		res, err := d.planAndApply(ctx, verify, state, acquiredLocks, true)
 		if err != nil {
 			_ = releaseLocks(d.cfg, acquiredLocks)
 			d.log.Debugf("Released locks: %s\n", acquiredLocks)
@@ -512,11 +513,15 @@ func (d *Deploy) Run(ctx context.Context) error {
 	return nil
 }
 
-func (d *Deploy) promptDiff(deployChanges, dnsChanges []*change, acquiredLocks map[string]string, checkLocks bool) (empty, canceled bool, missingLocks []string) {
+func (d *Deploy) promptDiff(deployChanges, dnsChanges, monitoringChanges []*change, acquiredLocks map[string]string, checkLocks bool) (empty, canceled bool, missingLocks []string) {
 	missingLocksMap := make(map[string]struct{})
 
+	changes := deployChanges
+	changes = append(changes, dnsChanges...)
+	changes = append(changes, monitoringChanges...)
+
 	if checkLocks {
-		for _, chg := range append(deployChanges, dnsChanges...) {
+		for _, chg := range changes {
 			var lockID string
 
 			switch {
@@ -543,10 +548,10 @@ func (d *Deploy) promptDiff(deployChanges, dnsChanges []*change, acquiredLocks m
 	}
 
 	if d.opts.SkipDiff {
-		return len(deployChanges) == 0 && len(dnsChanges) == 0, false, missingLocks
+		return len(changes) == 0, false, missingLocks
 	}
 
-	empty, canceled = planPrompt(d.log, d.cfg.Env(), deployChanges, dnsChanges, d.opts.AutoApprove, d.opts.ForceApprove)
+	empty, canceled = planPrompt(d.log, d.cfg.Env(), deployChanges, dnsChanges, monitoringChanges, d.opts.AutoApprove, d.opts.ForceApprove)
 
 	return empty, canceled, missingLocks
 }
@@ -572,7 +577,7 @@ func computeDomainsInfo(cfg *config.Project, state *statefile.StateData) []*apiv
 			continue
 		}
 
-		u, _ := config.ParseAppURL(app.App.Url)
+		u, _ := config.ParseURL(app.App.Url, false)
 		if u == nil {
 			continue
 		}
@@ -644,14 +649,22 @@ func computeDomainsInfo(cfg *config.Project, state *statefile.StateData) []*apiv
 	return ret
 }
 
-func (d *Deploy) planAndApplyDeploy(ctx context.Context, verify bool, state *statefile.StateData, acquiredLocks map[string]string, checkLocks bool) (*planAndApplyResults, error) { // nolint: gocyclo
+func (d *Deploy) planAndApply(ctx context.Context, verify bool, state *statefile.StateData, acquiredLocks map[string]string, checkLocks bool) (*planAndApplyResults, error) { // nolint: gocyclo
 	var domains []*apiv1.DomainInfo
 
 	ret := &planAndApplyResults{
 		acquiredLocks: acquiredLocks,
 	}
 	stateBefore := state.DeepCopy()
 
+	monitoring := d.cfg.Monitoring.Proto()
+
+	if d.opts.SkipMonitoring || d.opts.Destroy {
+		monitoring = state.Monitoring
+	} else {
+		state.Monitoring = monitoring
+	}
+
 	if d.opts.SkipDNS || d.opts.Destroy {
 		domains = state.DomainsInfo
 	} else {
@@ -715,12 +728,19 @@ func (d *Deploy) planAndApplyDeploy(ctx context.Context, verify bool, state *sta
 		return nil, err
 	}
 
+	monitoringChanges, err := d.planMonitoring(ctx, state, monitoring, verify, destroy)
+	if err != nil {
+		spinner.Stop()
+
+		return nil, err
+	}
+
 	spinner.Stop()
 
 	deployChanges := computeDeployChange(d.cfg, &oldState, state, planRetMap)
 	dnsChanges := computeDNSChange(d.cfg, &oldState, state, planDNSRetMap)
 
-	ret.empty, ret.canceled, ret.missingLocks = d.promptDiff(deployChanges, dnsChanges, acquiredLocks, checkLocks)
+	ret.empty, ret.canceled, ret.missingLocks = d.promptDiff(deployChanges, dnsChanges, monitoringChanges, acquiredLocks, checkLocks)
 	if len(ret.missingLocks) != 0 {
 		return ret, nil
 	}
@@ -749,6 +769,13 @@ func (d *Deploy) planAndApplyDeploy(ctx context.Context, verify bool, state *sta
 			prog.Stop()
 		}
 
+		if err == nil {
+			prog, cb := applyProgress(d.log, monitoringChanges)
+			err = d.applyMonitoring(context.Background(), state, monitoring, destroy, cb)
+
+			prog.Stop()
+		}
+
 		if err == nil {
 			err = d.postApplyHook(ctx, state, apps, deps, verify, destroy)
 		}
@@ -1425,3 +1452,45 @@ func (d *Deploy) applyDNS(ctx context.Context, state *statefile.StateData, planM
 
 	return g.Wait()
 }
+
+func (d *Deploy) planMonitoring(ctx context.Context, state *statefile.StateData, monitoring *apiv1.MonitoringData, verify, destroy bool) ([]*change, error) {
+	if monitoring.Plugin == "" {
+		return nil, nil
+	}
+
+	plug := d.cfg.FindLoadedPlugin(monitoring.Plugin)
+	if plug == nil {
+		return nil, merry.Errorf("missing monitoring plugin: %s", plug.Name)
+	}
+
+	ret, err := plug.Client().PlanMonitoring(ctx, state, monitoring, plug.CommandArgs(deployCommand), verify, destroy)
+	if err != nil {
+		return nil, err
+	}
+
+	mergeState(state, plug.Name, ret.State, nil, nil, nil, nil)
+
+	chg := computeChangeInfo(d.cfg, state, plug, ret.Plan.Actions)
+
+	return chg, nil
+}
+
+func (d *Deploy) applyMonitoring(ctx context.Context, state *statefile.StateData, monitoring *apiv1.MonitoringData, destroy bool, callback func(*apiv1.ApplyAction)) error {
+	if monitoring.Plugin == "" {
+		return nil
+	}
+
+	plug := d.cfg.FindLoadedPlugin(monitoring.Plugin)
+	if plug == nil {
+		return merry.Errorf("missing monitoring plugin: %s", plug.Name)
+	}
+
+	ret, err := plug.Client().ApplyMonitoring(ctx, state, monitoring, plug.CommandArgs(deployCommand), destroy, callback)
+	if err != nil {
+		return err
+	}
+
+	mergeState(state, plug.Name, ret.State, nil, nil, nil, nil)
+
+	return nil
+}

pkg/actions/run.go

@@ -196,13 +196,13 @@ func (d *Run) prepareRun(cfg *config.Project) (*runInfo, error) {
 		appType.Properties = plugin_util.MustNewStruct(mergedProps)
 
 		appRun := &apiv1.AppRun{
-			App:     appType,
-			Url:     d.localURL(app.URL(), appPort, app.PathRedirect()),
-			Ip:      loopbackIP,
-			Port:    int32(appPort),
-			Command: app.RunInfo().Command.Array(),
-			Env:     app.RunInfo().Env,
-			Other:   plugin_util.MustNewStruct(app.RunInfo().Other),
+			App:        appType,
+			Url:        d.localURL(app.URL(), appPort, app.PathRedirect()),
+			Ip:         loopbackIP,
+			Port:       int32(appPort),
+			Command:    app.RunInfo().Command.Array(),
+			Env:        app.RunInfo().Env,
+			Properties: plugin_util.MustNewStruct(app.RunInfo().Other),
 		}
 
 		info.apps = append(info.apps, appRun)

pkg/actions/util.go

@@ -135,11 +135,11 @@ func computeDeployChange(cfg *config.Project, oldState, state *statefile.StateDa
 
 	for plugin, reslist := range m {
 		for _, p := range reslist {
-			if p.Deploy == nil {
+			if p.Plan == nil {
 				continue
 			}
 
-			chg := computeChangeInfo(cfg, state, plugin, p.Deploy.Actions)
+			chg := computeChangeInfo(cfg, state, plugin, p.Plan.Actions)
 			changes = append(changes, chg...)
 		}
 	}
@@ -151,11 +151,11 @@ func computeDNSChange(cfg *config.Project, oldState, state *statefile.StateData,
 	var changes []*change
 
 	for plugin, p := range m {
-		if p.Dns == nil {
+		if p.Plan == nil {
 			continue
 		}
 
-		chg := computeChangeInfo(cfg, state, plugin, p.Dns.Actions)
+		chg := computeChangeInfo(cfg, state, plugin, p.Plan.Actions)
 		changes = append(changes, chg...)
 	}
 
@@ -242,7 +242,7 @@ func planChangeInfo(header string, changes []*change) (info string, anyCritical
 	return info, anyCritical
 }
 
-func planPrompt(log logger.Logger, env string, deploy, dns []*change, approve, force bool) (empty, canceled bool) {
+func planPrompt(log logger.Logger, env string, deploy, dns, monitoring []*change, approve, force bool) (empty, canceled bool) {
 	sort.Slice(deploy, func(i, j int) bool {
 		if deploy[i].app == nil && deploy[j].app != nil {
 			return false
@@ -275,13 +275,21 @@ func planPrompt(log logger.Logger, env string, deploy, dns []*change, approve, f
 		info = append(info, dnsInfo)
 	}
 
+	// Monitoring
+	monitoringInfo, monitoringCritical := planChangeInfo("Monitoring:", monitoring)
+	if monitoringInfo != "" {
+		empty = false
+
+		info = append(info, monitoringInfo)
+	}
+
 	if empty {
 		log.Println("No changes detected.")
 
 		return true, false
 	}
 
-	critical = deployCritical || dnsCritical
+	critical = deployCritical || dnsCritical || monitoringCritical
 
 	log.Println(strings.Join(info, "\n\n"))
 

pkg/config/app.go

@@ -60,9 +60,9 @@ type AppDeployInfo struct {
 
 func (i *AppDeployInfo) Proto() *apiv1.AppDeployInfo {
 	return &apiv1.AppDeployInfo{
-		Plugin: i.Plugin,
-		Env:    i.Env,
-		Other:  plugin_util.MustNewStruct(i.Other),
+		Plugin:     i.Plugin,
+		Env:        i.Env,
+		Properties: plugin_util.MustNewStruct(i.Other),
 	}
 }
 
@@ -132,7 +132,7 @@ func (a *BasicApp) Validate() error {
 	)
 }
 
-func ParseAppURL(u string) (*url.URL, error) {
+func ParseURL(u string, normalize bool) (*url.URL, error) {
 	if u == "" {
 		return nil, nil
 	}
@@ -146,6 +146,12 @@ func ParseAppURL(u string) (*url.URL, error) {
 		return nil, err
 	}
 
+	if normalize {
+		if parsed.Path == "" {
+			parsed.Path = "/"
+		}
+	}
+
 	return parsed, nil
 }
 
@@ -188,7 +194,7 @@ func (a *BasicApp) Normalize(cfg *Project) error {
 	a.AppRun.Plugin = strings.ToLower(a.AppRun.Plugin)
 	a.AppURL = strings.ToLower(a.AppURL)
 
-	a.url, err = ParseAppURL(a.AppURL)
+	a.url, err = ParseURL(a.AppURL, false)
 	if err != nil {
 		return a.YAMLError("$.url", "url is invalid")
 	}

pkg/config/dns.go

@@ -44,11 +44,11 @@ func (s *DNS) Proto() *apiv1.DomainInfo {
 	}
 
 	return &apiv1.DomainInfo{
-		Domains:   s.Domains,
-		Cert:      s.SSLInfo.loadedCert,
-		Key:       s.SSLInfo.loadedKey,
-		DnsPlugin: dnsPlugin,
-		Other:     plugin_util.MustNewStruct(s.Other),
+		Domains:    s.Domains,
+		Cert:       s.SSLInfo.loadedCert,
+		Key:        s.SSLInfo.loadedKey,
+		DnsPlugin:  dnsPlugin,
+		Properties: plugin_util.MustNewStruct(s.Other),
 	}
 }