ExInsights

View Source ExInsights.Envelope (ExInsights v0.8.1)

Track request envelope

Envelope data looks like this

{
  "time": "2017-08-24T08:55:56.968Z",
  "iKey": "some-guid-value-key",
  "name": "Microsoft.ApplicationInsights.someguidvaluekey.Event",
  "tags": {
    "ai.session.id": "SLzGH",
    "ai.device.id": "browser",
    "ai.device.type": "Browser",
    "ai.internal.sdkVersion": "javascript:1.0.11",
    "ai.user.id": "V2Yph",
    "ai.operation.id": "VKgP+",
    "ai.operation.name": "/"
  },
  "data": {
    "baseType": "EventData",
    "baseData": {
      "ver": 2,
      "name": "button clicked",
      "properties": {
        "click type": "double click"
      },
      "measurements": {
        "clicks": 2
      }
    }
  }
}

Link to this section Summary

Types

missing_key()
t()
telemetry()

Functions

default_tags()
instrumentation_key_set?(envelope)
set_instrumentation_key(envelope, instrumentation_key)
wrap(telemetry, instrumentation_key)

Link to this section Types

Link to this type

missing_key()

View Source 
@type missing_key() :: {:error, :missing_instrumentation_key}
Link to this type

t()

View Source 
@type t() :: %ExInsights.Envelope{
  data: map(),
  iKey: String.t() | missing_key(),
  name: String.t(),
  tags: ExInsights.Telemetry.Types.tags(),
  time: String.t()
}
Link to this type

telemetry()

View Source 
@type telemetry() ::
  ExInsights.Telemetry.EventTelemetry.t()
  | ExInsights.Telemetry.TraceTelemetry.t()
  | ExInsights.Telemetry.ExceptionTelemetry.t()
  | ExInsights.Telemetry.RequestTelemetry.t()
  | ExInsights.Telemetry.DependencyTelemetry.t()
  | ExInsights.Telemetry.MetricTelemetry.t()

Link to this section Functions

Link to this function

default_tags()

View Source 
@spec default_tags() :: %{optional(String.t()) => String.t()}
Link to this function

instrumentation_key_set?(envelope)

View Source 
@spec instrumentation_key_set?(t()) :: boolean()
Link to this function

set_instrumentation_key(envelope, instrumentation_key)

View Source 
@spec set_instrumentation_key(t(), ExInsights.Telemetry.Types.instrumentation_key()) ::
  t()
Link to this function

wrap(telemetry, instrumentation_key)

View Source 
@spec wrap(
  telemetry :: telemetry(),
  ExInsights.Telemetry.Types.instrumentation_key() | nil
) :: t()