aws_ex_ray

v0.1.16

aws_ex_ray v0.1.16 AwsExRay.Segment

This module provides data structure which represents X-Ray's segment

Link to this section Summary

Types

t()

Functions

add_annotation(seg, key, value)
add_annotations(seg, annotations)
finish(seg)
finished?(seg)
generate_trace_value(seg)
new(trace, name)
sampled?(seg)
set_error(seg, error)
set_http_request(seg, req)
set_http_response(seg, res)
to_json(seg)

Link to this section Types

Link to this type

t() 
t() :: %AwsExRay.Segment{
  annotation: map(),
  end_time: float(),
  error: map() | nil,
  http: map(),
  id: String.t(),
  metadata: map(),
  name: String.t(),
  start_time: float(),
  trace: AwsExRay.Trace.t(),
  version: String.t()
}

Link to this section Functions

Link to this function

add_annotation(seg, key, value) 
add_annotation(seg :: t(), key :: atom() | String.t(), value :: any()) ::
  t()

Link to this function

add_annotations(seg, annotations) 
add_annotations(seg :: t(), annotations :: map()) :: t()

Link to this function

finish(seg) 
finish(seg :: t()) :: t()

Link to this function

finished?(seg) 
finished?(seg :: t()) :: boolean()

Link to this function

generate_trace_value(seg) 
generate_trace_value(seg :: t()) :: String.t()

Link to this function

new(trace, name) 
new(trace :: AwsExRay.Trace.t(), name :: String.t()) :: t()

Link to this function

sampled?(seg) 
sampled?(seg :: t()) :: boolean()

Link to this function

set_error(seg, error) 
set_error(seg :: t(), error :: AwsExRay.Record.Error.t()) :: t()

Link to this function

set_http_request(seg, req) 
set_http_request(seg :: t(), req :: AwsExRay.Record.HTTPRequest.t()) ::
  t()
set_http_request(seg :: t(), res :: AwsExRay.Record.HTTPResponse.t()) ::
  t()

Link to this function

set_http_response(seg, res)

Link to this function

to_json(seg) 
to_json(seg :: t()) :: String.t()