Skip to content

Latest commit

 

History

History
85 lines (63 loc) · 2.57 KB

README.md

File metadata and controls

85 lines (63 loc) · 2.57 KB
Raw

Consul

Yet another Consul Client written in Elixir, this time on top of Tesla.

At the time of writing, it doesn't support all APIs, just KV/Catalog/Health and read-only APIs. On the other hand, it implements a Tesla.Middleware.ConsulWatch to ease doing blocking queries to Consul.

Installation

The package can be installed by adding consulex to your list of dependencies in mix.exs:

def deps do
  [
    {:consulex, "~> 0.2"}
  ]
end

And then you need to pass which JSON interpreter you'll use. If that's Jason, then do:

# config/config.exs
config :consulex, json_codec: Jason

You can use Poison instead, by just substituting Jason by Poison in the above configuration. Other libraries might need a custom Consul.JsonCodec behaviour implementation.

Documentation is generated with ExDoc and published on HexDocs. Docs can be found at https://hexdocs.pm/consulex.

How to use

For simple polling requests, just create a Consul connection and pass it to a Consul.Api module:

connection = Consul.Connection.new("http://consul:8500")
Consul.Api.V1.Health.list_nodes(connection, "my_service", passing: true)

Blocking queries

This feature is supported only by selected endpoints. Check Consul documentation for more information.

In order to make blocking queries, use the option :wait:

connection = Consul.Connection.new("http://consul:8500", wait: 60_000)
Consul.Api.V1.Health.list_nodes(connection, "my_service")

In this case, the first execution will return immediately, while the next ones will wait up to 60 seconds to finalize. The time passed in the :wait argument is in milliseconds. Alternatively wait: true can be passed to use Consul's default value for that parameter (5 minutes).

Sometimes you may need to make a non-blocking query using a client that was configured with wait. It can be done by specifying index: nil option in the request.

Consul.Api.V1.Health.list_nodes(connection, "my_service", index: nil)

Read YAML values from Consul KV

By default, Consulex will attempt to decode Consul KV values as JSON (using the JsonCodec of your choice). If you have YAML values, add an YAML decoder that implements the Consul.YamlCodec behaviour. YamlElixir is supported out of the box by setting it in your config:

# config/config.exs
config :consulex, yaml_codec: YamlElixir