ex_insights v0.1.1 ExInsights

Exposes methods for POSTing events & metrics to Azure Application Insights

Link to this section Summary

Types

A map of [name -> string] to add measurement data to a tracking request

Measurement name. Will be used extensively in the app insights UI

A map of [name -> string] to add metadata to a tracking request

Functions

Log a user action or other occurrence

Log a numeric value that is not associated with a specific event

Link to this section Types

Link to this type measurements()
measurements() :: %{optional(name) => number}

A map of [name -> string] to add measurement data to a tracking request

Link to this type name()
name() :: String.t | atom

Measurement name. Will be used extensively in the app insights UI

Link to this type properties()
properties() :: %{optional(name) => String.t}

A map of [name -> string] to add metadata to a tracking request

Link to this section Functions

Link to this function track_event(name, properties \\ %{}, measurements \\ %{})
track_event(name, properties, measurements) :: :ok

Log a user action or other occurrence.

Parameters:

name: name of the event (string)
properties (optional): a map of [string -> string] pairs for adding extra properties to this event
measurements (optional): a map of [string -> number] values associated with this event that can be aggregated/sumed/etc. on the UI
Link to this function track_metric(name, value, properties \\ %{})
track_metric(name, number, properties) :: :ok

Log a numeric value that is not associated with a specific event.

Typically used to send regular reports of performance indicators.

Parameters

name: name of the metric
value: the value of the metric (number)
properties (optional): a map of [string -> string] pairs for adding extra properties to this event