1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
|
//
// Copyright (c) 2015-2024 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"
"net/http"
"net/http/httptrace"
"net/url"
"strconv"
"sync"
"time"
)
const (
minioWriteQuorumHeader = "x-minio-write-quorum"
minIOHealingDrives = "x-minio-healing-drives"
clusterCheckEndpoint = "/minio/health/cluster"
clusterReadCheckEndpoint = "/minio/health/cluster/read"
maintanenceURLParameterKey = "maintenance"
)
// HealthResult represents the cluster health result
type HealthResult struct {
Healthy bool
MaintenanceMode bool
WriteQuorum int
HealingDrives int
}
// HealthOpts represents the input options for the health check
type HealthOpts struct {
ClusterRead bool
Maintenance bool
}
// Healthy will hit `/minio/health/cluster` and `/minio/health/cluster/ready` anonymous APIs to check the cluster health
func (an *AnonymousClient) Healthy(ctx context.Context, opts HealthOpts) (result HealthResult, err error) {
if opts.ClusterRead {
return an.clusterReadCheck(ctx)
}
return an.clusterCheck(ctx, opts.Maintenance)
}
func (an *AnonymousClient) clusterCheck(ctx context.Context, maintenance bool) (result HealthResult, err error) {
urlValues := make(url.Values)
if maintenance {
urlValues.Set(maintanenceURLParameterKey, "true")
}
resp, err := an.executeMethod(ctx, http.MethodGet, requestData{
relPath: clusterCheckEndpoint,
queryValues: urlValues,
}, nil)
defer closeResponse(resp)
if err != nil {
return result, err
}
if resp != nil {
writeQuorumStr := resp.Header.Get(minioWriteQuorumHeader)
if writeQuorumStr != "" {
result.WriteQuorum, err = strconv.Atoi(writeQuorumStr)
if err != nil {
return result, err
}
}
healingDrivesStr := resp.Header.Get(minIOHealingDrives)
if healingDrivesStr != "" {
result.HealingDrives, err = strconv.Atoi(healingDrivesStr)
if err != nil {
return result, err
}
}
switch resp.StatusCode {
case http.StatusOK:
result.Healthy = true
case http.StatusPreconditionFailed:
result.MaintenanceMode = true
default:
// Not Healthy
}
}
return result, nil
}
func (an *AnonymousClient) clusterReadCheck(ctx context.Context) (result HealthResult, err error) {
resp, err := an.executeMethod(ctx, http.MethodGet, requestData{
relPath: clusterReadCheckEndpoint,
}, nil)
defer closeResponse(resp)
if err != nil {
return result, err
}
if resp != nil {
switch resp.StatusCode {
case http.StatusOK:
result.Healthy = true
default:
// Not Healthy
}
}
return result, nil
}
// AliveOpts customizing liveness check.
type AliveOpts struct {
Readiness bool // send request to /minio/health/ready
}
// AliveResult returns the time spent getting a response
// back from the server on /minio/health/live endpoint
type AliveResult struct {
Endpoint *url.URL `json:"endpoint"`
ResponseTime time.Duration `json:"responseTime"`
DNSResolveTime time.Duration `json:"dnsResolveTime"`
Online bool `json:"online"` // captures x-minio-server-status
Error error `json:"error"`
}
// Alive will hit `/minio/health/live` to check if server is reachable, optionally returns
// the amount of time spent getting a response back from the server.
func (an *AnonymousClient) Alive(ctx context.Context, opts AliveOpts, servers ...ServerProperties) (resultsCh chan AliveResult) {
resource := "/minio/health/live"
if opts.Readiness {
resource = "/minio/health/ready"
}
scheme := "http"
if an.endpointURL != nil {
scheme = an.endpointURL.Scheme
}
resultsCh = make(chan AliveResult)
go func() {
defer close(resultsCh)
if len(servers) == 0 {
an.alive(ctx, an.endpointURL, resource, resultsCh)
} else {
var wg sync.WaitGroup
wg.Add(len(servers))
for _, server := range servers {
server := server
go func() {
defer wg.Done()
sscheme := server.Scheme
if sscheme == "" {
sscheme = scheme
}
u, err := url.Parse(sscheme + "://" + server.Endpoint)
if err != nil {
resultsCh <- AliveResult{
Error: err,
}
return
}
an.alive(ctx, u, resource, resultsCh)
}()
}
wg.Wait()
}
}()
return resultsCh
}
func (an *AnonymousClient) alive(ctx context.Context, u *url.URL, resource string, resultsCh chan AliveResult) {
var (
dnsStartTime, dnsDoneTime time.Time
reqStartTime, firstByteTime time.Time
)
trace := &httptrace.ClientTrace{
DNSStart: func(_ httptrace.DNSStartInfo) {
dnsStartTime = time.Now()
},
DNSDone: func(_ httptrace.DNSDoneInfo) {
dnsDoneTime = time.Now()
},
GetConn: func(_ string) {
// GetConn is called again when trace is ON
// https://github.com/golang/go/issues/44281
if reqStartTime.IsZero() {
reqStartTime = time.Now()
}
},
GotFirstResponseByte: func() {
firstByteTime = time.Now()
},
}
resp, err := an.executeMethod(ctx, http.MethodGet, requestData{
relPath: resource,
endpointOverride: u,
}, trace)
closeResponse(resp)
var respTime time.Duration
if firstByteTime.IsZero() {
respTime = time.Since(reqStartTime)
} else {
respTime = firstByteTime.Sub(reqStartTime) - dnsDoneTime.Sub(dnsStartTime)
}
result := AliveResult{
Endpoint: u,
ResponseTime: respTime,
DNSResolveTime: dnsDoneTime.Sub(dnsStartTime),
}
if err != nil {
result.Error = err
} else {
result.Online = resp.StatusCode == http.StatusOK && resp.Header.Get("x-minio-server-status") != "offline"
}
select {
case <-ctx.Done():
return
case resultsCh <- result:
}
}
|