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 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198
|
package client
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"reflect"
"regexp"
"slices"
"strconv"
"strings"
"sync"
"time"
"golang.org/x/sync/errgroup"
)
const (
// APIVersion is the default version of NGINX Plus API supported by the client.
APIVersion = 9
pathNotFoundCode = "PathNotFound"
streamContext = true
httpContext = false
defaultServerPort = "80"
)
var (
supportedAPIVersions = versions{4, 5, 6, 7, 8, 9}
// Default values for servers in Upstreams.
defaultMaxConns = 0
defaultMaxFails = 1
defaultFailTimeout = "10s"
defaultSlowStart = "0s"
defaultBackup = false
defaultDown = false
defaultWeight = 1
)
var (
ErrParameterRequired = errors.New("parameter is required")
ErrServerNotFound = errors.New("server not found")
ErrServerExists = errors.New("server already exists")
ErrNotSupported = errors.New("not supported")
ErrInvalidTimeout = errors.New("invalid timeout")
ErrParameterMismatch = errors.New("encountered duplicate server with different parameters")
ErrPlusVersionNotFound = errors.New("plus version not found in the input string")
)
// StatusError is an interface that defines our API with consumers of the plus client errors.
// The error will return a http status code and an NGINX error code.
type StatusError interface {
Status() int
Code() string
}
var _ StatusError = (*internalError)(nil)
// NginxClient lets you access NGINX Plus API.
type NginxClient struct {
httpClient *http.Client
apiEndpoint string
apiVersion int
checkAPI bool
}
type Option func(*NginxClient)
type versions []int
// UpstreamServer lets you configure HTTP upstreams.
type UpstreamServer struct {
MaxConns *int `json:"max_conns,omitempty"`
MaxFails *int `json:"max_fails,omitempty"`
Backup *bool `json:"backup,omitempty"`
Down *bool `json:"down,omitempty"`
Weight *int `json:"weight,omitempty"`
Server string `json:"server"`
FailTimeout string `json:"fail_timeout,omitempty"`
SlowStart string `json:"slow_start,omitempty"`
Route string `json:"route,omitempty"`
Service string `json:"service,omitempty"`
ID int `json:"id,omitempty"`
Drain bool `json:"drain,omitempty"`
}
// StreamUpstreamServer lets you configure Stream upstreams.
type StreamUpstreamServer struct {
MaxConns *int `json:"max_conns,omitempty"`
MaxFails *int `json:"max_fails,omitempty"`
Backup *bool `json:"backup,omitempty"`
Down *bool `json:"down,omitempty"`
Weight *int `json:"weight,omitempty"`
Server string `json:"server"`
FailTimeout string `json:"fail_timeout,omitempty"`
SlowStart string `json:"slow_start,omitempty"`
Service string `json:"service,omitempty"`
ID int `json:"id,omitempty"`
}
type apiErrorResponse struct {
RequestID string `json:"request_id"`
Href string `json:"href"`
Error apiError `json:"error"`
}
func (resp *apiErrorResponse) toString() string {
return fmt.Sprintf("error.status=%v; error.text=%v; error.code=%v; request_id=%v; href=%v",
resp.Error.Status, resp.Error.Text, resp.Error.Code, resp.RequestID, resp.Href)
}
type apiError struct {
Text string `json:"text"`
Code string `json:"code"`
Status int `json:"status"`
}
type internalError struct {
err string
apiError apiError
}
// Status returns the HTTP status code of the error.
func (internalError *internalError) Status() int {
return internalError.apiError.Status
}
// Status returns the NGINX error code on the response.
func (internalError *internalError) Code() string {
return internalError.apiError.Code
}
// Error allows internalError to match the Error interface.
func (internalError *internalError) Error() string {
return internalError.err
}
// Wrap is a way of including current context while preserving previous error information,
// similar to `return fmt.Errorf("error doing foo, err: %v", err)` but for our internalError type.
func (internalError *internalError) Wrap(err string) *internalError {
internalError.err = fmt.Sprintf("%v. %v", err, internalError.err)
return internalError
}
// this is an internal representation of the Stats object including endpoint and streamEndpoint lists.
type extendedStats struct {
endpoints []string
streamEndpoints []string
Stats
}
func defaultStats() *extendedStats {
return &extendedStats{
endpoints: []string{},
streamEndpoints: []string{},
Stats: Stats{
Upstreams: map[string]Upstream{},
ServerZones: map[string]ServerZone{},
StreamServerZones: map[string]StreamServerZone{},
StreamUpstreams: map[string]StreamUpstream{},
Slabs: map[string]Slab{},
Caches: map[string]HTTPCache{},
HTTPLimitConnections: map[string]LimitConnection{},
StreamLimitConnections: map[string]LimitConnection{},
HTTPLimitRequests: map[string]HTTPLimitRequest{},
Resolvers: map[string]Resolver{},
LocationZones: map[string]LocationZone{},
StreamZoneSync: nil,
Workers: []*Workers{},
NginxInfo: NginxInfo{},
SSL: SSL{},
Connections: Connections{},
HTTPRequests: HTTPRequests{},
Processes: Processes{},
},
}
}
// Stats represents NGINX Plus stats fetched from the NGINX Plus API.
// https://nginx.org/en/docs/http/ngx_http_api_module.html
type Stats struct {
Upstreams Upstreams
ServerZones ServerZones
StreamServerZones StreamServerZones
StreamUpstreams StreamUpstreams
Slabs Slabs
Caches Caches
HTTPLimitConnections HTTPLimitConnections
StreamLimitConnections StreamLimitConnections
HTTPLimitRequests HTTPLimitRequests
Resolvers Resolvers
LocationZones LocationZones
StreamZoneSync *StreamZoneSync
Workers []*Workers
NginxInfo NginxInfo
SSL SSL
Connections Connections
HTTPRequests HTTPRequests
Processes Processes
}
// NginxInfo contains general information about NGINX Plus.
type NginxInfo struct {
Version string
Build string
Address string
LoadTimestamp string `json:"load_timestamp"`
Timestamp string
Generation uint64
ProcessID uint64 `json:"pid"`
ParentProcessID uint64 `json:"ppid"`
}
// LicenseReporting contains information about license status for NGINX Plus.
type LicenseReporting struct {
Healthy bool
Fails uint64
Grace uint64
}
// NginxLicense contains licensing information about NGINX Plus.
type NginxLicense struct {
ActiveTill uint64 `json:"active_till"`
Eval bool
Reporting LicenseReporting
}
// Caches is a map of cache stats by cache zone.
type Caches = map[string]HTTPCache
// HTTPCache represents a zone's HTTP Cache.
type HTTPCache struct {
Size uint64
MaxSize uint64 `json:"max_size"`
Cold bool
Hit CacheStats
Stale CacheStats
Updating CacheStats
Revalidated CacheStats
Miss CacheStats
Expired ExtendedCacheStats
Bypass ExtendedCacheStats
}
// CacheStats are basic cache stats.
type CacheStats struct {
Responses uint64
Bytes uint64
}
// ExtendedCacheStats are extended cache stats.
type ExtendedCacheStats struct {
CacheStats
ResponsesWritten uint64 `json:"responses_written"`
BytesWritten uint64 `json:"bytes_written"`
}
// Connections represents connection related stats.
type Connections struct {
Accepted uint64
Dropped uint64
Active uint64
Idle uint64
}
// Slabs is map of slab stats by zone name.
type Slabs map[string]Slab
// Slab represents slab related stats.
type Slab struct {
Slots Slots
Pages Pages
}
// Pages represents the slab memory usage stats.
type Pages struct {
Used uint64
Free uint64
}
// Slots is a map of slots by slot size.
type Slots map[string]Slot
// Slot represents slot related stats.
type Slot struct {
Used uint64
Free uint64
Reqs uint64
Fails uint64
}
// HTTPRequests represents HTTP request related stats.
type HTTPRequests struct {
Total uint64
Current uint64
}
// SSL represents SSL related stats.
type SSL struct {
Handshakes uint64
HandshakesFailed uint64 `json:"handshakes_failed"`
SessionReuses uint64 `json:"session_reuses"`
NoCommonProtocol uint64 `json:"no_common_protocol"`
NoCommonCipher uint64 `json:"no_common_cipher"`
HandshakeTimeout uint64 `json:"handshake_timeout"`
PeerRejectedCert uint64 `json:"peer_rejected_cert"`
VerifyFailures VerifyFailures `json:"verify_failures"`
}
type VerifyFailures struct {
NoCert uint64 `json:"no_cert"`
ExpiredCert uint64 `json:"expired_cert"`
RevokedCert uint64 `json:"revoked_cert"`
HostnameMismatch uint64 `json:"hostname_mismatch"`
Other uint64 `json:"other"`
}
// ServerZones is map of server zone stats by zone name.
type ServerZones map[string]ServerZone
// ServerZone represents server zone related stats.
type ServerZone struct {
Processing uint64
Requests uint64
Responses Responses
Discarded uint64
Received uint64
Sent uint64
SSL SSL
}
// StreamServerZones is map of stream server zone stats by zone name.
type StreamServerZones map[string]StreamServerZone
// StreamServerZone represents stream server zone related stats.
type StreamServerZone struct {
Processing uint64
Connections uint64
Sessions Sessions
Discarded uint64
Received uint64
Sent uint64
SSL SSL
}
// StreamZoneSync represents the sync information per each shared memory zone and the sync information per node in a cluster.
type StreamZoneSync struct {
Zones map[string]SyncZone
Status StreamZoneSyncStatus
}
// SyncZone represents the synchronization status of a shared memory zone.
type SyncZone struct {
RecordsPending uint64 `json:"records_pending"`
RecordsTotal uint64 `json:"records_total"`
}
// StreamZoneSyncStatus represents the status of a shared memory zone.
type StreamZoneSyncStatus struct {
BytesIn uint64 `json:"bytes_in"`
MsgsIn uint64 `json:"msgs_in"`
MsgsOut uint64 `json:"msgs_out"`
BytesOut uint64 `json:"bytes_out"`
NodesOnline uint64 `json:"nodes_online"`
}
// Responses represents HTTP response related stats.
type Responses struct {
Codes HTTPCodes
Responses1xx uint64 `json:"1xx"`
Responses2xx uint64 `json:"2xx"`
Responses3xx uint64 `json:"3xx"`
Responses4xx uint64 `json:"4xx"`
Responses5xx uint64 `json:"5xx"`
Total uint64
}
// HTTPCodes represents HTTP response codes.
type HTTPCodes struct {
HTTPContinue uint64 `json:"100,omitempty"`
HTTPSwitchingProtocols uint64 `json:"101,omitempty"`
HTTPProcessing uint64 `json:"102,omitempty"`
HTTPOk uint64 `json:"200,omitempty"`
HTTPCreated uint64 `json:"201,omitempty"`
HTTPAccepted uint64 `json:"202,omitempty"`
HTTPNoContent uint64 `json:"204,omitempty"`
HTTPPartialContent uint64 `json:"206,omitempty"`
HTTPSpecialResponse uint64 `json:"300,omitempty"`
HTTPMovedPermanently uint64 `json:"301,omitempty"`
HTTPMovedTemporarily uint64 `json:"302,omitempty"`
HTTPSeeOther uint64 `json:"303,omitempty"`
HTTPNotModified uint64 `json:"304,omitempty"`
HTTPTemporaryRedirect uint64 `json:"307,omitempty"`
HTTPBadRequest uint64 `json:"400,omitempty"`
HTTPUnauthorized uint64 `json:"401,omitempty"`
HTTPForbidden uint64 `json:"403,omitempty"`
HTTPNotFound uint64 `json:"404,omitempty"`
HTTPNotAllowed uint64 `json:"405,omitempty"`
HTTPRequestTimeOut uint64 `json:"408,omitempty"`
HTTPConflict uint64 `json:"409,omitempty"`
HTTPLengthRequired uint64 `json:"411,omitempty"`
HTTPPreconditionFailed uint64 `json:"412,omitempty"`
HTTPRequestEntityTooLarge uint64 `json:"413,omitempty"`
HTTPRequestURITooLarge uint64 `json:"414,omitempty"`
HTTPUnsupportedMediaType uint64 `json:"415,omitempty"`
HTTPRangeNotSatisfiable uint64 `json:"416,omitempty"`
HTTPTooManyRequests uint64 `json:"429,omitempty"`
HTTPClose uint64 `json:"444,omitempty"`
HTTPRequestHeaderTooLarge uint64 `json:"494,omitempty"`
HTTPSCertError uint64 `json:"495,omitempty"`
HTTPSNoCert uint64 `json:"496,omitempty"`
HTTPToHTTPS uint64 `json:"497,omitempty"`
HTTPClientClosedRequest uint64 `json:"499,omitempty"`
HTTPInternalServerError uint64 `json:"500,omitempty"`
HTTPNotImplemented uint64 `json:"501,omitempty"`
HTTPBadGateway uint64 `json:"502,omitempty"`
HTTPServiceUnavailable uint64 `json:"503,omitempty"`
HTTPGatewayTimeOut uint64 `json:"504,omitempty"`
HTTPInsufficientStorage uint64 `json:"507,omitempty"`
}
// Sessions represents stream session related stats.
type Sessions struct {
Sessions2xx uint64 `json:"2xx"`
Sessions4xx uint64 `json:"4xx"`
Sessions5xx uint64 `json:"5xx"`
Total uint64
}
// Upstreams is a map of upstream stats by upstream name.
type Upstreams map[string]Upstream
// Upstream represents upstream related stats.
type Upstream struct {
Zone string
Peers []Peer
Queue Queue
Keepalive int
Zombies int
}
// StreamUpstreams is a map of stream upstream stats by upstream name.
type StreamUpstreams map[string]StreamUpstream
// StreamUpstream represents stream upstream related stats.
type StreamUpstream struct {
Zone string
Peers []StreamPeer
Zombies int
}
// Queue represents queue related stats for an upstream.
type Queue struct {
Size int
MaxSize int `json:"max_size"`
Overflows uint64
}
// Peer represents peer (upstream server) related stats.
type Peer struct {
Server string
Service string
Name string
Selected string
Downstart string
State string
Responses Responses
SSL SSL
HealthChecks HealthChecks `json:"health_checks"`
Requests uint64
ID int
MaxConns int `json:"max_conns"`
Sent uint64
Received uint64
Fails uint64
Unavail uint64
Active uint64
Downtime uint64
Weight int
HeaderTime uint64 `json:"header_time"`
ResponseTime uint64 `json:"response_time"`
Backup bool
}
// StreamPeer represents peer (stream upstream server) related stats.
type StreamPeer struct {
Server string
Service string
Name string
Selected string
Downstart string
State string
SSL SSL
HealthChecks HealthChecks `json:"health_checks"`
Connections uint64
Received uint64
ID int
ConnectTime int `json:"connect_time"`
FirstByteTime int `json:"first_byte_time"`
ResponseTime uint64 `json:"response_time"`
Sent uint64
MaxConns int `json:"max_conns"`
Fails uint64
Unavail uint64
Active uint64
Downtime uint64
Weight int
Backup bool
}
// HealthChecks represents health check related stats for a peer.
type HealthChecks struct {
Checks uint64
Fails uint64
Unhealthy uint64
LastPassed bool `json:"last_passed"`
}
// LocationZones represents location_zones related stats.
type LocationZones map[string]LocationZone
// Resolvers represents resolvers related stats.
type Resolvers map[string]Resolver
// LocationZone represents location_zones related stats.
type LocationZone struct {
Requests int64
Responses Responses
Discarded int64
Received int64
Sent int64
}
// Resolver represents resolvers related stats.
type Resolver struct {
Requests ResolverRequests `json:"requests"`
Responses ResolverResponses `json:"responses"`
}
// ResolverRequests represents resolver requests.
type ResolverRequests struct {
Name int64
Srv int64
Addr int64
}
// ResolverResponses represents resolver responses.
type ResolverResponses struct {
Noerror int64
Formerr int64
Servfail int64
Nxdomain int64
Notimp int64
Refused int64
Timedout int64
Unknown int64
}
// Processes represents processes related stats.
type Processes struct {
Respawned int64
}
// HTTPLimitRequest represents HTTP Requests Rate Limiting.
type HTTPLimitRequest struct {
Passed uint64
Delayed uint64
Rejected uint64
DelayedDryRun uint64 `json:"delayed_dry_run"`
RejectedDryRun uint64 `json:"rejected_dry_run"`
}
// HTTPLimitRequests represents limit requests related stats.
type HTTPLimitRequests map[string]HTTPLimitRequest
// LimitConnection represents Connections Limiting.
type LimitConnection struct {
Passed uint64
Rejected uint64
RejectedDryRun uint64 `json:"rejected_dry_run"`
}
// HTTPLimitConnections represents limit connections related stats.
type HTTPLimitConnections map[string]LimitConnection
// StreamLimitConnections represents limit connections related stats.
type StreamLimitConnections map[string]LimitConnection
// Workers represents worker connections related stats.
type Workers struct {
ID int
ProcessID uint64 `json:"pid"`
HTTP WorkersHTTP `json:"http"`
Connections Connections
}
// WorkersHTTP represents HTTP worker connections.
type WorkersHTTP struct {
HTTPRequests HTTPRequests `json:"requests"`
}
// WithHTTPClient sets the HTTP client to use for accessing the API.
func WithHTTPClient(httpClient *http.Client) Option {
return func(o *NginxClient) {
o.httpClient = httpClient
}
}
// WithAPIVersion sets the API version to use for accessing the API.
func WithAPIVersion(apiVersion int) Option {
return func(o *NginxClient) {
o.apiVersion = apiVersion
}
}
// WithCheckAPI sets the flag to check the API version of the server.
func WithCheckAPI() Option {
return func(o *NginxClient) {
o.checkAPI = true
}
}
// WithMaxAPIVersion sets the API version to the max API version.
func WithMaxAPIVersion() Option {
return func(o *NginxClient) {
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
version, err := o.GetMaxAPIVersion(ctx)
if err != nil {
return
}
o.apiVersion = version
}
}
// NewNginxClient creates a new NginxClient.
func NewNginxClient(apiEndpoint string, opts ...Option) (*NginxClient, error) {
c := &NginxClient{
httpClient: http.DefaultClient,
apiEndpoint: apiEndpoint,
apiVersion: APIVersion,
checkAPI: false,
}
for _, opt := range opts {
opt(c)
}
if c.httpClient == nil {
return nil, fmt.Errorf("http client: %w", ErrParameterRequired)
}
if !versionSupported(c.apiVersion) {
return nil, fmt.Errorf("API version %v: %w by the client", c.apiVersion, ErrNotSupported)
}
if c.checkAPI {
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
versions, err := c.getAPIVersions(ctx, c.httpClient, apiEndpoint)
if err != nil {
return nil, fmt.Errorf("error accessing the API: %w", err)
}
found := false
for _, v := range *versions {
if v == c.apiVersion {
found = true
break
}
}
if !found {
return nil, fmt.Errorf("API version %v: %w by the server", c.apiVersion, ErrNotSupported)
}
}
return c, nil
}
func versionSupported(n int) bool {
for _, version := range supportedAPIVersions {
if n == version {
return true
}
}
return false
}
// GetMaxAPIVersion returns the maximum API version supported by the server and the client.
func (client *NginxClient) GetMaxAPIVersion(ctx context.Context) (int, error) {
serverVersions, err := client.getAPIVersions(ctx, client.httpClient, client.apiEndpoint)
if err != nil {
return 0, fmt.Errorf("failed to get max API version: %w", err)
}
maxServerVersion := slices.Max(*serverVersions)
maxClientVersion := slices.Max(supportedAPIVersions)
if maxServerVersion > maxClientVersion {
return maxClientVersion, nil
}
return maxServerVersion, nil
}
func (client *NginxClient) getAPIVersions(ctx context.Context, httpClient *http.Client, endpoint string) (*versions, error) {
req, err := http.NewRequestWithContext(ctx, http.MethodGet, endpoint, nil)
if err != nil {
return nil, fmt.Errorf("failed to create a get request: %w", err)
}
resp, err := httpClient.Do(req)
if err != nil {
return nil, fmt.Errorf("%v is not accessible: %w", endpoint, err)
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return nil, createResponseMismatchError(resp.Body).Wrap(fmt.Sprintf(
"failed to get endpoint %q, expected %v response, got %v",
endpoint, http.StatusOK, resp.StatusCode))
}
body, err := io.ReadAll(resp.Body)
if err != nil {
return nil, fmt.Errorf("error while reading body of the response: %w", err)
}
var vers versions
err = json.Unmarshal(body, &vers)
if err != nil {
return nil, fmt.Errorf("error unmarshalling versions, got %q response: %w", string(body), err)
}
return &vers, nil
}
func createResponseMismatchError(respBody io.ReadCloser) *internalError {
apiErrResp, err := readAPIErrorResponse(respBody)
if err != nil {
return &internalError{
err: fmt.Sprintf("failed to read the response body: %v", err),
}
}
return &internalError{
err: apiErrResp.toString(),
apiError: apiErrResp.Error,
}
}
func readAPIErrorResponse(respBody io.ReadCloser) (*apiErrorResponse, error) {
body, err := io.ReadAll(respBody)
if err != nil {
return nil, fmt.Errorf("failed to read the response body: %w", err)
}
var apiErr apiErrorResponse
err = json.Unmarshal(body, &apiErr)
if err != nil {
return nil, fmt.Errorf("error unmarshalling apiErrorResponse: got %q response: %w", string(body), err)
}
return &apiErr, nil
}
// CheckIfUpstreamExists checks if the upstream exists in NGINX. If the upstream doesn't exist, it returns the error.
func (client *NginxClient) CheckIfUpstreamExists(ctx context.Context, upstream string) error {
_, err := client.GetHTTPServers(ctx, upstream)
return err
}
// GetHTTPServers returns the servers of the upstream from NGINX.
func (client *NginxClient) GetHTTPServers(ctx context.Context, upstream string) ([]UpstreamServer, error) {
path := fmt.Sprintf("http/upstreams/%v/servers", upstream)
var servers []UpstreamServer
err := client.get(ctx, path, &servers)
if err != nil {
return nil, fmt.Errorf("failed to get the HTTP servers of upstream %v: %w", upstream, err)
}
return servers, nil
}
// AddHTTPServer adds the server to the upstream.
func (client *NginxClient) AddHTTPServer(ctx context.Context, upstream string, server UpstreamServer) error {
id, err := client.getIDOfHTTPServer(ctx, upstream, server.Server)
if err != nil {
return fmt.Errorf("failed to add %v server to %v upstream: %w", server.Server, upstream, err)
}
if id != -1 {
return fmt.Errorf("failed to add %v server to %v upstream: %w", server.Server, upstream, ErrServerExists)
}
err = client.addHTTPServer(ctx, upstream, server)
return err
}
func (client *NginxClient) addHTTPServer(ctx context.Context, upstream string, server UpstreamServer) error {
path := fmt.Sprintf("http/upstreams/%v/servers/", upstream)
err := client.post(ctx, path, &server)
if err != nil {
return fmt.Errorf("failed to add %v server to %v upstream: %w", server.Server, upstream, err)
}
return nil
}
// DeleteHTTPServer the server from the upstream.
func (client *NginxClient) DeleteHTTPServer(ctx context.Context, upstream string, server string) error {
id, err := client.getIDOfHTTPServer(ctx, upstream, server)
if err != nil {
return fmt.Errorf("failed to remove %v server from %v upstream: %w", server, upstream, err)
}
if id == -1 {
return fmt.Errorf("failed to remove %v server from %v upstream: %w", server, upstream, ErrServerNotFound)
}
err = client.deleteHTTPServer(ctx, upstream, server, id)
return err
}
func (client *NginxClient) deleteHTTPServer(ctx context.Context, upstream, server string, serverID int) error {
path := fmt.Sprintf("http/upstreams/%v/servers/%v", upstream, serverID)
err := client.delete(ctx, path, http.StatusOK)
if err != nil {
return fmt.Errorf("failed to remove %v server from %v upstream: %w", server, upstream, err)
}
return nil
}
// UpdateHTTPServers updates the servers of the upstream.
// Servers that are in the slice, but don't exist in NGINX will be added to NGINX.
// Servers that aren't in the slice, but exist in NGINX, will be removed from NGINX.
// Servers that are in the slice and exist in NGINX, but have different parameters, will be updated.
// The client will attempt to update all servers, returning all the errors that occurred.
// If there are duplicate servers with equivalent parameters, the duplicates will be ignored.
// If there are duplicate servers with different parameters, those server entries will be ignored and an error returned.
func (client *NginxClient) UpdateHTTPServers(ctx context.Context, upstream string, servers []UpstreamServer) (added []UpstreamServer, deleted []UpstreamServer, updated []UpstreamServer, err error) {
serversInNginx, err := client.GetHTTPServers(ctx, upstream)
if err != nil {
return nil, nil, nil, fmt.Errorf("failed to update servers of %v upstream: %w", upstream, err)
}
// We assume port 80 if no port is set for servers.
formattedServers := make([]UpstreamServer, 0, len(servers))
for _, server := range servers {
server.Server = addPortToServer(server.Server)
formattedServers = append(formattedServers, server)
}
formattedServers, err = deduplicateServers(upstream, formattedServers)
toAdd, toDelete, toUpdate := determineUpdates(formattedServers, serversInNginx)
for _, server := range toAdd {
addErr := client.addHTTPServer(ctx, upstream, server)
if addErr != nil {
err = errors.Join(err, addErr)
continue
}
added = append(added, server)
}
for _, server := range toDelete {
deleteErr := client.deleteHTTPServer(ctx, upstream, server.Server, server.ID)
if deleteErr != nil {
err = errors.Join(err, deleteErr)
continue
}
deleted = append(deleted, server)
}
for _, server := range toUpdate {
updateErr := client.UpdateHTTPServer(ctx, upstream, server)
if updateErr != nil {
err = errors.Join(err, updateErr)
continue
}
updated = append(updated, server)
}
if err != nil {
err = fmt.Errorf("failed to update servers of %s upstream: %w", upstream, err)
}
return added, deleted, updated, err
}
func deduplicateServers(upstream string, servers []UpstreamServer) ([]UpstreamServer, error) {
type serverCheck struct {
server UpstreamServer
valid bool
}
serverMap := make(map[string]*serverCheck, len(servers))
var err error
for _, server := range servers {
if prev, ok := serverMap[server.Server]; ok {
if !prev.valid {
continue
}
if !server.hasSameParametersAs(prev.server) {
prev.valid = false
err = errors.Join(err, fmt.Errorf(
"failed to update %s server to %s upstream: %w",
server.Server, upstream, ErrParameterMismatch))
}
continue
}
serverMap[server.Server] = &serverCheck{server, true}
}
retServers := make([]UpstreamServer, 0, len(serverMap))
for _, server := range servers {
if check, ok := serverMap[server.Server]; ok && check.valid {
retServers = append(retServers, server)
delete(serverMap, server.Server)
}
}
return retServers, err
}
// hasSameParametersAs checks if a given server has the same parameters.
func (s UpstreamServer) hasSameParametersAs(compareServer UpstreamServer) bool {
s.ID = compareServer.ID
s.applyDefaults()
compareServer.applyDefaults()
return reflect.DeepEqual(s, compareServer)
}
func (s *UpstreamServer) applyDefaults() {
if s.MaxConns == nil {
s.MaxConns = &defaultMaxConns
}
if s.MaxFails == nil {
s.MaxFails = &defaultMaxFails
}
if s.FailTimeout == "" {
s.FailTimeout = defaultFailTimeout
}
if s.SlowStart == "" {
s.SlowStart = defaultSlowStart
}
if s.Backup == nil {
s.Backup = &defaultBackup
}
if s.Down == nil {
s.Down = &defaultDown
}
if s.Weight == nil {
s.Weight = &defaultWeight
}
}
func determineUpdates(updatedServers []UpstreamServer, nginxServers []UpstreamServer) (toAdd []UpstreamServer, toRemove []UpstreamServer, toUpdate []UpstreamServer) {
for _, server := range updatedServers {
updateFound := false
for _, serverNGX := range nginxServers {
if server.Server == serverNGX.Server && !server.hasSameParametersAs(serverNGX) {
server.ID = serverNGX.ID
updateFound = true
break
}
}
if updateFound {
toUpdate = append(toUpdate, server)
}
}
for _, server := range updatedServers {
found := false
for _, serverNGX := range nginxServers {
if server.Server == serverNGX.Server {
found = true
break
}
}
if !found {
toAdd = append(toAdd, server)
}
}
for _, serverNGX := range nginxServers {
found := false
for _, server := range updatedServers {
if serverNGX.Server == server.Server {
found = true
break
}
}
if !found {
toRemove = append(toRemove, serverNGX)
}
}
return
}
func (client *NginxClient) getIDOfHTTPServer(ctx context.Context, upstream string, name string) (int, error) {
servers, err := client.GetHTTPServers(ctx, upstream)
if err != nil {
return -1, fmt.Errorf("error getting id of server %v of upstream %v: %w", name, upstream, err)
}
for _, s := range servers {
if s.Server == name {
return s.ID, nil
}
}
return -1, nil
}
func (client *NginxClient) get(ctx context.Context, path string, data interface{}) error {
url := fmt.Sprintf("%v/%v/%v", client.apiEndpoint, client.apiVersion, path)
req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
if err != nil {
return fmt.Errorf("failed to create a get request: %w", err)
}
resp, err := client.httpClient.Do(req)
if err != nil {
return fmt.Errorf("failed to get %v: %w", path, err)
}
if resp.StatusCode != http.StatusOK {
return createResponseMismatchError(resp.Body).Wrap(fmt.Sprintf(
"expected %v response, got %v",
http.StatusOK, resp.StatusCode))
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
return fmt.Errorf("failed to read the response body: %w", err)
}
err = json.Unmarshal(body, data)
if err != nil {
return fmt.Errorf("error unmarshaling response %q: %w", string(body), err)
}
return nil
}
func (client *NginxClient) post(ctx context.Context, path string, input interface{}) error {
url := fmt.Sprintf("%v/%v/%v", client.apiEndpoint, client.apiVersion, path)
jsonInput, err := json.Marshal(input)
if err != nil {
return fmt.Errorf("failed to marshall input: %w", err)
}
req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, bytes.NewBuffer(jsonInput))
if err != nil {
return fmt.Errorf("failed to create a post request: %w", err)
}
req.Header.Set("Content-Type", "application/json")
resp, err := client.httpClient.Do(req)
if err != nil {
return fmt.Errorf("failed to post %v: %w", path, err)
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusCreated {
return createResponseMismatchError(resp.Body).Wrap(fmt.Sprintf(
"expected %v response, got %v",
http.StatusCreated, resp.StatusCode))
}
return nil
}
func (client *NginxClient) delete(ctx context.Context, path string, expectedStatusCode int) error {
path = fmt.Sprintf("%v/%v/%v/", client.apiEndpoint, client.apiVersion, path)
req, err := http.NewRequestWithContext(ctx, http.MethodDelete, path, nil)
if err != nil {
return fmt.Errorf("failed to create a delete request: %w", err)
}
resp, err := client.httpClient.Do(req)
if err != nil {
return fmt.Errorf("failed to create delete request: %w", err)
}
defer resp.Body.Close()
if resp.StatusCode != expectedStatusCode {
return createResponseMismatchError(resp.Body).Wrap(fmt.Sprintf(
"failed to complete delete request: expected %v response, got %v",
expectedStatusCode, resp.StatusCode))
}
return nil
}
func (client *NginxClient) patch(ctx context.Context, path string, input interface{}, expectedStatusCode int) error {
path = fmt.Sprintf("%v/%v/%v/", client.apiEndpoint, client.apiVersion, path)
jsonInput, err := json.Marshal(input)
if err != nil {
return fmt.Errorf("failed to marshall input: %w", err)
}
req, err := http.NewRequestWithContext(ctx, http.MethodPatch, path, bytes.NewBuffer(jsonInput))
if err != nil {
return fmt.Errorf("failed to create a patch request: %w", err)
}
req.Header.Set("Content-Type", "application/json")
resp, err := client.httpClient.Do(req)
if err != nil {
return fmt.Errorf("failed to create patch request: %w", err)
}
defer resp.Body.Close()
if resp.StatusCode != expectedStatusCode {
return createResponseMismatchError(resp.Body).Wrap(fmt.Sprintf(
"failed to complete patch request: expected %v response, got %v",
expectedStatusCode, resp.StatusCode))
}
return nil
}
// CheckIfStreamUpstreamExists checks if the stream upstream exists in NGINX. If the upstream doesn't exist, it returns the error.
func (client *NginxClient) CheckIfStreamUpstreamExists(ctx context.Context, upstream string) error {
_, err := client.GetStreamServers(ctx, upstream)
return err
}
// GetStreamServers returns the stream servers of the upstream from NGINX.
func (client *NginxClient) GetStreamServers(ctx context.Context, upstream string) ([]StreamUpstreamServer, error) {
path := fmt.Sprintf("stream/upstreams/%v/servers", upstream)
var servers []StreamUpstreamServer
err := client.get(ctx, path, &servers)
if err != nil {
return nil, fmt.Errorf("failed to get stream servers of upstream server %v: %w", upstream, err)
}
return servers, nil
}
// AddStreamServer adds the stream server to the upstream.
func (client *NginxClient) AddStreamServer(ctx context.Context, upstream string, server StreamUpstreamServer) error {
id, err := client.getIDOfStreamServer(ctx, upstream, server.Server)
if err != nil {
return fmt.Errorf("failed to add %v stream server to %v upstream: %w", server.Server, upstream, err)
}
if id != -1 {
return fmt.Errorf("failed to add %v stream server to %v upstream: %w", server.Server, upstream, ErrServerExists)
}
err = client.addStreamServer(ctx, upstream, server)
return err
}
func (client *NginxClient) addStreamServer(ctx context.Context, upstream string, server StreamUpstreamServer) error {
path := fmt.Sprintf("stream/upstreams/%v/servers/", upstream)
err := client.post(ctx, path, &server)
if err != nil {
return fmt.Errorf("failed to add %v stream server to %v upstream: %w", server.Server, upstream, err)
}
return nil
}
// DeleteStreamServer the server from the upstream.
func (client *NginxClient) DeleteStreamServer(ctx context.Context, upstream string, server string) error {
id, err := client.getIDOfStreamServer(ctx, upstream, server)
if err != nil {
return fmt.Errorf("failed to remove %v stream server from %v upstream: %w", server, upstream, err)
}
if id == -1 {
return fmt.Errorf("failed to remove %v stream server from %v upstream: %w", server, upstream, ErrServerNotFound)
}
err = client.deleteStreamServer(ctx, upstream, server, id)
return err
}
func (client *NginxClient) deleteStreamServer(ctx context.Context, upstream, server string, serverID int) error {
path := fmt.Sprintf("stream/upstreams/%v/servers/%v", upstream, serverID)
err := client.delete(ctx, path, http.StatusOK)
if err != nil {
return fmt.Errorf("failed to remove %v stream server from %v upstream: %w", server, upstream, err)
}
return nil
}
// UpdateStreamServers updates the servers of the upstream.
// Servers that are in the slice, but don't exist in NGINX will be added to NGINX.
// Servers that aren't in the slice, but exist in NGINX, will be removed from NGINX.
// Servers that are in the slice and exist in NGINX, but have different parameters, will be updated.
// The client will attempt to update all servers, returning all the errors that occurred.
// If there are duplicate servers with equivalent parameters, the duplicates will be ignored.
// If there are duplicate servers with different parameters, those server entries will be ignored and an error returned.
func (client *NginxClient) UpdateStreamServers(ctx context.Context, upstream string, servers []StreamUpstreamServer) (added []StreamUpstreamServer, deleted []StreamUpstreamServer, updated []StreamUpstreamServer, err error) {
serversInNginx, err := client.GetStreamServers(ctx, upstream)
if err != nil {
return nil, nil, nil, fmt.Errorf("failed to update stream servers of %v upstream: %w", upstream, err)
}
formattedServers := make([]StreamUpstreamServer, 0, len(servers))
for _, server := range servers {
server.Server = addPortToServer(server.Server)
formattedServers = append(formattedServers, server)
}
formattedServers, err = deduplicateStreamServers(upstream, formattedServers)
toAdd, toDelete, toUpdate := determineStreamUpdates(formattedServers, serversInNginx)
for _, server := range toAdd {
addErr := client.addStreamServer(ctx, upstream, server)
if addErr != nil {
err = errors.Join(err, addErr)
continue
}
added = append(added, server)
}
for _, server := range toDelete {
deleteErr := client.deleteStreamServer(ctx, upstream, server.Server, server.ID)
if deleteErr != nil {
err = errors.Join(err, deleteErr)
continue
}
deleted = append(deleted, server)
}
for _, server := range toUpdate {
updateErr := client.UpdateStreamServer(ctx, upstream, server)
if updateErr != nil {
err = errors.Join(err, updateErr)
continue
}
updated = append(updated, server)
}
if err != nil {
err = fmt.Errorf("failed to update stream servers of %s upstream: %w", upstream, err)
}
return added, deleted, updated, err
}
func (client *NginxClient) getIDOfStreamServer(ctx context.Context, upstream string, name string) (int, error) {
servers, err := client.GetStreamServers(ctx, upstream)
if err != nil {
return -1, fmt.Errorf("error getting id of stream server %v of upstream %v: %w", name, upstream, err)
}
for _, s := range servers {
if s.Server == name {
return s.ID, nil
}
}
return -1, nil
}
func deduplicateStreamServers(upstream string, servers []StreamUpstreamServer) ([]StreamUpstreamServer, error) {
type serverCheck struct {
server StreamUpstreamServer
valid bool
}
serverMap := make(map[string]*serverCheck, len(servers))
var err error
for _, server := range servers {
if prev, ok := serverMap[server.Server]; ok {
if !prev.valid {
continue
}
if !server.hasSameParametersAs(prev.server) {
prev.valid = false
err = errors.Join(err, fmt.Errorf(
"failed to update stream %s server to %s upstream: %w",
server.Server, upstream, ErrParameterMismatch))
}
continue
}
serverMap[server.Server] = &serverCheck{server, true}
}
retServers := make([]StreamUpstreamServer, 0, len(serverMap))
for _, server := range servers {
if check, ok := serverMap[server.Server]; ok && check.valid {
retServers = append(retServers, server)
delete(serverMap, server.Server)
}
}
return retServers, err
}
// hasSameParametersAs checks if a given server has the same parameters.
func (s StreamUpstreamServer) hasSameParametersAs(compareServer StreamUpstreamServer) bool {
s.ID = compareServer.ID
s.applyDefaults()
compareServer.applyDefaults()
return reflect.DeepEqual(s, compareServer)
}
func (s *StreamUpstreamServer) applyDefaults() {
if s.MaxConns == nil {
s.MaxConns = &defaultMaxConns
}
if s.MaxFails == nil {
s.MaxFails = &defaultMaxFails
}
if s.FailTimeout == "" {
s.FailTimeout = defaultFailTimeout
}
if s.SlowStart == "" {
s.SlowStart = defaultSlowStart
}
if s.Backup == nil {
s.Backup = &defaultBackup
}
if s.Down == nil {
s.Down = &defaultDown
}
if s.Weight == nil {
s.Weight = &defaultWeight
}
}
func determineStreamUpdates(updatedServers []StreamUpstreamServer, nginxServers []StreamUpstreamServer) (toAdd []StreamUpstreamServer, toRemove []StreamUpstreamServer, toUpdate []StreamUpstreamServer) {
for _, server := range updatedServers {
updateFound := false
for _, serverNGX := range nginxServers {
if server.Server == serverNGX.Server && !server.hasSameParametersAs(serverNGX) {
server.ID = serverNGX.ID
updateFound = true
break
}
}
if updateFound {
toUpdate = append(toUpdate, server)
}
}
for _, server := range updatedServers {
found := false
for _, serverNGX := range nginxServers {
if server.Server == serverNGX.Server {
found = true
break
}
}
if !found {
toAdd = append(toAdd, server)
}
}
for _, serverNGX := range nginxServers {
found := false
for _, server := range updatedServers {
if serverNGX.Server == server.Server {
found = true
break
}
}
if !found {
toRemove = append(toRemove, serverNGX)
}
}
return
}
// GetStats gets process, slab, connection, request, ssl, zone, stream zone, upstream and stream upstream related stats from the NGINX Plus API.
func (client *NginxClient) GetStats(ctx context.Context) (*Stats, error) {
initialGroup, initialCtx := errgroup.WithContext(ctx)
var mu sync.Mutex
stats := defaultStats()
// Collecting initial stats
initialGroup.Go(func() error {
endpoints, err := client.GetAvailableEndpoints(initialCtx)
if err != nil {
return fmt.Errorf("failed to get available Endpoints: %w", err)
}
mu.Lock()
stats.endpoints = endpoints
mu.Unlock()
return nil
})
initialGroup.Go(func() error {
nginxInfo, err := client.GetNginxInfo(initialCtx)
if err != nil {
return fmt.Errorf("failed to get NGINX info: %w", err)
}
mu.Lock()
stats.NginxInfo = *nginxInfo
mu.Unlock()
return nil
})
initialGroup.Go(func() error {
caches, err := client.GetCaches(initialCtx)
if err != nil {
return fmt.Errorf("failed to get Caches: %w", err)
}
mu.Lock()
stats.Caches = *caches
mu.Unlock()
return nil
})
initialGroup.Go(func() error {
processes, err := client.GetProcesses(initialCtx)
if err != nil {
return fmt.Errorf("failed to get Process information: %w", err)
}
mu.Lock()
stats.Processes = *processes
mu.Unlock()
return nil
})
initialGroup.Go(func() error {
slabs, err := client.GetSlabs(initialCtx)
if err != nil {
return fmt.Errorf("failed to get Slabs: %w", err)
}
mu.Lock()
stats.Slabs = *slabs
mu.Unlock()
return nil
})
initialGroup.Go(func() error {
httpRequests, err := client.GetHTTPRequests(initialCtx)
if err != nil {
return fmt.Errorf("failed to get HTTP Requests: %w", err)
}
mu.Lock()
stats.HTTPRequests = *httpRequests
mu.Unlock()
return nil
})
initialGroup.Go(func() error {
ssl, err := client.GetSSL(initialCtx)
if err != nil {
return fmt.Errorf("failed to get SSL: %w", err)
}
mu.Lock()
stats.SSL = *ssl
mu.Unlock()
return nil
})
initialGroup.Go(func() error {
serverZones, err := client.GetServerZones(initialCtx)
if err != nil {
return fmt.Errorf("failed to get Server Zones: %w", err)
}
mu.Lock()
stats.ServerZones = *serverZones
mu.Unlock()
return nil
})
initialGroup.Go(func() error {
upstreams, err := client.GetUpstreams(initialCtx)
if err != nil {
return fmt.Errorf("failed to get Upstreams: %w", err)
}
mu.Lock()
stats.Upstreams = *upstreams
mu.Unlock()
return nil
})
initialGroup.Go(func() error {
locationZones, err := client.GetLocationZones(initialCtx)
if err != nil {
return fmt.Errorf("failed to get Location Zones: %w", err)
}
mu.Lock()
stats.LocationZones = *locationZones
mu.Unlock()
return nil
})
initialGroup.Go(func() error {
resolvers, err := client.GetResolvers(initialCtx)
if err != nil {
return fmt.Errorf("failed to get Resolvers: %w", err)
}
mu.Lock()
stats.Resolvers = *resolvers
mu.Unlock()
return nil
})
initialGroup.Go(func() error {
httpLimitRequests, err := client.GetHTTPLimitReqs(initialCtx)
if err != nil {
return fmt.Errorf("failed to get HTTPLimitRequests: %w", err)
}
mu.Lock()
stats.HTTPLimitRequests = *httpLimitRequests
mu.Unlock()
return nil
})
initialGroup.Go(func() error {
httpLimitConnections, err := client.GetHTTPConnectionsLimit(initialCtx)
if err != nil {
return fmt.Errorf("failed to get HTTPLimitConnections: %w", err)
}
mu.Lock()
stats.HTTPLimitConnections = *httpLimitConnections
mu.Unlock()
return nil
})
initialGroup.Go(func() error {
workers, err := client.GetWorkers(initialCtx)
if err != nil {
return fmt.Errorf("failed to get Workers: %w", err)
}
mu.Lock()
stats.Workers = workers
mu.Unlock()
return nil
})
if err := initialGroup.Wait(); err != nil {
return nil, fmt.Errorf("error returned from contacting Plus API: %w", err)
}
// Process stream endpoints if they exist
if slices.Contains(stats.endpoints, "stream") {
availableStreamGroup, asgCtx := errgroup.WithContext(ctx)
availableStreamGroup.Go(func() error {
streamEndpoints, err := client.GetAvailableStreamEndpoints(asgCtx)
if err != nil {
return fmt.Errorf("failed to get available Stream Endpoints: %w", err)
}
mu.Lock()
stats.streamEndpoints = streamEndpoints
mu.Unlock()
return nil
})
if err := availableStreamGroup.Wait(); err != nil {
return nil, fmt.Errorf("no useful metrics found in stream stats: %w", err)
}
streamGroup, sgCtx := errgroup.WithContext(ctx)
if slices.Contains(stats.streamEndpoints, "server_zones") {
streamGroup.Go(func() error {
streamServerZones, err := client.GetStreamServerZones(sgCtx)
if err != nil {
return fmt.Errorf("failed to get streamServerZones: %w", err)
}
mu.Lock()
stats.StreamServerZones = *streamServerZones
mu.Unlock()
return nil
})
}
if slices.Contains(stats.streamEndpoints, "upstreams") {
streamGroup.Go(func() error {
streamUpstreams, err := client.GetStreamUpstreams(sgCtx)
if err != nil {
return fmt.Errorf("failed to get StreamUpstreams: %w", err)
}
mu.Lock()
stats.StreamUpstreams = *streamUpstreams
mu.Unlock()
return nil
})
}
if slices.Contains(stats.streamEndpoints, "limit_conns") {
streamGroup.Go(func() error {
streamConnectionsLimit, err := client.GetStreamConnectionsLimit(sgCtx)
if err != nil {
return fmt.Errorf("failed to get StreamLimitConnections: %w", err)
}
mu.Lock()
stats.StreamLimitConnections = *streamConnectionsLimit
mu.Unlock()
return nil
})
streamGroup.Go(func() error {
streamZoneSync, err := client.GetStreamZoneSync(sgCtx)
if err != nil {
return fmt.Errorf("failed to get StreamZoneSync: %w", err)
}
mu.Lock()
stats.StreamZoneSync = streamZoneSync
mu.Unlock()
return nil
})
}
if err := streamGroup.Wait(); err != nil {
return nil, fmt.Errorf("no useful metrics found in stream stats: %w", err)
}
}
// Report connection metrics separately so it does not influence the results
connectionsGroup, cgCtx := errgroup.WithContext(ctx)
connectionsGroup.Go(func() error {
// replace this call with a context specific call
connections, err := client.GetConnections(cgCtx)
if err != nil {
return fmt.Errorf("failed to get connections: %w", err)
}
mu.Lock()
stats.Connections = *connections
mu.Unlock()
return nil
})
if err := connectionsGroup.Wait(); err != nil {
return nil, fmt.Errorf("connections metrics not found: %w", err)
}
return &stats.Stats, nil
}
// GetAvailableEndpoints returns available endpoints in the API.
func (client *NginxClient) GetAvailableEndpoints(ctx context.Context) ([]string, error) {
var endpoints []string
err := client.get(ctx, "", &endpoints)
if err != nil {
return nil, fmt.Errorf("failed to get endpoints: %w", err)
}
return endpoints, nil
}
// GetAvailableStreamEndpoints returns available stream endpoints in the API with a context.
func (client *NginxClient) GetAvailableStreamEndpoints(ctx context.Context) ([]string, error) {
var endpoints []string
err := client.get(ctx, "stream", &endpoints)
if err != nil {
return nil, fmt.Errorf("failed to get endpoints: %w", err)
}
return endpoints, nil
}
// GetNginxInfo returns Nginx stats with a context.
func (client *NginxClient) GetNginxInfo(ctx context.Context) (*NginxInfo, error) {
var info NginxInfo
err := client.get(ctx, "nginx", &info)
if err != nil {
return nil, fmt.Errorf("failed to get info: %w", err)
}
return &info, nil
}
// GetNginxLicense returns Nginx License data with a context.
func (client *NginxClient) GetNginxLicense(ctx context.Context) (*NginxLicense, error) {
var data NginxLicense
info, err := client.GetNginxInfo(ctx)
if err != nil {
return nil, fmt.Errorf("failed to get nginx info: %w", err)
}
release, err := extractPlusVersionValues(info.Build)
if err != nil {
return nil, fmt.Errorf("failed to get nginx plus release: %w", err)
}
if (client.apiVersion < 9) || (release < 33) {
return &data, nil
}
err = client.get(ctx, "license", &data)
if err != nil {
return nil, fmt.Errorf("failed to get license: %w", err)
}
return &data, nil
}
// GetCaches returns Cache stats with a context.
func (client *NginxClient) GetCaches(ctx context.Context) (*Caches, error) {
var caches Caches
err := client.get(ctx, "http/caches", &caches)
if err != nil {
return nil, fmt.Errorf("failed to get caches: %w", err)
}
return &caches, nil
}
// GetSlabs returns Slabs stats with a context.
func (client *NginxClient) GetSlabs(ctx context.Context) (*Slabs, error) {
var slabs Slabs
err := client.get(ctx, "slabs", &slabs)
if err != nil {
return nil, fmt.Errorf("failed to get slabs: %w", err)
}
return &slabs, nil
}
// GetConnections returns Connections stats with a context.
func (client *NginxClient) GetConnections(ctx context.Context) (*Connections, error) {
var cons Connections
err := client.get(ctx, "connections", &cons)
if err != nil {
return nil, fmt.Errorf("failed to get connections: %w", err)
}
return &cons, nil
}
// GetHTTPRequests returns http/requests stats with a context.
func (client *NginxClient) GetHTTPRequests(ctx context.Context) (*HTTPRequests, error) {
var requests HTTPRequests
err := client.get(ctx, "http/requests", &requests)
if err != nil {
return nil, fmt.Errorf("failed to get http requests: %w", err)
}
return &requests, nil
}
// GetSSL returns SSL stats with a context.
func (client *NginxClient) GetSSL(ctx context.Context) (*SSL, error) {
var ssl SSL
err := client.get(ctx, "ssl", &ssl)
if err != nil {
return nil, fmt.Errorf("failed to get ssl: %w", err)
}
return &ssl, nil
}
// GetServerZones returns http/server_zones stats with a context.
func (client *NginxClient) GetServerZones(ctx context.Context) (*ServerZones, error) {
var zones ServerZones
err := client.get(ctx, "http/server_zones", &zones)
if err != nil {
return nil, fmt.Errorf("failed to get server zones: %w", err)
}
return &zones, err
}
// GetStreamServerZones returns stream/server_zones stats with a context.
func (client *NginxClient) GetStreamServerZones(ctx context.Context) (*StreamServerZones, error) {
var zones StreamServerZones
err := client.get(ctx, "stream/server_zones", &zones)
if err != nil {
var ie *internalError
if errors.As(err, &ie) {
if ie.Code() == pathNotFoundCode {
return &zones, nil
}
}
return nil, fmt.Errorf("failed to get stream server zones: %w", err)
}
return &zones, err
}
// GetUpstreams returns http/upstreams stats with a context.
func (client *NginxClient) GetUpstreams(ctx context.Context) (*Upstreams, error) {
var upstreams Upstreams
err := client.get(ctx, "http/upstreams", &upstreams)
if err != nil {
return nil, fmt.Errorf("failed to get upstreams: %w", err)
}
return &upstreams, nil
}
// GetStreamUpstreams returns stream/upstreams stats with a context.
func (client *NginxClient) GetStreamUpstreams(ctx context.Context) (*StreamUpstreams, error) {
var upstreams StreamUpstreams
err := client.get(ctx, "stream/upstreams", &upstreams)
if err != nil {
var ie *internalError
if errors.As(err, &ie) {
if ie.Code() == pathNotFoundCode {
return &upstreams, nil
}
}
return nil, fmt.Errorf("failed to get stream upstreams: %w", err)
}
return &upstreams, nil
}
// GetStreamZoneSync returns stream/zone_sync stats with a context.
func (client *NginxClient) GetStreamZoneSync(ctx context.Context) (*StreamZoneSync, error) {
var streamZoneSync StreamZoneSync
err := client.get(ctx, "stream/zone_sync", &streamZoneSync)
if err != nil {
var ie *internalError
if errors.As(err, &ie) {
if ie.Code() == pathNotFoundCode {
return nil, nil
}
}
return nil, fmt.Errorf("failed to get stream zone sync: %w", err)
}
return &streamZoneSync, err
}
// GetLocationZones returns http/location_zones stats with a context.
func (client *NginxClient) GetLocationZones(ctx context.Context) (*LocationZones, error) {
var locationZones LocationZones
if client.apiVersion < 5 {
return &locationZones, nil
}
err := client.get(ctx, "http/location_zones", &locationZones)
if err != nil {
return nil, fmt.Errorf("failed to get location zones: %w", err)
}
return &locationZones, err
}
// GetResolvers returns Resolvers stats with a context.
func (client *NginxClient) GetResolvers(ctx context.Context) (*Resolvers, error) {
var resolvers Resolvers
if client.apiVersion < 5 {
return &resolvers, nil
}
err := client.get(ctx, "resolvers", &resolvers)
if err != nil {
return nil, fmt.Errorf("failed to get resolvers: %w", err)
}
return &resolvers, err
}
// GetProcesses returns Processes stats with a context.
func (client *NginxClient) GetProcesses(ctx context.Context) (*Processes, error) {
var processes Processes
err := client.get(ctx, "processes", &processes)
if err != nil {
return nil, fmt.Errorf("failed to get processes: %w", err)
}
return &processes, err
}
// KeyValPairs are the key-value pairs stored in a zone.
type KeyValPairs map[string]string
// KeyValPairsByZone are the KeyValPairs for all zones, by zone name.
type KeyValPairsByZone map[string]KeyValPairs
// GetKeyValPairs fetches key/value pairs for a given HTTP zone.
func (client *NginxClient) GetKeyValPairs(ctx context.Context, zone string) (KeyValPairs, error) {
return client.getKeyValPairs(ctx, zone, httpContext)
}
// GetStreamKeyValPairs fetches key/value pairs for a given Stream zone.
func (client *NginxClient) GetStreamKeyValPairs(ctx context.Context, zone string) (KeyValPairs, error) {
return client.getKeyValPairs(ctx, zone, streamContext)
}
func (client *NginxClient) getKeyValPairs(ctx context.Context, zone string, stream bool) (KeyValPairs, error) {
base := "http"
if stream {
base = "stream"
}
if zone == "" {
return nil, fmt.Errorf("zone: %w", ErrParameterRequired)
}
path := fmt.Sprintf("%v/keyvals/%v", base, zone)
var keyValPairs KeyValPairs
err := client.get(ctx, path, &keyValPairs)
if err != nil {
return nil, fmt.Errorf("failed to get keyvals for %v/%v zone: %w", base, zone, err)
}
return keyValPairs, nil
}
// GetAllKeyValPairs fetches all key/value pairs for all HTTP zones.
func (client *NginxClient) GetAllKeyValPairs(ctx context.Context) (KeyValPairsByZone, error) {
return client.getAllKeyValPairs(ctx, httpContext)
}
// GetAllStreamKeyValPairs fetches all key/value pairs for all Stream zones.
func (client *NginxClient) GetAllStreamKeyValPairs(ctx context.Context) (KeyValPairsByZone, error) {
return client.getAllKeyValPairs(ctx, streamContext)
}
func (client *NginxClient) getAllKeyValPairs(ctx context.Context, stream bool) (KeyValPairsByZone, error) {
base := "http"
if stream {
base = "stream"
}
path := fmt.Sprintf("%v/keyvals", base)
var keyValPairsByZone KeyValPairsByZone
err := client.get(ctx, path, &keyValPairsByZone)
if err != nil {
return nil, fmt.Errorf("failed to get keyvals for all %v zones: %w", base, err)
}
return keyValPairsByZone, nil
}
// AddKeyValPair adds a new key/value pair to a given HTTP zone.
func (client *NginxClient) AddKeyValPair(ctx context.Context, zone string, key string, val string) error {
return client.addKeyValPair(ctx, zone, key, val, httpContext)
}
// AddStreamKeyValPair adds a new key/value pair to a given Stream zone.
func (client *NginxClient) AddStreamKeyValPair(ctx context.Context, zone string, key string, val string) error {
return client.addKeyValPair(ctx, zone, key, val, streamContext)
}
func (client *NginxClient) addKeyValPair(ctx context.Context, zone string, key string, val string, stream bool) error {
base := "http"
if stream {
base = "stream"
}
if zone == "" {
return fmt.Errorf("zone: %w", ErrParameterRequired)
}
path := fmt.Sprintf("%v/keyvals/%v", base, zone)
input := KeyValPairs{key: val}
err := client.post(ctx, path, &input)
if err != nil {
return fmt.Errorf("failed to add key value pair for %v/%v zone: %w", base, zone, err)
}
return nil
}
// ModifyKeyValPair modifies the value of an existing key in a given HTTP zone.
func (client *NginxClient) ModifyKeyValPair(ctx context.Context, zone string, key string, val string) error {
return client.modifyKeyValPair(ctx, zone, key, val, httpContext)
}
// ModifyStreamKeyValPair modifies the value of an existing key in a given Stream zone.
func (client *NginxClient) ModifyStreamKeyValPair(ctx context.Context, zone string, key string, val string) error {
return client.modifyKeyValPair(ctx, zone, key, val, streamContext)
}
func (client *NginxClient) modifyKeyValPair(ctx context.Context, zone string, key string, val string, stream bool) error {
base := "http"
if stream {
base = "stream"
}
if zone == "" {
return fmt.Errorf("zone: %w", ErrParameterRequired)
}
path := fmt.Sprintf("%v/keyvals/%v", base, zone)
input := KeyValPairs{key: val}
err := client.patch(ctx, path, &input, http.StatusNoContent)
if err != nil {
return fmt.Errorf("failed to update key value pair for %v/%v zone: %w", base, zone, err)
}
return nil
}
// DeleteKeyValuePair deletes the key/value pair for a key in a given HTTP zone.
func (client *NginxClient) DeleteKeyValuePair(ctx context.Context, zone string, key string) error {
return client.deleteKeyValuePair(ctx, zone, key, httpContext)
}
// DeleteStreamKeyValuePair deletes the key/value pair for a key in a given Stream zone.
func (client *NginxClient) DeleteStreamKeyValuePair(ctx context.Context, zone string, key string) error {
return client.deleteKeyValuePair(ctx, zone, key, streamContext)
}
// To delete a key/value pair you set the value to null via the API,
// then NGINX+ will delete the key.
func (client *NginxClient) deleteKeyValuePair(ctx context.Context, zone string, key string, stream bool) error {
base := "http"
if stream {
base = "stream"
}
if zone == "" {
return fmt.Errorf("zone: %w", ErrParameterRequired)
}
// map[string]string can't have a nil value so we use a different type here.
keyval := make(map[string]interface{})
keyval[key] = nil
path := fmt.Sprintf("%v/keyvals/%v", base, zone)
err := client.patch(ctx, path, &keyval, http.StatusNoContent)
if err != nil {
return fmt.Errorf("failed to remove key values pair for %v/%v zone: %w", base, zone, err)
}
return nil
}
// DeleteKeyValPairs deletes all the key-value pairs in a given HTTP zone.
func (client *NginxClient) DeleteKeyValPairs(ctx context.Context, zone string) error {
return client.deleteKeyValPairs(ctx, zone, httpContext)
}
// DeleteStreamKeyValPairs deletes all the key-value pairs in a given Stream zone.
func (client *NginxClient) DeleteStreamKeyValPairs(ctx context.Context, zone string) error {
return client.deleteKeyValPairs(ctx, zone, streamContext)
}
func (client *NginxClient) deleteKeyValPairs(ctx context.Context, zone string, stream bool) error {
base := "http"
if stream {
base = "stream"
}
if zone == "" {
return fmt.Errorf("zone: %w", ErrParameterRequired)
}
path := fmt.Sprintf("%v/keyvals/%v", base, zone)
err := client.delete(ctx, path, http.StatusNoContent)
if err != nil {
return fmt.Errorf("failed to remove all key value pairs for %v/%v zone: %w", base, zone, err)
}
return nil
}
// UpdateHTTPServer updates the server of the upstream with the matching server ID.
func (client *NginxClient) UpdateHTTPServer(ctx context.Context, upstream string, server UpstreamServer) error {
path := fmt.Sprintf("http/upstreams/%v/servers/%v", upstream, server.ID)
// The server ID is expected in the URI, but not expected in the body.
// The NGINX API will return
// {"error":{"status":400,"text":"unknown parameter \"id\"","code":"UpstreamConfFormatError"}
// if the ID field is present.
server.ID = 0
err := client.patch(ctx, path, &server, http.StatusOK)
if err != nil {
return fmt.Errorf("failed to update %v server to %v upstream: %w", server.Server, upstream, err)
}
return nil
}
// UpdateStreamServer updates the stream server of the upstream with the matching server ID.
func (client *NginxClient) UpdateStreamServer(ctx context.Context, upstream string, server StreamUpstreamServer) error {
path := fmt.Sprintf("stream/upstreams/%v/servers/%v", upstream, server.ID)
// The server ID is expected in the URI, but not expected in the body.
// The NGINX API will return
// {"error":{"status":400,"text":"unknown parameter \"id\"","code":"UpstreamConfFormatError"}
// if the ID field is present.
server.ID = 0
err := client.patch(ctx, path, &server, http.StatusOK)
if err != nil {
return fmt.Errorf("failed to update %v stream server to %v upstream: %w", server.Server, upstream, err)
}
return nil
}
// Version returns client's current N+ API version.
func (client *NginxClient) Version() int {
return client.apiVersion
}
func addPortToServer(server string) string {
if len(strings.Split(server, ":")) == 2 {
return server
}
if len(strings.Split(server, "]:")) == 2 {
return server
}
if strings.HasPrefix(server, "unix:") {
return server
}
return fmt.Sprintf("%v:%v", server, defaultServerPort)
}
// GetHTTPLimitReqs returns http/limit_reqs stats with a context.
func (client *NginxClient) GetHTTPLimitReqs(ctx context.Context) (*HTTPLimitRequests, error) {
var limitReqs HTTPLimitRequests
if client.apiVersion < 6 {
return &limitReqs, nil
}
err := client.get(ctx, "http/limit_reqs", &limitReqs)
if err != nil {
return nil, fmt.Errorf("failed to get http limit requests: %w", err)
}
return &limitReqs, nil
}
// GetHTTPConnectionsLimit returns http/limit_conns stats with a context.
func (client *NginxClient) GetHTTPConnectionsLimit(ctx context.Context) (*HTTPLimitConnections, error) {
var limitConns HTTPLimitConnections
if client.apiVersion < 6 {
return &limitConns, nil
}
err := client.get(ctx, "http/limit_conns", &limitConns)
if err != nil {
return nil, fmt.Errorf("failed to get http connections limit: %w", err)
}
return &limitConns, nil
}
// GetStreamConnectionsLimit returns stream/limit_conns stats with a context.
func (client *NginxClient) GetStreamConnectionsLimit(ctx context.Context) (*StreamLimitConnections, error) {
var limitConns StreamLimitConnections
if client.apiVersion < 6 {
return &limitConns, nil
}
err := client.get(ctx, "stream/limit_conns", &limitConns)
if err != nil {
var ie *internalError
if errors.As(err, &ie) {
if ie.Code() == pathNotFoundCode {
return &limitConns, nil
}
}
return nil, fmt.Errorf("failed to get stream connections limit: %w", err)
}
return &limitConns, nil
}
// GetWorkers returns workers stats.
func (client *NginxClient) GetWorkers(ctx context.Context) ([]*Workers, error) {
var workers []*Workers
if client.apiVersion < 9 {
return workers, nil
}
err := client.get(ctx, "workers", &workers)
if err != nil {
return nil, fmt.Errorf("failed to get workers: %w", err)
}
return workers, nil
}
var rePlus = regexp.MustCompile(`-r(\d+)`)
// extractPlusVersionValues.
func extractPlusVersionValues(input string) (int, error) {
var rValue int
matches := rePlus.FindStringSubmatch(input)
if len(matches) < 1 {
return 0, fmt.Errorf("%w [%s]", ErrPlusVersionNotFound, input)
}
rValue, err := strconv.Atoi(matches[1])
if err != nil {
return 0, fmt.Errorf("failed to convert NGINX Plus release to integer: %w", err)
}
return rValue, nil
}
|