client

package

Go to main page

Versions in this module

v1

v1.3.0

Aug 15, 2024

Changes in this version

+ var ErrInvalidTimeout = errors.New("invalid timeout")

+ var ErrNotSupported = errors.New("not supported")

+ var ErrParameterRequired = errors.New("parameter is required")

+ var ErrServerExists = errors.New("server already exists")

+ var ErrServerNotFound = errors.New("server not found")

type NginxClient

+ func (client *NginxClient) GetMaxAPIVersion() (int, error)

type Option

+ func WithTimeout(duration time.Duration) Option

v1.2.2

Jul 16, 2024

Changes in this version

type Upstream

+ Keepalive int

v1.2.1

Jun 18, 2024

v1.2.0

Nov 13, 2023

Changes in this version

type SSL

+ HandshakeTimeout uint64

+ NoCommonCipher uint64

+ NoCommonProtocol uint64

+ PeerRejectedCert uint64

+ VerifyFailures VerifyFailures

+ type VerifyFailures struct

+ ExpiredCert uint64

+ HostnameMismatch uint64

+ NoCert uint64

+ Other uint64

+ RevokedCert uint64

v1.1.0

Oct 9, 2023

Changes in this version

type NginxClient

+ func (client *NginxClient) GetAvailableEndpoints() ([]string, error)

+ func (client *NginxClient) GetAvailableStreamEndpoints() ([]string, error)

v1.0.0

Sep 19, 2023

Changes in this version

+ type Option func(*NginxClient)

+ func WithAPIVersion(apiVersion int) Option

+ func WithCheckAPI() Option

+ func WithHTTPClient(httpClient *http.Client) Option

v0

v0.11.0

Aug 29, 2023

Changes in this version

type NginxClient

+ func (client *NginxClient) GetWorkers() ([]*Workers, error)

type Stats

+ Workers []*Workers

+ type Workers struct

+ Connections Connections

+ HTTP WorkersHTTP

+ ID int

+ ProcessID uint64

+ type WorkersHTTP struct

+ HTTPRequests HTTPRequests

v0.10.0

Jul 19, 2022

Changes in this version

+ type HTTPCodes struct

+ HTTPAccepted uint64

+ HTTPBadGateway uint64

+ HTTPBadRequest uint64

+ HTTPClientClosedRequest uint64

+ HTTPClose uint64

+ HTTPConflict uint64

+ HTTPContinue uint64

+ HTTPCreated uint64

+ HTTPForbidden uint64

+ HTTPGatewayTimeOut uint64

+ HTTPInsufficientStorage uint64

+ HTTPInternalServerError uint64

+ HTTPLengthRequired uint64

+ HTTPMovedPermanently uint64

+ HTTPMovedTemporarily uint64

+ HTTPNoContent uint64

+ HTTPNotAllowed uint64

+ HTTPNotFound uint64

+ HTTPNotImplemented uint64

+ HTTPNotModified uint64

+ HTTPOk uint64

+ HTTPPartialContent uint64

+ HTTPPreconditionFailed uint64

+ HTTPProcessing uint64

+ HTTPRangeNotSatisfiable uint64

+ HTTPRequestEntityTooLarge uint64

+ HTTPRequestHeaderTooLarge uint64

+ HTTPRequestTimeOut uint64

+ HTTPRequestURITooLarge uint64

+ HTTPSCertError uint64

+ HTTPSNoCert uint64

+ HTTPSeeOther uint64

+ HTTPServiceUnavailable uint64

+ HTTPSpecialResponse uint64

+ HTTPSwitchingProtocols uint64

+ HTTPTemporaryRedirect uint64

+ HTTPToHTTPS uint64

+ HTTPTooManyRequests uint64

+ HTTPUnauthorized uint64

+ HTTPUnsupportedMediaType uint64

+ type HTTPLimitConnections map[string]LimitConnection

+ type HTTPLimitRequest struct

+ Delayed uint64

+ DelayedDryRun uint64

+ Passed uint64

+ Rejected uint64

+ RejectedDryRun uint64

+ type HTTPLimitRequests map[string]HTTPLimitRequest

+ type LimitConnection struct

+ Passed uint64

+ Rejected uint64

+ RejectedDryRun uint64

type NginxClient

+ func (client *NginxClient) GetHTTPConnectionsLimit() (*HTTPLimitConnections, error)

+ func (client *NginxClient) GetHTTPLimitReqs() (*HTTPLimitRequests, error)

+ func (client *NginxClient) GetStreamConnectionsLimit() (*StreamLimitConnections, error)

type Peer

+ SSL SSL

type Responses

+ Codes HTTPCodes

type ServerZone

+ SSL SSL

type Stats

+ HTTPLimitConnections HTTPLimitConnections

+ HTTPLimitRequests HTTPLimitRequests

+ StreamLimitConnections StreamLimitConnections

+ type StreamLimitConnections map[string]LimitConnection

type StreamPeer

+ SSL SSL

type StreamServerZone

+ SSL SSL

v0.9.0

Sep 28, 2021

Changes in this version

+ type CacheStats struct

+ Bytes uint64

+ Responses uint64

+ type Caches = map[string]HTTPCache

+ type ExtendedCacheStats struct

+ BytesWritten uint64

+ ResponsesWritten uint64

+ type HTTPCache struct

+ Bypass ExtendedCacheStats

+ Cold bool

+ Expired ExtendedCacheStats

+ Hit CacheStats

+ MaxSize uint64

+ Miss CacheStats

+ Revalidated CacheStats

+ Size uint64

+ Stale CacheStats

+ Updating CacheStats

type NginxClient

+ func (client *NginxClient) GetCaches() (*Caches, error)

type Stats

+ Caches Caches

v0.8.0

Nov 26, 2020

Changes in this version

+ var ErrUnsupportedVer = errors.New("API version of the client is not supported by running NGINX Plus")

type NginxClient

+ func NewNginxClientWithVersion(httpClient *http.Client, apiEndpoint string, version int) (*NginxClient, error)

+ func (client *NginxClient) Version() int

v0.7.0

Jul 13, 2020

Changes in this version

type NginxClient

+ func (client *NginxClient) GetConnections() (*Connections, error)

+ func (client *NginxClient) GetHTTPRequests() (*HTTPRequests, error)

+ func (client *NginxClient) GetLocationZones() (*LocationZones, error)

+ func (client *NginxClient) GetNginxInfo() (*NginxInfo, error)

+ func (client *NginxClient) GetProcesses() (*Processes, error)

+ func (client *NginxClient) GetResolvers() (*Resolvers, error)

+ func (client *NginxClient) GetSSL() (*SSL, error)

+ func (client *NginxClient) GetServerZones() (*ServerZones, error)

+ func (client *NginxClient) GetSlabs() (*Slabs, error)

+ func (client *NginxClient) GetStreamServerZones() (*StreamServerZones, error)

+ func (client *NginxClient) GetStreamUpstreams() (*StreamUpstreams, error)

+ func (client *NginxClient) GetStreamZoneSync() (*StreamZoneSync, error)

+ func (client *NginxClient) GetUpstreams() (*Upstreams, error)

+ type Pages struct

+ Free uint64

+ Used uint64

+ type Processes struct

+ Respawned int64

+ type Slab struct

+ Pages Pages

+ Slots Slots

+ type Slabs map[string]Slab

+ type Slot struct

+ Fails uint64

+ Free uint64

+ Reqs uint64

+ Used uint64

+ type Slots map[string]Slot

type Stats

+ Processes Processes

+ Slabs Slabs

v0.6.0

Nov 11, 2019

Changes in this version

type NginxClient

+ func (client *NginxClient) UpdateHTTPServer(upstream string, server UpstreamServer) error

+ func (client *NginxClient) UpdateStreamServer(upstream string, server StreamUpstreamServer) error

v0.5.0

Sep 30, 2019

Changes in this version

+ type LocationZone struct

+ Discarded int64

+ Received int64

+ Requests int64

+ Responses Responses

+ Sent int64

+ type LocationZones map[string]LocationZone

+ type Resolver struct

+ Requests ResolverRequests

+ Responses ResolverResponses

+ type ResolverRequests struct

+ Addr int64

+ Name int64

+ Srv int64

+ type ResolverResponses struct

+ Formerr int64

+ Noerror int64

+ Notimp int64

+ Nxdomain int64

+ Refused int64

+ Servfail int64

+ Timedout int64

+ Unknown int64

+ type Resolvers map[string]Resolver

type Stats

+ LocationZones LocationZones

+ Resolvers Resolvers

type StreamUpstreamServer

+ Backup bool

+ Down bool

+ Service string

+ Weight *int

type UpstreamServer

+ Backup bool

+ Down bool

+ Drain bool

+ Route string

+ Service string

+ Weight *int

v0.4.0

Jul 17, 2019

Changes in this version

type StreamUpstreamServer

+ MaxConns int

type UpstreamServer

+ MaxConns int

v0.3.1

Jun 10, 2019

Changes in this version

+ const APIVersion

+ type Connections struct

+ Accepted uint64

+ Active uint64

+ Dropped uint64

+ Idle uint64

+ type HTTPRequests struct

+ Current uint64

+ Total uint64

+ type HealthChecks struct

+ Checks uint64

+ Fails uint64

+ LastPassed bool

+ Unhealthy uint64

+ type KeyValPairs map[string]string

+ type KeyValPairsByZone map[string]KeyValPairs

+ type NginxClient struct

+ func NewNginxClient(httpClient *http.Client, apiEndpoint string) (*NginxClient, error)

+ func (client *NginxClient) AddHTTPServer(upstream string, server UpstreamServer) error

+ func (client *NginxClient) AddKeyValPair(zone string, key string, val string) error

+ func (client *NginxClient) AddStreamKeyValPair(zone string, key string, val string) error

+ func (client *NginxClient) AddStreamServer(upstream string, server StreamUpstreamServer) error

+ func (client *NginxClient) CheckIfStreamUpstreamExists(upstream string) error

+ func (client *NginxClient) CheckIfUpstreamExists(upstream string) error

+ func (client *NginxClient) DeleteHTTPServer(upstream string, server string) error

+ func (client *NginxClient) DeleteKeyValPairs(zone string) error

+ func (client *NginxClient) DeleteKeyValuePair(zone string, key string) error

+ func (client *NginxClient) DeleteStreamKeyValPairs(zone string) error

+ func (client *NginxClient) DeleteStreamKeyValuePair(zone string, key string) error

+ func (client *NginxClient) DeleteStreamServer(upstream string, server string) error

+ func (client *NginxClient) GetAllKeyValPairs() (KeyValPairsByZone, error)

+ func (client *NginxClient) GetAllStreamKeyValPairs() (KeyValPairsByZone, error)

+ func (client *NginxClient) GetHTTPServers(upstream string) ([]UpstreamServer, error)

+ func (client *NginxClient) GetKeyValPairs(zone string) (KeyValPairs, error)

+ func (client *NginxClient) GetStats() (*Stats, error)

+ func (client *NginxClient) GetStreamKeyValPairs(zone string) (KeyValPairs, error)

+ func (client *NginxClient) GetStreamServers(upstream string) ([]StreamUpstreamServer, error)

+ func (client *NginxClient) ModifyKeyValPair(zone string, key string, val string) error

+ func (client *NginxClient) ModifyStreamKeyValPair(zone string, key string, val string) error

+ func (client *NginxClient) UpdateHTTPServers(upstream string, servers []UpstreamServer) ([]UpstreamServer, []UpstreamServer, error)

+ func (client *NginxClient) UpdateStreamServers(upstream string, servers []StreamUpstreamServer) ([]StreamUpstreamServer, []StreamUpstreamServer, error)

+ type NginxInfo struct

+ Address string

+ Build string

+ Generation uint64

+ LoadTimestamp string

+ ParentProcessID uint64

+ ProcessID uint64

+ Timestamp string

+ Version string

+ type Peer struct

+ Active uint64

+ Backup bool

+ Downstart string

+ Downtime uint64

+ Fails uint64

+ HeaderTime uint64

+ HealthChecks HealthChecks

+ ID int

+ MaxConns int

+ Name string

+ Received uint64

+ Requests uint64

+ ResponseTime uint64

+ Responses Responses

+ Selected string

+ Sent uint64

+ Server string

+ Service string

+ State string

+ Unavail uint64

+ Weight int

+ type Queue struct

+ MaxSize int

+ Overflows uint64

+ Size int

+ type Responses struct

+ Responses1xx uint64

+ Responses2xx uint64

+ Responses3xx uint64

+ Responses4xx uint64

+ Responses5xx uint64

+ Total uint64

+ type SSL struct

+ Handshakes uint64

+ HandshakesFailed uint64

+ SessionReuses uint64

+ type ServerZone struct

+ Discarded uint64

+ Processing uint64

+ Received uint64

+ Requests uint64

+ Responses Responses

+ Sent uint64

+ type ServerZones map[string]ServerZone

+ type Sessions struct

+ Sessions2xx uint64

+ Sessions4xx uint64

+ Sessions5xx uint64

+ Total uint64

+ type Stats struct

+ Connections Connections

+ HTTPRequests HTTPRequests

+ NginxInfo NginxInfo

+ SSL SSL

+ ServerZones ServerZones

+ StreamServerZones StreamServerZones

+ StreamUpstreams StreamUpstreams

+ StreamZoneSync *StreamZoneSync

+ Upstreams Upstreams

+ type StreamPeer struct

+ Active uint64

+ Backup bool

+ ConnectTime int

+ Connections uint64

+ Downstart string

+ Downtime uint64

+ Fails uint64

+ FirstByteTime int

+ HealthChecks HealthChecks

+ ID int

+ MaxConns int

+ Name string

+ Received uint64

+ ResponseTime uint64

+ Selected string

+ Sent uint64

+ Server string

+ Service string

+ State string

+ Unavail uint64

+ Weight int

+ type StreamServerZone struct

+ Connections uint64

+ Discarded uint64

+ Processing uint64

+ Received uint64

+ Sent uint64

+ Sessions Sessions

+ type StreamServerZones map[string]StreamServerZone

+ type StreamUpstream struct

+ Peers []StreamPeer

+ Zombies int

+ Zone string

+ type StreamUpstreamServer struct

+ FailTimeout string

+ ID int

+ MaxFails int

+ Server string

+ SlowStart string

+ type StreamUpstreams map[string]StreamUpstream

+ type StreamZoneSync struct

+ Status StreamZoneSyncStatus

+ Zones map[string]SyncZone

+ type StreamZoneSyncStatus struct

+ BytesIn uint64

+ BytesOut uint64

+ MsgsIn uint64

+ MsgsOut uint64

+ NodesOnline uint64

+ type SyncZone struct

+ RecordsPending uint64

+ RecordsTotal uint64

+ type Upstream struct

+ Keepalives int

+ Peers []Peer

+ Queue Queue

+ Zombies int

+ Zone string

+ type UpstreamServer struct

+ FailTimeout string

+ ID int

+ MaxFails int

+ Server string

+ SlowStart string

+ type Upstreams map[string]Upstream

Other modules containing this package

github.com/nginxinc/nginx-plus-go-client/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL