moonbitstack/moonzero/consul

README
U
Balancer
U
BidiCall
U
BidiStreamFactory
U
BidiStreamHandler
U
Breaker
U
ClientStreamHandler
U
Clock
U
Conf
U
ConfigError
U
ConsulClient
U
ConsulDiscovery
U
ConsulError
U
ConsulHttp
U
ConsulResponse
U
CorsConf
U
CounterVec
U
Endpoint
U
EtcdClient
U
EtcdDeleteRangeRequest
U
EtcdDeleteRangeResponse
U
EtcdDiscovery
U
EtcdError
U
EtcdEvent
U
EtcdEventType
U
EtcdKeyValue
U
EtcdLeaseGrantRequest
U
EtcdLeaseGrantResponse
U
EtcdLeaseKeepAliveRequest
U
EtcdLeaseKeepAliveResponse
U
EtcdPutRequest
U
EtcdPutResponse
U
EtcdRangeRequest
U
EtcdRangeResponse
U
EtcdWatchCancelRequest
U
EtcdWatchCreateRequest
U
EtcdWatchRequest
U
EtcdWatchResponse
U
Group
U
Histogram
U
InMemoryRegistry
U
Layer
U
LoadBalancedChannel
U
LogLevel
U
Logger
U
ManualClock
U
MaxConns
U
Middleware
U
MiddlewaresConf
U
PeriodLimit
U
PeriodResult
U
PersistentRegistry
U
PrivateKeyConf
U
Promise
U
RedisClient
U
RedisConn
U
RedisDiscovery
U
RedisError
U
RedisPeriodLimit
U
RedisScript
U
RedisTokenLimit
U
Refusal
U
RegistryEvent
U
RequestLog
U
Resolve
U
RespError
U
RespReader
U
RespValue
U
RestConf
U
RestEngine
U
RoundRobin
U
RpcChannel
U
RpcCluster
U
RpcGroup
U
RpcHandler
U
RpcServer
U
RpcServerConf
U
Server
U
ServerMetrics
U
ServerStreamHandler
U
ServiceConf
U
Shedder
U
ShutdownCoordinator
U
SignatureConf
U
Ticket
U
TokenBucket
U
TraceContext
U
Unavailable
U
WeightedRoundRobin
V
auth
V
breaker
V
canonical_key
V
consul_check_id
V
consul_parse_health
V
consul_register_body
V
cors
V
default_latency_buckets
V
duration_key
V
entry
V
etcd_prefix_end
V
etcd_service_prefix
V
exposition_content_type
V
generate_span_id
V
generate_trace_id
V
jwt_authorized
V
jwt_sign
V
jwt_verify
V
level_name
V
logging
V
logx
V
max_conns
V
maxbytes
V
message_key
V
metrics
V
metrics_handler
V
mount_metrics
V
next_trace_context
V
parse_traceparent
V
period_limit
V
period_script
V
pick_first
V
plain_text
V
port
V
rate_limit
V
recovery
V
redis_instance_key
V
redis_period_limit
V
redis_rate_limit
V
redis_service_pattern
V
redis_service_prefix
V
refusal
V
request_id
V
resolve_one
V
resp_command
V
resp_encode_command
V
resp_kind
V
rpc_port
V
set_log_level
V
set_log_sink
V
set_log_writer
V
shedding
V
stamp_key
V
status_of_code
V
structured_logging
V
timed_out
V
timeout
V
token_script
V
too_large
V
too_many
V
tracing
V
unavailable

moonbitstack/moonzero/consul does not have a README file

ConsulHttp

pub(open) trait ConsulHttp {
  fn request(Self, String, String, Bytes) -> ConsulResponse raise
}

A transport to a consul agent: it performs one HTTP request (method and path, with body for writes) and returns the response. Implementations own the medium — a real HTTP socket, or an in-memory fake.

ConsulError

source

pub suberror ConsulError {
  ConsulError(String)
}

A consul API call that failed — a transport error, or a non-2xx agent response.

ConsulClient

source

pub struct ConsulClient {
  http : &ConsulHttp
}

A consul client over a ConsulHttp, exposing the agent operations discovery uses.

ConsulClient::agent_services

source

fn ConsulClient::agent_services(self : ConsulClient) -> Array[(String, String)] raise ConsulError

GET /v1/agent/services: every service instance registered on this agent, as (instance-id, service-name) pairs — the list a by-name deregister filters to find the ids to drop.

ConsulClient::check_pass

source

fn ConsulClient::check_pass(self : ConsulClient, service_id : String) -> Unit raise ConsulError

PUT /v1/agent/check/pass/service:<id>: mark an instance's TTL check passing, the keep-alive that renews its lease.

ConsulClient::deregister_service

source

fn ConsulClient::deregister_service(self : ConsulClient, id : String) -> Unit raise ConsulError

PUT /v1/agent/service/deregister/<id>: deregister one instance.

ConsulClient::health_service

source

fn ConsulClient::health_service(self : ConsulClient, name : String) -> Array[@moonbitstack/moonzero/registry.Endpoint
Endpoint] raise ConsulError

GET /v1/health/service/<name>?passing=true: the healthy instances of name, each as its Service.Address:Service.Port endpoint (falling back to Node.Address when the service advertises no address of its own, as consul's clients do).

ConsulClient::new

source

fn ConsulClient::new(http : &ConsulHttp) -> ConsulClient

A client over http.

ConsulClient::register_service

source

fn ConsulClient::register_service(self : ConsulClient, id : String, name : String, address : String, port : Int, ttl_secs : Int) -> Unit raise ConsulError

PUT /v1/agent/service/register: register an instance under name at address:port with an id, held alive by a TTL check that consul deregisters ttl*3 seconds after it stops passing. Pass the check with check_pass before each TTL lapses to stay healthy.

ConsulDiscovery

source

pub struct ConsulDiscovery {
  client : ConsulClient
}

A consul-backed service registry / resolver over a ConsulClient. Each instance is a consul service named service, uniquely identified per agent by its address.

ConsulDiscovery::deregister

source

fn ConsulDiscovery::deregister(self : ConsulDiscovery, service : String) -> Unit raise

Deregister every instance of service registered on this agent.

ConsulDiscovery::deregister_instance

source

fn ConsulDiscovery::deregister_instance(self : ConsulDiscovery, service : String, endpoint : @moonbitstack/moonzero/registry.Endpoint
Endpoint) -> Unit raise

Deregister one instance of service.

ConsulDiscovery::keepalive

source

fn ConsulDiscovery::keepalive(self : ConsulDiscovery, service : String, endpoint : @moonbitstack/moonzero/registry.Endpoint
Endpoint) -> Unit raise

Refresh an instance's lease by passing its TTL check.

ConsulDiscovery::new

source

fn ConsulDiscovery::new(client : ConsulClient) -> ConsulDiscovery

A consul discovery over client.

ConsulDiscovery::register

source

fn ConsulDiscovery::register(self : ConsulDiscovery, service : String, endpoint : @moonbitstack/moonzero/registry.Endpoint
Endpoint, ttl? : Int) -> String raise

Register endpoint for service with a ttl-second TTL check and immediately pass the check so the instance is healthy at once (a fresh TTL check starts critical). Returns the instance id; renew it with keepalive before the TTL lapses.

ConsulDiscovery::resolve

source

fn ConsulDiscovery::resolve(self : ConsulDiscovery, service : String) -> Array[@moonbitstack/moonzero/registry.Endpoint
Endpoint] raise

Resolve service to its healthy endpoints.

ConsulDiscovery::resolver

source

fn ConsulDiscovery::resolver(self : ConsulDiscovery) -> ((String) -> Array[@moonbitstack/moonzero/registry.Endpoint
Endpoint])

This consul discovery as a Resolve interface value, so the balancer and the load-balanced channel run against consul unchanged. A resolve error surfaces as an empty endpoint set, matching the other drivers.

ConsulResponse

source

pub struct ConsulResponse {
  status : Int
  body : Bytes
}

A consul agent's HTTP response: the status code and the raw body bytes.

ConsulResponse::body

source

fn ConsulResponse::body(self : ConsulResponse) -> Bytes

The raw response body bytes.

ConsulResponse::new

source

fn ConsulResponse::new(status : Int, body : Bytes) -> ConsulResponse

A consul response.

ConsulResponse::status

source

fn ConsulResponse::status(self : ConsulResponse) -> Int

The HTTP status code.

consul_check_id

source

fn consul_check_id(service_id : String) -> String

The check id consul assigns an inline service TTL check: service:<service-id>.

consul_int_field

source

fn consul_int_field(obj : Json, key : String) -> Int

The integer value of a JSON number key, truncated toward zero, or 0.

consul_parse_health

source

fn consul_parse_health(body : Bytes) -> Array[@moonbitstack/moonzero/registry.Endpoint
Endpoint] raise ConsulError

Parse a consul health/service JSON body into endpoints — exposed so the native HTTP-socket path decodes a real agent's response exactly as the client does.

consul_register_body

source

fn consul_register_body(id : String, name : String, address : String, port : Int, ttl_secs : Int) -> Bytes

The JSON body of a service/register request: the instance's id, name, address, and port, plus a TTL check that consul deregisters ttl*3 seconds after it stops passing. Exposed so the native HTTP-socket path builds the exact same body.

consul_str_field

source

fn consul_str_field(obj : Json, key : String) -> String

The string value of key in a JSON object, or "".

Source Files

Site source Report issue Packages Build queue Skills Statistics

#ConsulHttp

#ConsulError

#ConsulClient

#ConsulClient::agent_services

#ConsulClient::check_pass

#ConsulClient::deregister_service

#ConsulClient::health_service

#ConsulClient::new

#ConsulClient::register_service

#ConsulDiscovery

#ConsulDiscovery::deregister

#ConsulDiscovery::deregister_instance

#ConsulDiscovery::keepalive

#ConsulDiscovery::new

#ConsulDiscovery::register

#ConsulDiscovery::resolve

#ConsulDiscovery::resolver

#ConsulResponse

#ConsulResponse::body

#ConsulResponse::new

#ConsulResponse::status

#consul_check_id

#consul_int_field

#consul_parse_health

#consul_register_body

#consul_str_field

Source Files

ConsulHttp

ConsulError

ConsulClient

ConsulClient::agent_services

ConsulClient::check_pass

ConsulClient::deregister_service

ConsulClient::health_service

ConsulClient::new

ConsulClient::register_service

ConsulDiscovery

ConsulDiscovery::deregister

ConsulDiscovery::deregister_instance

ConsulDiscovery::keepalive

ConsulDiscovery::new

ConsulDiscovery::register

ConsulDiscovery::resolve

ConsulDiscovery::resolver

ConsulResponse

ConsulResponse::body

ConsulResponse::new

ConsulResponse::status

consul_check_id

consul_int_field

consul_parse_health

consul_register_body

consul_str_field