everylog_elixir_client

EveryLog provides a simple way to receive notifications for important application events that you choose.

Installation

The distribution is hosted on a public repository like GitHub or GitLab, or on a package repository like hex at: '#'. You can directly install the package by adding everylog_elixir_client to your list of dependencies in mix.exs:

def deps do
  [
    {:everylog_elixir_client, "~> 0.1.0"}
  ]
end

$ mix deps.get

Usage

Setup

This is to be set once globally (instantiated) from within the project, and used everywhere else

defmodule ModuleName do   # Make sure to replace 'ModuleName' by the name of your module
  import EverylogElixirClient

  # By calling start_link(), you start the EverylogElixirClient GenServer process, 
  # and then you can call other functions on it, such as set_variable and notify.
  # Make sure to start the GenServer process once and use its reference throughout your codebase,
  # rather than starting it multiple times.
  start_link()

  setup(%{"api_key" => "your_api_key", "projectId" => "you_project_id"});

  # Notifying the logs whenever you choose to.

  ### Uses the instantiated object from the class and notify by setting different options.

  # @param [Dictionary] notify_options
  # @option notify_options [String, options[:projectId]]  :projectId name of the project
  # @option notify_options [String]  :title to display in the application and if enabled in the notification
  # @option notify_options [String]  :summary is a not so long text to display on the application and if enabled in the notification
  # @option notify_options [String]  :body it can contain a long text simple formatted, no html to display in the application
  # @option notify_options [Array]   :tags it can be used to categorize the notification, must be strings
  # @option notify_options [String]  :link it can be used to display on the application and if enabled in the notification
  # @option notify_options [Boolean] :push if True, a push notification is sent to application
  # @option notify_options [String]  :icon
  # @option notify_options [Array]   :externaChannels
  # @option notify_options [Dictionary] :properties
  # @option notify_options [Array]   :groups

  # Use the notify() method to send a log message(N.B: the provided elements of the log message are samples)
  notify(
    %{
      "title" => "^^^^^^^^Test Title",
      "summary" => "Test Summary********",
      "body" => "Test Body------",
      "properties" => ["a"=> 123]
  }
  );
end

License

The package is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the EveryLog python client project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.