client

package

Go to main page

Versions in this module

v0

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

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