@spec track_dependency(
  name :: ExInsights.Telemetry.Types.name(),
  data :: String.t(),
  start_time :: DateTime.t(),
  ExInsights.Telemetry.Types.millisecond(),
  boolean(),
  String.t(),
  String.t() | nil,
  properties :: ExInsights.Telemetry.Types.properties(),
  id :: binary() | nil,
  tags :: ExInsights.Telemetry.Types.tags(),
  instrumentation_key :: instrumentation_key()
) :: :ok

Log a dependency, for example requests to an external service or SQL calls.

name: String that identifies the dependency.

data: String of the name of the command made against the dependency (eg. full URL with querystring or SQL command text).

start_time: The datetime when the dependency call was initiated.

duration: Remote call duration in ms (non-neg integer)

success?: True if remote call was successful, false otherwise (boolean).

dependency_type_name: Type name of the telemetry, such as HTTP or SQL (string).

target: String of the target host of the dependency.

properties (optional): map[string, string] - additional data used to filter events and metrics in the portal. Defaults to empty.

id (optional): a unique identifier representing the dependency call.

tags (optional): map[string, string] - additional application insights tag metadata.

instrumentation_key (optional): Azure application insights API key. If not set it will the default one provided to the ExInsights.Worker will be used (see README.md)

@spec track_event(
  name :: ExInsights.Telemetry.Types.name(),
  properties :: ExInsights.Telemetry.Types.properties(),
  measurements :: ExInsights.Telemetry.Types.measurements(),
  tags :: ExInsights.Telemetry.Types.tags(),
  instrumentation_key :: instrumentation_key()
) :: :ok

Log a user action or other occurrence.

name: name of the event (string or atom)

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

tags (optional): map[string, string] - additional application insights tag metadata.

instrumentation_key (optional): Azure application insights API key. If not set it will the default one provided to the ExInsights.Worker will be used (see README.md)

@spec track_exception(
  Exception.t() | String.t(),
  stack_trace :: Exception.stacktrace(),
  String.t() | nil,
  properties :: ExInsights.Telemetry.Types.properties(),
  measurements :: ExInsights.Telemetry.Types.measurements(),
  tags :: ExInsights.Telemetry.Types.tags(),
  instrumentation_key :: instrumentation_key()
) :: :ok

Log an exception you have caught.

exception: An Error from a catch clause, or the string error message.

stack_trace: An erlang stacktrace.

properties: map[string, string] - additional data used to filter events and metrics in the portal. Defaults to empty.

measurements: map[string, number] - metrics associated with this event, displayed in Metrics Explorer on the portal. Defaults to empty.

tags (optional): map[string, string] - additional application insights tag metadata.

instrumentation_key (optional): Azure application insights API key. If not set it will the default one provided to the ExInsights.Worker will be used (see README.md)

@spec track_metric(
  name :: ExInsights.Telemetry.Types.name(),
  value :: number(),
  properties :: ExInsights.Telemetry.Types.properties(),
  tags :: ExInsights.Telemetry.Types.tags(),
  instrumentation_key :: instrumentation_key()
) :: :ok

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

Typically used to send regular reports of performance indicators.

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

tags (optional): map[string, string] - additional application insights tag metadata.

instrumentation_key (optional): Azure application insights API key. If not set it will the default one provided to the ExInsights.Worker will be used (see README.md)

@spec track_request(
  name :: ExInsights.Telemetry.Types.name(),
  url :: String.t(),
  source :: String.t() | nil,
  start_time :: DateTime.t(),
  elapsed_time_ms :: ExInsights.Telemetry.Types.millisecond(),
  response_code :: String.t() | number(),
  success? :: boolean(),
  properties :: ExInsights.Telemetry.Types.properties(),
  measurements :: ExInsights.Telemetry.Types.measurements(),
  id :: binary() | nil,
  tags :: ExInsights.Telemetry.Types.tags(),
  instrumentation_key :: instrumentation_key()
) :: :ok

Log an incoming request, for example incoming HTTP requests

name: String that identifies the request

url: Request URL

source: Request Source. Encapsulates info about the component that initiated the request (can be nil)

start_time: The datetime when the request was initiated.

elapsed_time_ms: Number for elapsed time in milliseconds

response_code: Result code reported by the application

success?: whether the request was successfull

properties (optional): map[string, string] - additional data used to filter events and metrics in the portal. Defaults to empty.

measurements (optional): a map of [string -> number] values associated with this event that can be aggregated/sumed/etc. on the UI

id (optional): a unique identifier representing the request.

tags (optional): map[string, string] - additional application insights tag metadata.

instrumentation_key (optional): Azure application insights API key. If not set it will the default one provided to the ExInsights.Worker will be used (see README.md)

@spec track_trace(
  String.t(),
  severity_level :: ExInsights.Telemetry.Types.severity_level(),
  properties :: ExInsights.Telemetry.Types.properties(),
  tags :: ExInsights.Telemetry.Types.tags(),
  instrumentation_key :: instrumentation_key()
) :: :ok

Log a trace message.

message: A string to identify this event in the portal.

severity_level: The level of severity for the event.

properties: map[string, string] - additional data used to filter events and metrics in the portal. Defaults to empty.

tags (optional): map[string, string] - additional application insights tag metadata.

instrumentation_key (optional): Azure application insights API key. If not set it will the default one provided to the ExInsights.Worker will be used (see README.md)