added version 9 of API and new worker metrics. Updated pipeline for R30

Author: oliveromahony

Makefile

@@ -1,8 +1,10 @@
-NGINX_PLUS_VERSION=r29
+NGINX_PLUS_VERSION=r30
 DOCKER_NETWORK?=test
 DOCKER_NETWORK_ALIAS=nginx-plus-test
 DOCKER_NGINX_PLUS?=nginx-plus
 DOCKER_NGINX_PLUS_HELPER?=nginx-plus-helper
+NGINX_REPO_URL?=pkgs-test.nginx.com
+NGINX_CERT_DIR?=docker
 
 GOLANG_CONTAINER=golang:1.19
 
@@ -16,7 +18,7 @@ lint:
 	docker run --pull always --rm -v $(shell pwd):/nginx-plus-go-client -w /nginx-plus-go-client -v $(shell go env GOCACHE):/cache/go -e GOCACHE=/cache/go -e GOLANGCI_LINT_CACHE=/cache/go -v $(shell go env GOPATH)/pkg:/go/pkg golangci/golangci-lint:latest golangci-lint --color always run
 
 docker-build:
-	docker build --secret id=nginx-repo.crt,src=docker/nginx-repo.crt --secret id=nginx-repo.key,src=docker/nginx-repo.key --build-arg NGINX_PLUS_VERSION=$(NGINX_PLUS_VERSION) -t nginx-plus:$(NGINX_PLUS_VERSION) docker
+	docker build --secret id=nginx-repo.crt,src=${NGINX_CERT_DIR}/nginx-repo.crt --secret id=nginx-repo.key,src=${NGINX_CERT_DIR}/nginx-repo.key --build-arg NGINX_PLUS_VERSION=$(NGINX_PLUS_VERSION) --build-arg NGINX_REPO_URL=$(NGINX_REPO_URL) -t nginx-plus:$(NGINX_PLUS_VERSION) docker
 
 run-nginx-plus:
 	docker network create --driver bridge $(DOCKER_NETWORK)

client/nginx.go

@@ -15,7 +15,7 @@ import (
 
 const (
 	// APIVersion is the default version of NGINX Plus API supported by the client.
-	APIVersion = 8
+	APIVersion = 9
 
 	pathNotFoundCode  = "PathNotFound"
 	streamContext     = true
@@ -24,7 +24,7 @@ const (
 )
 
 var (
-	supportedAPIVersions = versions{4, 5, 6, 7, 8}
+	supportedAPIVersions = versions{4, 5, 6, 7, 8, 9}
 
 	// Default values for servers in Upstreams.
 	defaultMaxConns    = 0
@@ -132,6 +132,7 @@ type Stats struct {
 	HTTPLimitRequests      HTTPLimitRequests
 	HTTPLimitConnections   HTTPLimitConnections
 	StreamLimitConnections StreamLimitConnections
+	Workers                []*Workers
 }
 
 // NginxInfo contains general information about NGINX Plus.
@@ -494,6 +495,19 @@ 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"`
+}
+
 // NewNginxClient creates an NginxClient with the latest supported version.
 func NewNginxClient(httpClient *http.Client, apiEndpoint string) (*NginxClient, error) {
 	return NewNginxClientWithVersion(httpClient, apiEndpoint, APIVersion)
@@ -1186,6 +1200,11 @@ func (client *NginxClient) GetStats() (*Stats, error) {
 		return nil, fmt.Errorf("failed to get stats: %w", err)
 	}
 
+	workers, err := client.GetWorkers()
+	if err != nil {
+		return nil, fmt.Errorf("failed to get stats: %w", err)
+	}
+
 	return &Stats{
 		NginxInfo:              *info,
 		Caches:                 *caches,
@@ -1204,6 +1223,7 @@ func (client *NginxClient) GetStats() (*Stats, error) {
 		HTTPLimitRequests:      *limitReqs,
 		HTTPLimitConnections:   *limitConnsHTTP,
 		StreamLimitConnections: *limitConnsStream,
+		Workers:                workers,
 	}, nil
 }
 
@@ -1639,3 +1659,16 @@ func (client *NginxClient) GetStreamConnectionsLimit() (*StreamLimitConnections,
 	}
 	return &limitConns, nil
 }
+
+// GetWorkers returns workers stats.
+func (client *NginxClient) GetWorkers() ([]*Workers, error) {
+	var workers []*Workers
+	if client.version < 8 {
+		return workers, nil
+	}
+	err := client.get("workers", &workers)
+	if err != nil {
+		return nil, fmt.Errorf("failed to get workers: %w", err)
+	}
+	return workers, nil
+}

docker/Dockerfile

@@ -1,9 +1,10 @@
 # syntax=docker/dockerfile:1.4
-FROM debian:bullseye-slim
+FROM debian:bullseye
 
 LABEL maintainer="NGINX Docker Maintainers <integrations@nginx.com>"
 
 ARG NGINX_PLUS_VERSION
+ARG NGINX_REPO_URL
 
 # Install NGINX Plus
 # Download certificate and key from the customer portal (https://my.f5.com)
@@ -16,7 +17,7 @@ RUN --mount=type=secret,id=nginx-repo.crt,dst=/etc/ssl/nginx/nginx-repo.crt,mode
     curl -fsSL https://cs.nginx.com/static/keys/nginx_signing.key | gpg --dearmor > /etc/apt/trusted.gpg.d/nginx_signing.gpg
     curl -fsSL -o /etc/apt/apt.conf.d/90pkgs-nginx https://cs.nginx.com/static/files/90pkgs-nginx
     DEBIAN_VERSION=$(awk -F '=' '/^VERSION_CODENAME=/ {print $2}' /etc/os-release)
-    printf "%s\n" "deb https://pkgs.nginx.com/plus/${NGINX_PLUS_VERSION^^}/debian ${DEBIAN_VERSION} nginx-plus" > /etc/apt/sources.list.d/nginx-plus.list
+    printf "%s\n" "deb [trusted=yes] https://${NGINX_REPO_URL}/plus/${NGINX_PLUS_VERSION^^}/debian ${DEBIAN_VERSION} nginx-plus" > /etc/apt/sources.list.d/nginx-plus.list
     apt-get update
     apt-get install -y nginx-plus
     apt-get remove --purge --auto-remove -y gnupg

docker/nginx.conf

@@ -1,16 +1,14 @@
 
 user  nginx;
-worker_processes  auto;
+worker_processes  4;
 
 error_log  /var/log/nginx/error.log notice;
 pid        /var/run/nginx.pid;
 
-
 events {
     worker_connections  1024;
 }
 
-
 http {
     include       /etc/nginx/mime.types;
     default_type  application/octet-stream;
@@ -22,12 +20,9 @@ http {
     access_log  /var/log/nginx/access.log  main;
 
     sendfile        on;
-    #tcp_nopush     on;
 
     keepalive_timeout  65;
 
-    #gzip  on;
-
     keyval_zone zone=zone_one:32k;
     keyval $arg_text $text zone=zone_one;
 

docker/nginx_no_stream.conf

@@ -1,6 +1,6 @@
 
 user  nginx;
-worker_processes  auto;
+worker_processes  4;
 
 error_log  /var/log/nginx/error.log notice;
 pid        /var/run/nginx.pid;
@@ -10,7 +10,6 @@ events {
     worker_connections  1024;
 }
 
-
 http {
     include       /etc/nginx/mime.types;
     default_type  application/octet-stream;
@@ -22,11 +21,8 @@ http {
     access_log  /var/log/nginx/access.log  main;
 
     sendfile        on;
-    #tcp_nopush     on;
 
     keepalive_timeout  65;
 
-    #gzip  on;
-
     include /etc/nginx/conf.d/*.conf;
 }

docker/test.conf

@@ -27,7 +27,6 @@ server {
         health_check interval=10 fails=3 passes=1;
     }
     status_zone test;
-
 }
 
 upstream test-drain {

tests/client_test.go

@@ -627,6 +627,10 @@ func TestStats(t *testing.T) {
 		t.Errorf("Bad connections: %v", stats.Connections)
 	}
 
+	if len(stats.Workers) < 1 {
+		t.Errorf("Bad workers: %v", stats.Workers)
+	}
+
 	if val, ok := stats.Caches[cacheZone]; ok {
 		if val.MaxSize != 104857600 { // 100MiB
 			t.Errorf("Cache max size stats missing: %v", val.Size)