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 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
|
// Copyright 2020 PingCAP, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
package operator
import (
"context"
"encoding/json"
"fmt"
"math"
"sort"
"strconv"
"strings"
"github.com/AstroProfundis/sysinfo"
"github.com/pingcap/tiup/pkg/checkpoint"
"github.com/pingcap/tiup/pkg/cluster/ctxt"
"github.com/pingcap/tiup/pkg/cluster/module"
"github.com/pingcap/tiup/pkg/cluster/spec"
"github.com/pingcap/tiup/pkg/insight"
"go.uber.org/zap"
)
// CheckOptions control the list of checks to be performed
type CheckOptions struct {
// checks that are disabled by default
EnableCPU bool
EnableMem bool
EnableDisk bool
// pre-defined goups of checks
// GroupMinimal bool // a minimal set of checks
}
// Names of checks
var (
CheckNameGeneral = "general" // errors that don't fit any specific check
CheckNameNTP = "ntp"
CheckNameChrony = "chrony"
CheckNameOSVer = "os-version"
CheckNameSwap = "swap"
CheckNameSysctl = "sysctl"
CheckNameCPUThreads = "cpu-cores"
CheckNameCPUGovernor = "cpu-governor"
CheckNameDisks = "disk"
CheckNamePortListen = "listening-port"
CheckNameEpoll = "epoll-exclusive"
CheckNameMem = "memory"
CheckNameNet = "network"
CheckNameLimits = "limits"
CheckNameSysService = "service"
CheckNameSELinux = "selinux"
CheckNameCommand = "command"
CheckNameFio = "fio"
CheckNameTHP = "thp"
CheckNameDirPermission = "permission"
CheckNameDirExist = "exist"
CheckNameTimeZone = "timezone"
)
// CheckResult is the result of a check
type CheckResult struct {
Name string // Name of the check
Err error // An embedded error
Warn bool // The check didn't pass, but not a big problem
Msg string // A message or description
}
// Error implements the error interface
func (c CheckResult) Error() string {
return c.Err.Error()
}
// String returns a readable string of the error
func (c CheckResult) String() string {
return fmt.Sprintf("check failed for %s: %s", c.Name, c.Err)
}
// Unwrap implements the Wrapper interface
func (c CheckResult) Unwrap() error {
return c.Err
}
// IsWarning checks if the result is a warning error
func (c CheckResult) IsWarning() bool {
return c.Warn
}
// Passed checks if the result is a success
func (c CheckResult) Passed() bool {
return c.Err == nil
}
// CheckSystemInfo performs checks with basic system info
func CheckSystemInfo(opt *CheckOptions, rawData []byte) []*CheckResult {
var results []*CheckResult
var insightInfo insight.Info
if err := json.Unmarshal(rawData, &insightInfo); err != nil {
return append(results, &CheckResult{
Name: CheckNameGeneral,
Err: err,
})
}
// check basic system info
results = append(results, checkSysInfo(opt, &insightInfo.SysInfo)...)
// check time sync status
switch {
case insightInfo.ChronyStat.LeapStatus != "none":
results = append(results, checkChrony(&insightInfo.ChronyStat))
case insightInfo.NTP.Status != "none":
results = append(results, checkNTP(&insightInfo.NTP))
default:
results = append(results,
&CheckResult{
Name: CheckNameNTP,
Err: fmt.Errorf("The NTPd daemon or Chronyd daemon may be not installed"),
Warn: true,
},
)
}
epollResult := &CheckResult{
Name: CheckNameEpoll,
}
if !insightInfo.EpollExcl {
epollResult.Err = fmt.Errorf("epoll exclusive is not supported")
}
results = append(results, epollResult)
return results
}
func checkSysInfo(opt *CheckOptions, sysInfo *sysinfo.SysInfo) []*CheckResult {
var results []*CheckResult
results = append(results, checkOSInfo(opt, &sysInfo.OS))
// check cpu capacities
results = append(results, checkCPU(opt, &sysInfo.CPU)...)
// check memory size
results = append(results, checkMem(opt, &sysInfo.Memory)...)
// check network
results = append(results, checkNetwork(opt, sysInfo.Network)...)
return results
}
// Try to keep this in sync with
// https://docs.pingcap.com/tidb/stable/hardware-and-software-requirements#os-and-platform-requirements
//
// This information is in most cases based on the `ID` (Vendor) and `VERSION_ID` (Release) of /etc/os-release
// See https://github.com/AstroProfundis/sysinfo/blob/tiup/os.go for details.
func checkOSInfo(opt *CheckOptions, osInfo *sysinfo.OS) *CheckResult {
result := &CheckResult{
Name: CheckNameOSVer,
Msg: fmt.Sprintf("OS is %s %s", osInfo.Name, osInfo.Release),
}
// check OS vendor
switch osInfo.Vendor {
case "kylin":
// VERSION_ID="V10"
if ver, _ := strconv.ParseFloat(strings.Trim(osInfo.Version, "V"), 64); ver < 10 {
result.Err = fmt.Errorf("%s %s not supported, use version V10 or higher",
osInfo.Name, osInfo.Release)
return result
}
case "amzn":
// https://aws.amazon.com/linux/amazon-linux-2023/
if osInfo.Version == "2023" {
return result
}
// Amazon Linux 2 is based on CentOS 7 and is recommended for
// AWS Graviton 2 (ARM64) deployments.
// https://aws.amazon.com/amazon-linux-2/
if ver, _ := strconv.ParseFloat(osInfo.Version, 64); ver < 2 || ver >= 3 {
result.Err = fmt.Errorf("%s %s not supported, use Amazon Linux 2 or Amazon Linux 2023 please",
osInfo.Name, osInfo.Release)
return result
}
case "centos":
// CentOS Linux is EOL
// CentOS Stream 9 and newer is still fine
if ver, _ := strconv.ParseFloat(osInfo.Version, 64); ver < 9 {
result.Err = fmt.Errorf("%s %s not supported, use version 9 or higher",
osInfo.Name, osInfo.Release)
return result
}
case "redhat", "rhel", "ol":
// RHEL 8.4 or newer 8.x versions are supported
if ver, _ := strconv.ParseFloat(osInfo.Version, 64); ver < 8.4 || ver >= 9 {
result.Err = fmt.Errorf("%s %s not supported, use version 8.4 or a later 8.x version please",
osInfo.Name, osInfo.Release)
return result
}
case "rocky":
// Rocky Linux
if ver, _ := strconv.ParseFloat(osInfo.Version, 64); ver < 9.1 {
result.Err = fmt.Errorf("%s %s not supported, use version 9.1 or later please",
osInfo.Name, osInfo.Release)
return result
}
case "debian":
// debian support is not fully tested, but we suppose it should work
msg := "Debian support is not fully tested, be careful"
result.Err = fmt.Errorf("%s (%s)", result.Msg, msg)
result.Warn = true
if ver, _ := strconv.ParseFloat(osInfo.Version, 64); ver < 10 {
result.Err = fmt.Errorf("%s %s not supported, use version 10 or higher (%s)",
osInfo.Name, osInfo.Release, msg)
result.Warn = false
return result
}
case "ubuntu":
// ubuntu support is not fully tested, but we suppose it should work
msg := "Ubuntu support is not fully tested, be careful"
result.Err = fmt.Errorf("%s (%s)", result.Msg, msg)
result.Warn = true
if ver, _ := strconv.ParseFloat(osInfo.Version, 64); ver < 20.04 {
result.Err = fmt.Errorf("%s %s not supported, use version 20.04 or higher (%s)",
osInfo.Name, osInfo.Release, msg)
result.Warn = false
return result
}
case "openEuler":
return result
default:
result.Err = fmt.Errorf("OS vendor %s not supported", osInfo.Vendor)
return result
}
// TODO: check OS architecture
return result
}
func checkNTP(ntpInfo *insight.TimeStat) *CheckResult {
result := &CheckResult{
Name: CheckNameNTP,
}
if ntpInfo.Status == "none" {
zap.L().Info("The NTPd daemon may be not installed, skip.")
return result
}
if ntpInfo.Sync == "none" {
result.Err = fmt.Errorf("The NTPd daemon may be not start")
result.Warn = true
return result
}
// check if time offset greater than +- 500ms
if math.Abs(ntpInfo.Offset) >= 500 {
result.Err = fmt.Errorf("time offset %fms too high", ntpInfo.Offset)
}
return result
}
func checkChrony(chronyInfo *insight.ChronyStat) *CheckResult {
result := &CheckResult{
Name: CheckNameChrony,
}
if chronyInfo.LeapStatus == "none" {
zap.L().Info("The Chrony daemon may be not installed, skip.")
return result
}
// check if time offset greater than +- 500ms
if math.Abs(chronyInfo.LastOffset) >= 500 {
result.Err = fmt.Errorf("time offset %fms too high", chronyInfo.LastOffset)
}
return result
}
func checkCPU(opt *CheckOptions, cpuInfo *sysinfo.CPU) []*CheckResult {
var results []*CheckResult
if opt.EnableCPU && cpuInfo.Threads < 16 {
results = append(results, &CheckResult{
Name: CheckNameCPUThreads,
Err: fmt.Errorf("CPU thread count %d too low, needs 16 or more", cpuInfo.Threads),
})
} else {
results = append(results, &CheckResult{
Name: CheckNameCPUThreads,
Msg: fmt.Sprintf("number of CPU cores / threads: %d", cpuInfo.Threads),
})
}
// check for CPU frequency governor
if cpuInfo.Governor != "" {
if cpuInfo.Governor != "performance" {
results = append(results, &CheckResult{
Name: CheckNameCPUGovernor,
Err: fmt.Errorf("CPU frequency governor is %s, should use performance", cpuInfo.Governor),
})
} else {
results = append(results, &CheckResult{
Name: CheckNameCPUGovernor,
Msg: fmt.Sprintf("CPU frequency governor is %s", cpuInfo.Governor),
})
}
} else {
results = append(results, &CheckResult{
Name: CheckNameCPUGovernor,
Err: fmt.Errorf("Unable to determine current CPU frequency governor policy"),
Warn: true,
})
}
return results
}
func checkMem(opt *CheckOptions, memInfo *sysinfo.Memory) []*CheckResult {
var results []*CheckResult
if memInfo.Swap > 0 {
results = append(results, &CheckResult{
Name: CheckNameSwap,
Warn: true,
Err: fmt.Errorf("swap is enabled, please disable it for best performance"),
})
}
// 32GB
if opt.EnableMem && memInfo.Size < 1024*32 {
results = append(results, &CheckResult{
Name: CheckNameMem,
Err: fmt.Errorf("memory size %dMB too low, needs 32GB or more", memInfo.Size),
})
} else {
results = append(results, &CheckResult{
Name: CheckNameMem,
Msg: fmt.Sprintf("memory size is %dMB", memInfo.Size),
})
}
return results
}
func checkNetwork(opt *CheckOptions, networkDevices []sysinfo.NetworkDevice) []*CheckResult {
var results []*CheckResult
for _, netdev := range networkDevices {
// ignore the network devices that cannot be detected
if netdev.Speed == 0 {
continue
}
if netdev.Speed >= 1000 {
results = append(results, &CheckResult{
Name: CheckNameNet,
Msg: fmt.Sprintf("network speed of %s is %dMB", netdev.Name, netdev.Speed),
})
} else {
results = append(results, &CheckResult{
Name: CheckNameNet,
Err: fmt.Errorf("network speed of %s is %dMB too low, needs 1GB or more", netdev.Name, netdev.Speed),
})
}
}
return results
}
// CheckSysLimits checks limits in /etc/security/limits.conf
func CheckSysLimits(opt *CheckOptions, user string, l []byte) []*CheckResult {
var results []*CheckResult
var (
stackSoft int
nofileSoft int
nofileHard int
)
for line := range strings.SplitSeq(string(l), "\n") {
line = strings.TrimSpace(line)
if strings.HasPrefix(line, "#") {
continue
}
fields := strings.Fields(line)
if len(fields) < 3 || fields[0] != user {
continue
}
switch fields[2] {
case "nofile":
if fields[1] == "soft" {
nofileSoft, _ = strconv.Atoi(fields[3])
} else {
nofileHard, _ = strconv.Atoi(fields[3])
}
case "stack":
if fields[1] == "soft" {
stackSoft, _ = strconv.Atoi(fields[3])
}
}
}
if nofileSoft < 1000000 {
results = append(results, &CheckResult{
Name: CheckNameLimits,
Err: fmt.Errorf("soft limit of 'nofile' for user '%s' is not set or too low", user),
Msg: fmt.Sprintf("%s soft nofile 1000000", user),
})
}
if nofileHard < 1000000 {
results = append(results, &CheckResult{
Name: CheckNameLimits,
Err: fmt.Errorf("hard limit of 'nofile' for user '%s' is not set or too low", user),
Msg: fmt.Sprintf("%s hard nofile 1000000", user),
})
}
if stackSoft < 10240 {
results = append(results, &CheckResult{
Name: CheckNameLimits,
Err: fmt.Errorf("soft limit of 'stack' for user '%s' is not set or too low", user),
Msg: fmt.Sprintf("%s soft stack 10240", user),
})
}
// all pass
if len(results) < 1 {
results = append(results, &CheckResult{
Name: CheckNameLimits,
})
}
return results
}
// CheckKernelParameters checks kernel parameter values
func CheckKernelParameters(opt *CheckOptions, p []byte) []*CheckResult {
var results []*CheckResult
for line := range strings.SplitSeq(string(p), "\n") {
line = strings.TrimSpace(line)
fields := strings.Fields(line)
if len(fields) < 3 {
continue
}
switch fields[0] {
case "fs.file-max":
val, _ := strconv.Atoi(fields[2])
if val < 1000000 {
results = append(results, &CheckResult{
Name: CheckNameSysctl,
Err: fmt.Errorf("fs.file-max = %d, should be greater than 1000000", val),
Msg: "fs.file-max = 1000000",
})
}
case "net.core.somaxconn":
val, _ := strconv.Atoi(fields[2])
if val < 32768 {
results = append(results, &CheckResult{
Name: CheckNameSysctl,
Err: fmt.Errorf("net.core.somaxconn = %d, should 32768 or greater", val),
Msg: "net.core.somaxconn = 32768",
})
}
case "net.ipv4.tcp_tw_recycle":
val, _ := strconv.Atoi(fields[2])
if val != 0 {
results = append(results, &CheckResult{
Name: CheckNameSysctl,
Err: fmt.Errorf("net.ipv4.tcp_tw_recycle = %d, should be 0", val),
Msg: "net.ipv4.tcp_tw_recycle = 0",
})
}
case "net.ipv4.tcp_syncookies":
val, _ := strconv.Atoi(fields[2])
if val != 0 {
results = append(results, &CheckResult{
Name: CheckNameSysctl,
Err: fmt.Errorf("net.ipv4.tcp_syncookies = %d, should be 0", val),
Msg: "net.ipv4.tcp_syncookies = 0",
})
}
case "vm.overcommit_memory":
val, _ := strconv.Atoi(fields[2])
if opt.EnableMem && val != 0 && val != 1 {
results = append(results, &CheckResult{
Name: CheckNameSysctl,
Err: fmt.Errorf("vm.overcommit_memory = %d, should be 0 or 1", val),
Msg: "vm.overcommit_memory = 1",
})
}
case "vm.swappiness":
val, _ := strconv.Atoi(fields[2])
if val != 0 {
results = append(results, &CheckResult{
Name: CheckNameSysctl,
Err: fmt.Errorf("vm.swappiness = %d, should be 0", val),
Msg: "vm.swappiness = 0",
})
}
}
}
// all pass
if len(results) < 1 {
results = append(results, &CheckResult{
Name: CheckNameSysctl,
})
}
return results
}
// CheckServices checks if a service is running on the host
func CheckServices(ctx context.Context, e ctxt.Executor, host, service string, disable bool, systemdMode spec.SystemdMode) *CheckResult {
result := &CheckResult{
Name: CheckNameSysService,
}
// check if the service exist before checking its status, ignore when non-exist
stdout, _, err := e.Execute(
ctx,
fmt.Sprintf(
"systemctl list-unit-files --type service | grep -i %s.service | wc -l", service),
systemdMode != spec.UserMode)
if err != nil {
result.Err = err
return result
}
if cnt, _ := strconv.Atoi(strings.Trim(string(stdout), "\n")); cnt == 0 {
if !disable {
result.Err = fmt.Errorf("service %s not found, should be installed and started", service)
}
result.Msg = fmt.Sprintf("service %s not found, ignore", service)
return result
}
// The service checked here needs to use systemctl in system mode, so the value passed by scope is empty.
active, _, _, err := GetServiceStatus(ctx, e, service+".service", "", string(systemdMode))
if err != nil {
result.Err = err
}
switch disable {
case false:
if active != "active" {
result.Err = fmt.Errorf("service %s is not running", service)
result.Msg = fmt.Sprintf("start %s.service", service)
}
case true:
if active == "active" {
result.Err = fmt.Errorf("service %s is running but should be stopped", service)
result.Msg = fmt.Sprintf("stop %s.service", service)
}
}
return result
}
// CheckSELinux checks if SELinux is enabled on the host
func CheckSELinux(ctx context.Context, e ctxt.Executor, sudo bool) *CheckResult {
result := &CheckResult{
Name: CheckNameSELinux,
}
m := module.NewShellModule(module.ShellModuleConfig{
// ignore grep errors, the file may not exist for some systems
Command: "grep -E '^\\s*SELINUX=enforcing' /etc/selinux/config 2>/dev/null | wc -l",
Sudo: sudo,
})
stdout, stderr, err := m.Execute(ctx, e)
if err != nil {
result.Err = fmt.Errorf("%w %s", err, stderr)
return result
}
out := strings.Trim(string(stdout), "\n")
lines, err := strconv.Atoi(out)
if err != nil {
result.Err = fmt.Errorf("can not check SELinux status, please validate manually, %s", err)
result.Warn = true
return result
}
if lines > 0 {
result.Err = fmt.Errorf("SELinux is not disabled")
} else {
result.Msg = "SELinux is disabled"
}
return result
}
// CheckListeningPort checks if the ports are already binded by some process on host
func CheckListeningPort(opt *CheckOptions, host string, topo *spec.Specification, rawData []byte) []*CheckResult {
var results []*CheckResult
ports := make(map[int]struct{})
topo.IterInstance(func(inst spec.Instance) {
if inst.GetManageHost() != host {
return
}
for _, up := range inst.UsedPorts() {
if _, found := ports[up]; !found {
ports[up] = struct{}{}
}
}
})
for p := range ports {
for line := range strings.SplitSeq(string(rawData), "\n") {
fields := strings.Fields(line)
if len(fields) < 5 || fields[0] != "LISTEN" {
continue
}
addr := strings.Split(fields[3], ":")
lp, _ := strconv.Atoi(addr[len(addr)-1])
if p == lp {
results = append(results, &CheckResult{
Name: CheckNamePortListen,
Err: fmt.Errorf("port %d is already in use", lp),
})
break // ss may report multiple entries for the same port
}
}
}
return results
}
// CheckPartitions checks partition info of data directories
func CheckPartitions(opt *CheckOptions, host string, topo *spec.Specification, rawData []byte) []*CheckResult {
var results []*CheckResult
var insightInfo insight.Info
if err := json.Unmarshal(rawData, &insightInfo); err != nil {
return append(results, &CheckResult{
Name: CheckNameDisks,
Err: err,
})
}
flt := flatPartitions(insightInfo.Partitions)
parts := sortPartitions(flt)
// check if multiple instances are using the same partition as data storage
type storePartitionInfo struct {
comp string
path string
}
uniqueStores := make(map[string][]storePartitionInfo) // host+partition -> info
topo.IterInstance(func(inst spec.Instance) {
if inst.GetManageHost() != host {
return
}
for _, dataDir := range spec.MultiDirAbs(topo.GlobalOptions.User, inst.DataDir()) {
if dataDir == "" {
continue
}
blk := getDisk(parts, dataDir)
if blk == nil {
return
}
// only check for TiKV and TiFlash, other components are not that I/O sensitive
switch inst.ComponentName() {
case spec.ComponentTiKV,
spec.ComponentTiFlash:
usKey := fmt.Sprintf("%s:%s", host, blk.Mount.MountPoint)
uniqueStores[usKey] = append(uniqueStores[usKey], storePartitionInfo{
comp: inst.ComponentName(),
path: dataDir,
})
}
switch blk.Mount.FSType {
case "ext4":
if !strings.Contains(blk.Mount.Options, "nodelalloc") {
results = append(results, &CheckResult{
Name: CheckNameDisks,
Err: fmt.Errorf("mount point %s does not have 'nodelalloc' option set", blk.Mount.MountPoint),
})
}
fallthrough
case "xfs":
if !strings.Contains(blk.Mount.Options, "noatime") {
results = append(results, &CheckResult{
Name: CheckNameDisks,
Err: fmt.Errorf("mount point %s does not have 'noatime' option set", blk.Mount.MountPoint),
Warn: true,
})
}
default:
results = append(results, &CheckResult{
Name: CheckNameDisks,
Err: fmt.Errorf("mount point %s has an unsupported filesystem '%s'",
blk.Mount.MountPoint, blk.Mount.FSType),
})
}
}
})
for key, parts := range uniqueStores {
if len(parts) > 1 {
pathList := make([]string, 0)
for _, p := range parts {
pathList = append(pathList,
fmt.Sprintf("%s:%s", p.comp, p.path),
)
}
results = append(results, &CheckResult{
Name: CheckNameDisks,
Err: fmt.Errorf(
"multiple components %s are using the same partition %s as data dir",
strings.Join(pathList, ","),
key,
),
})
}
}
return results
}
func flatPartitions(parts []insight.BlockDev) []insight.BlockDev {
var flatBlk []insight.BlockDev
for _, blk := range parts {
if len(blk.SubDev) > 0 {
flatBlk = append(flatBlk, flatPartitions(blk.SubDev)...)
}
// blocks with empty mount points are ignored
if blk.Mount.MountPoint != "" {
flatBlk = append(flatBlk, blk)
}
}
return flatBlk
}
func sortPartitions(parts []insight.BlockDev) []insight.BlockDev {
// The longest mount point is at top of the list
sort.Slice(parts, func(i, j int) bool {
return len(parts[i].Mount.MountPoint) > len(parts[j].Mount.MountPoint)
})
return parts
}
// getDisk find the first block dev from the list that matches the given path
func getDisk(parts []insight.BlockDev, fullpath string) *insight.BlockDev {
for _, blk := range parts {
if strings.HasPrefix(fullpath, blk.Mount.MountPoint) {
return &blk
}
}
return nil
}
// CheckFIOResult parses and checks the result of fio test
func CheckFIOResult(rr, rw, lat []byte) []*CheckResult {
var results []*CheckResult
// check results for rand read test
var rrRes map[string]any
if err := json.Unmarshal(rr, &rrRes); err != nil {
results = append(results, &CheckResult{
Name: CheckNameFio,
Err: fmt.Errorf("error parsing result of random read test, %s", err),
})
} else if jobs, ok := rrRes["jobs"]; ok {
readRes := jobs.([]any)[0].(map[string]any)["read"]
readIOPS := readRes.(map[string]any)["iops"]
results = append(results, &CheckResult{
Name: CheckNameFio,
Msg: fmt.Sprintf("IOPS of random read: %f", readIOPS.(float64)),
})
} else {
results = append(results, &CheckResult{
Name: CheckNameFio,
Err: fmt.Errorf("error parsing result of random read test"),
})
}
// check results for rand read write
var rwRes map[string]any
if err := json.Unmarshal(rw, &rwRes); err != nil {
results = append(results, &CheckResult{
Name: CheckNameFio,
Err: fmt.Errorf("error parsing result of random read write test, %s", err),
})
} else if jobs, ok := rwRes["jobs"]; ok {
readRes := jobs.([]any)[0].(map[string]any)["read"]
readIOPS := readRes.(map[string]any)["iops"]
writeRes := jobs.([]any)[0].(map[string]any)["write"]
writeIOPS := writeRes.(map[string]any)["iops"]
results = append(results, &CheckResult{
Name: CheckNameFio,
Msg: fmt.Sprintf("IOPS of random read: %f, write: %f", readIOPS.(float64), writeIOPS.(float64)),
})
} else {
results = append(results, &CheckResult{
Name: CheckNameFio,
Err: fmt.Errorf("error parsing result of random read write test"),
})
}
// check results for read write latency
var latRes map[string]any
if err := json.Unmarshal(lat, &latRes); err != nil {
results = append(results, &CheckResult{
Name: CheckNameFio,
Err: fmt.Errorf("error parsing result of read write latency test, %s", err),
})
} else if jobs, ok := latRes["jobs"]; ok {
readRes := jobs.([]any)[0].(map[string]any)["read"]
readLat := readRes.(map[string]any)["lat_ns"]
readLatAvg := readLat.(map[string]any)["mean"]
writeRes := jobs.([]any)[0].(map[string]any)["write"]
writeLat := writeRes.(map[string]any)["lat_ns"]
writeLatAvg := writeLat.(map[string]any)["mean"]
results = append(results, &CheckResult{
Name: CheckNameFio,
Msg: fmt.Sprintf("Latency of random read: %fns, write: %fns", readLatAvg.(float64), writeLatAvg.(float64)),
})
} else {
results = append(results, &CheckResult{
Name: CheckNameFio,
Err: fmt.Errorf("error parsing result of read write latency test"),
})
}
return results
}
// CheckTHP checks THP in /sys/kernel/mm/transparent_hugepage/enabled
func CheckTHP(ctx context.Context, e ctxt.Executor, sudo bool) *CheckResult {
result := &CheckResult{
Name: CheckNameTHP,
}
m := module.NewShellModule(module.ShellModuleConfig{
Command: fmt.Sprintf(`if [ -d %[1]s ]; then cat %[1]s/enabled; fi`, "/sys/kernel/mm/transparent_hugepage"),
Sudo: sudo,
})
stdout, stderr, err := m.Execute(ctx, e)
if err != nil {
result.Err = fmt.Errorf("%w %s", err, stderr)
return result
}
for line := range strings.SplitSeq(strings.Trim(string(stdout), "\n"), "\n") {
if len(line) > 0 && !strings.Contains(line, "[never]") {
result.Err = fmt.Errorf("THP is enabled, please disable it for best performance")
return result
}
}
result.Msg = "THP is disabled"
return result
}
// CheckJRE checks if java command is available for TiSpark nodes
func CheckJRE(ctx context.Context, e ctxt.Executor, host string, topo *spec.Specification) []*CheckResult {
var results []*CheckResult
topo.IterInstance(func(inst spec.Instance) {
if inst.ComponentName() != spec.ComponentTiSpark {
return
}
// check if java cli is available
// the checkpoint part of context can't be shared between goroutines
stdout, stderr, err := e.Execute(checkpoint.NewContext(ctx), "java -version", false)
if err != nil {
results = append(results, &CheckResult{
Name: CheckNameCommand,
Err: fmt.Errorf("java not usable, %s", strings.Trim(string(stderr), "\n")),
Msg: "JRE is not installed properly or not set in PATH",
})
return
}
if len(stderr) > 0 {
// java -version returns as below:
// openjdk version "1.8.0_265"
// openjdk version "11.0.8" 2020-07-14
line := strings.Split(string(stderr), "\n")[0]
fields := strings.Split(line, `"`)
ver := strings.TrimSpace(fields[1])
if strings.Compare(ver, "1.8") < 0 {
results = append(results, &CheckResult{
Name: CheckNameCommand,
Err: fmt.Errorf("java version %s is not supported, use Java 8 (1.8)+", ver),
Msg: "Installed JRE is not Java 8+",
})
} else {
results = append(results, &CheckResult{
Name: CheckNameCommand,
Msg: "java: " + strings.Split(string(stderr), "\n")[0],
})
}
} else {
results = append(results, &CheckResult{
Name: CheckNameCommand,
Err: fmt.Errorf("unknown output of java %s", stdout),
Msg: "java: " + strings.Split(string(stdout), "\n")[0],
Warn: true,
})
}
})
return results
}
// CheckDirPermission checks if the user can write to given path
func CheckDirPermission(ctx context.Context, e ctxt.Executor, user, path string) []*CheckResult {
var results []*CheckResult
_, stderr, err := e.Execute(ctx,
fmt.Sprintf(
"/usr/bin/sudo -u %[1]s touch %[2]s/.tiup_cluster_check_file && rm -f %[2]s/.tiup_cluster_check_file",
user,
path,
),
false)
if err != nil || len(stderr) > 0 {
results = append(results, &CheckResult{
Name: CheckNameDirPermission,
Err: fmt.Errorf("unable to write to dir %s: %s", path, strings.Split(string(stderr), "\n")[0]),
Msg: fmt.Sprintf("%s: %s", path, err),
})
} else {
results = append(results, &CheckResult{
Name: CheckNameDirPermission,
Msg: fmt.Sprintf("%s is writable", path),
})
}
return results
}
// CheckDirIsExist check if the directory exists
func CheckDirIsExist(ctx context.Context, e ctxt.Executor, path string) []*CheckResult {
var results []*CheckResult
if path == "" {
return results
}
req, _, _ := e.Execute(ctx,
fmt.Sprintf(
"[ -e %s ] && echo 1",
path,
),
false)
if strings.ReplaceAll(string(req), "\n", "") == "1" {
results = append(results, &CheckResult{
Name: CheckNameDirExist,
Err: fmt.Errorf("%s already exists", path),
Msg: fmt.Sprintf("%s already exists", path),
})
}
return results
}
// CheckTimeZone performs checks if time zone is the same
func CheckTimeZone(ctx context.Context, topo *spec.Specification, host string, rawData []byte) []*CheckResult {
var results []*CheckResult
var insightInfo, pd0insightInfo insight.Info
if err := json.Unmarshal(rawData, &insightInfo); err != nil {
return append(results, &CheckResult{
Name: CheckNameTimeZone,
Err: err,
})
}
if len(topo.PDServers) < 1 {
return append(results, &CheckResult{
Name: CheckNameTimeZone,
Err: fmt.Errorf("no pd found"),
})
}
// skip compare with itself
if topo.PDServers[0].Host == host {
return nil
}
pd0stdout, _, _ := ctxt.GetInner(ctx).GetOutputs(topo.PDServers[0].Host)
if err := json.Unmarshal(pd0stdout, &pd0insightInfo); err != nil {
return append(results, &CheckResult{
Name: CheckNameTimeZone,
Err: err,
})
}
timezone := insightInfo.SysInfo.Node.Timezone
pd0timezone := pd0insightInfo.SysInfo.Node.Timezone
if timezone == pd0timezone {
results = append(results, &CheckResult{
Name: CheckNameTimeZone,
Msg: "time zone is the same as the first PD machine: " + timezone,
})
} else {
results = append(results, &CheckResult{
Name: CheckNameTimeZone,
Err: fmt.Errorf("time zone is %s, but the firt PD is %s", timezone, pd0timezone),
})
}
return results
}
|