Skip to content

lexmag/fluxter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Fluxter

CI Status Hex Version

Fluxter is an InfluxDB writer for Elixir. It uses the InfluxDB line protocol over UDP.

Installation

Add Fluxter as a dependency to your mix.exs file:

defp deps() do
  [{:fluxter, "~> 0.8"}]
end

Then run mix deps.get in your shell to fetch the dependencies.

Usage

See the documentation for detailed usage information.

A module that uses Fluxter becomes an InfluxDB connection pool:

defmodule MyApp.Fluxter do
  use Fluxter
end

Each Fluxter pool provides a start_link/1 function that starts the pool and connects to InfluxDB; this function needs to be invoked before the pool can be used. Typically, you won't call start_link/1 directly as you'll want to add a Fluxter pool to your application's supervision tree. For this use case, pools provide a child_spec/1 function:

def start(_type, _args) do
  children = [
    MyApp.Fluxter,
    #...
  ]
  Supervisor.start_link(children, strategy: :one_for_one)
end

Once the Fluxter pool is started, its write/2,3, measure/2,3,4, and other functions can successfully be used to send points to the data store.

License

This software is licensed under the ISC license.