Expand description
Contains all types received by and sent from Sōzu
Modules§
- filtered_
metrics - Nested message and enum types in
FilteredMetrics. - ip_
address - Nested message and enum types in
IpAddress. - protobuf_
endpoint - Nested message and enum types in
ProtobufEndpoint. - request
- Nested message and enum types in
Request. - response_
content - Nested message and enum types in
ResponseContent.
Structs§
- Activate
Listener - AddBackend
- add a backend
- AddCertificate
- Add a new TLS certificate to an HTTPs listener
- Aggregated
Metrics - Aggregated metrics of main process & workers
- Available
Metrics - lists of available metrics in a worker, or in the main process (in which case there are no cluster metrics)
- Backend
Metrics - Bucket
- a prometheus histogram bucket
- Certificate
AndKey - Certificate
Summary - domain name and fingerprint of a certificate
- Certificates
ByAddress - Summaries of certificates for a given address
- Certificates
With Fingerprints - to reply to several certificate queries
- Cluster
- A cluster is what binds a frontend to backends with routing rules
- Cluster
Hashes - Cluster
Information - Information about a given cluster Contains types usually used in requests, because they are readily available in protobuf
- Cluster
Informations - Cluster
Metrics - the metrics of a given cluster, with several backends
- Count
Requests - Custom
Http Answers - custom HTTP answers, useful for 404, 503 pages
- Deactivate
Listener - Event
- an event produced by a worker to notify about backends status
- Filtered
Histogram - a histogram meant to be translated to prometheus
- Filtered
Metrics - A metric, in a “filtered” format, which means: sendable to outside programs.
- Filtered
Time Serie - Frontend
Filters - list the frontends, filtered by protocol and/or domain
- Hard
Stop - Http
Endpoint - Http
Listener Config - details of an HTTP listener
- Https
Listener Config - details of an HTTPS listener
- Initial
State - the Sōzu state, passed to a new worker. Consists in a collection of worker requests
- IpAddress
- List
Listeners - List
OfCertificates ByAddress - Used by workers to reply to some certificate queries
- List
Workers - Listed
Frontends - lists of frontends present in the state
- Listeners
Count - Addresses of listeners, passed to new workers
- Listeners
List - All listeners, listed
- Load
Balancing Params - Path
Rule - A filter for the path of incoming requests
- Percentiles
- Protobuf
Access Log - An access log, meant to be passed to another agent
- Protobuf
Endpoint - Query
Certificates Filters - Should be either a domain name or a fingerprint. These filter do not compound, use either one but not both. If none of them is specified, all certificates will be returned.
- Query
Cluster ByDomain - Query
Clusters Hashes - Query
Metrics Options - Options when querying metrics
- Remove
Backend - remove an existing backend
- Remove
Certificate - Remove
Listener - Replace
Certificate - Request
- A message received by Sōzu to change its state or query information
- Request
Counts - Request
Http Frontend - An HTTP or HTTPS frontend, as order to, or received from, Sōzu
- Request
TcpFrontend - Response
- Response to a request
- Response
Content - content of a response
- Return
Listen Sockets - Server
Config - Used by a worker to start its server loop. The defaults should match those of the config module
- Server
Metrics Config - intended to workers
- Socket
Address - matches std::net::SocketAddr in the Rust library beware that the ports are expressed with uint32 here, but they should NOT exceed uint16 value
- Soft
Stop - Status
- Subscribe
Events - TcpEndpoint
- TcpListener
Config - details of an TCP listener
- Uint128
- used to represent the 128 bits of an IPv6 address
- Upgrade
Main - Worker
Info - Information about a worker with id, pid, runstate
- Worker
Infos - A list of worker infos
- Worker
Metrics - All metrics of a worker: proxy and clusters Populated by Options so partial results can be sent
- Worker
Request - This is sent only from Sōzu to Sōzu
- Worker
Response - A response as sent by a worker
- Worker
Responses - a map of worker_id -> ResponseContent
Enums§
- Event
Kind - Listener
Type - Load
Balancing Algorithms - Load
Metric - how sozu measures which backend is less loaded
- Metrics
Configuration - options to configure metrics collection
- Path
Rule Kind - The kind of filter used for path rules
- Protobuf
Access LogFormat - Proxy
Protocol Config - Response
Status - Rule
Position - TODO: find a proper definition for this
- RunState
- Runstate of a worker
- TlsVersion