# Kaper

[![Build Status](https://travis-ci.org/muxinc/kaper.svg?branch=master)](https://travis-ci.org/muxinc/kaper) [![Coverage Status](https://coveralls.io/repos/github/muxinc/kaper/badge.svg?branch=master)](https://coveralls.io/github/muxinc/kaper?branch=master) [![License](https://img.shields.io/badge/license-Apache_2.0-brightgreen.svg)](https://opensource.org/licenses/apache-2.0)

Elixir client for the [Kapacitor](https://influxdata.com/time-series-platform/kapacitor/) REST API.

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:

  1. Add kaper to your list of dependencies in `mix.exs`:

        def deps do
          [{:kaper, "~> 0.0.5"}]
        end

  2. Ensure kaper is started before your application:

        def application do
          [applications: [:kaper]]
        end


## Configuration
| Key  | Required? | Example  |  Description |
|---|---|---|---|
| url  | Yes | http://0.0.0.0:9092  |  URL of Kapacitor endpoint |
| basic_auth_username  | No | kapacitor_user  |  Basic HTTP authentication username |
| basic_auth_password  | No | password  |  Basic HTTP authentication password |


## Example

```elixir
  defmodule KapClient do
    use Kaper.Client, url: "http://0.0.0.0:9092"
  end

  defmodule BasicAuthKapClient do
    use Kaper.Client, url: "http://0.0.0.0:9092", basic_auth_username: "admin", basic_auth_password: "password"
  end
```