Files
M AlveeandGitHub 47606f6238 distributed job framework (#557)
* feat: add DistJobType enum and sync distjob status types

Adds an iota-based DistJobType enum (mirrors the HealingDriveReason/
OfflineReason pattern already used in heal-commands.go) so distributed
job identity is a typed wire value instead of a bare string, per review
feedback on the eos distributed-job framework PR.

Also syncs DistJobLeaderStatus/DistJobNodeStatus field shapes to match
the current server-side JSON response (JobID/JobType replace JobName;
drops the unused Generation/AssignedSets/top-level CurrentBucket
fields that were never populated by the server).

* fix: bump vulnerable prometheus dep

- Add msgp generation (//msgp:tag json + //go:generate msgp) for
  DistJobLeaderStatus/DistJobNodeStatus, matching the pattern used by
  every other *-commands.go file in this package.
- Add unit tests for ListDistJobStatuses (success path, job-filter
  query param, DistJobTypeUnknown no-filter case, non-200 error path).
- Bump github.com/prometheus/prometheus v0.304.1 -> v0.312.0 to clear
  3 of the 4 govulncheck findings on this branch (GO-2026-5710,
  GO-2026-5381, GO-2026-5264, all fixed by that version). The 4th,
  GO-2026-5662, has no fix published upstream yet and also currently
  fails govulncheck on main independent of this branch.

* fix: pin go:generate directives to go.mod tool versions

Consolidate distjob-commands.go's separate //msgp:tag json directive
into the //go:generate msgp -d "tag json" flag, matching net-stats.go's
style (review feedback, PR #557).

Change every //go:generate msgp / //go:generate stringer directive
(31 occurrences, 30 files) to //go:generate go tool msgp / go tool
stringer, so generation always resolves the exact version pinned in
go.mod's tool block instead of whatever binary happens to be on PATH.
This was the root cause of the earlier stringer-drift CI failure.
Drop the now-unnecessary `go install -v tool` step from lint.yml.
2026-07-01 05:10:23 -04:00

130 lines
4.2 KiB
Go

// Copyright (c) 2015-2026 MinIO, Inc.
//
// This file is part of MinIO Object Storage stack
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package madmin
import (
"context"
"encoding/json"
"errors"
"io"
"iter"
"net/http"
"time"
"github.com/tinylib/msgp/msgp"
)
//msgp:tag json
//go:generate go tool msgp -d clearomitted -d "timezone utc" $GOFILE
// AlertType represents the type of alert event
//
//msgp:shim AlertType as:string
type AlertType string
const (
// AlertTypeLicense represents license expiration alerts
AlertTypeLicense AlertType = "license-expiry"
// AlertTypeCertificate represents TLS certificate expiration alerts
AlertTypeCertificate AlertType = "certificate-expiry"
// AlertTypeConfigMismatch represents server configuration mismatch alerts
AlertTypeConfigMismatch AlertType = "config-mismatch"
// AlertTypeErasureSetHealth represents erasure set write-redundancy degradation alerts
AlertTypeErasureSetHealth AlertType = "erasure-set-health"
// AlertTypeKMSUnavailable represents KMS connectivity failure alerts
AlertTypeKMSUnavailable AlertType = "kms-unavailable"
// AlertTypeStorageCapacity represents storage capacity critical alerts
AlertTypeStorageCapacity AlertType = "storage-capacity"
// AlertTypeLicensedCapacity represents cluster usage approaching the
// licensed (org-wide) storage capacity
AlertTypeLicensedCapacity AlertType = "licensed-capacity"
// AlertTypeScannerExcessFolders represents alerts for prefixes with excessive sub-folders
AlertTypeScannerExcessFolders AlertType = "scanner-excess-folders"
// AlertTypeScannerExcessVersions represents alerts for objects with excessive versions
AlertTypeScannerExcessVersions AlertType = "scanner-excess-versions"
)
// Alert represents a single alert event in the system.
// It captures alert information with contextual metadata including deployment and cluster information.
type Alert struct {
ID string `json:"id,omitempty"`
Type AlertType `json:"type"`
Timestamp time.Time `json:"timestamp"`
Title string `json:"title"`
Message string `json:"message"`
Details map[string]string `json:"details,omitempty"`
DeploymentID string `json:"deploymentId"`
ClusterName string `json:"clusterName"`
DedupKey string `json:"dedupKey,omitempty"`
}
// AlertLogOpts represents options for querying alerts
type AlertLogOpts struct {
Types []string `json:"types,omitempty"`
Interval time.Duration `json:"interval,omitempty"`
MaxPerNode int `json:"maxPerNode,omitempty"`
}
// GetAlerts returns alerts stored in the system as a streaming msgpack response
// via POST /admin/alerts. Use AlertLogOpts.Interval to control the server-side
// check interval.
func (adm AdminClient) GetAlerts(ctx context.Context, opts AlertLogOpts) iter.Seq2[*Alert, error] {
return func(yield func(*Alert, error) bool) {
alertOpts, err := json.Marshal(opts)
if err != nil {
yield(nil, err)
return
}
reqData := requestData{
relPath: adminAPIPrefix + "/alerts",
content: alertOpts,
}
resp, err := adm.executeMethod(ctx, http.MethodPost, reqData)
if err != nil {
yield(nil, err)
return
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
yield(nil, httpRespToErrorResponse(resp))
return
}
dec := msgp.NewReader(resp.Body)
for {
var alert Alert
if err = alert.DecodeMsg(dec); err != nil {
if errors.Is(err, io.EOF) {
break
}
if !yield(nil, err) {
return
}
continue
}
select {
case <-ctx.Done():
return
default:
if !yield(&alert, nil) {
return
}
}
}
}
}