aws_ex_ray v0.1.16 AwsExRay.Subsegment

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

Link to this section Summary

Link to this section Types

Link to this type

namespace()
namespace() :: :none | :remote | :aws

Link to this type

t()
t() :: %AwsExRay.Subsegment{
  aws: map() | nil,
  namespace: namespace(),
  segment: AwsExRay.Segment.t(),
  sql: AwsExRay.Record.SQL.t() | nil
}

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, end_time \\ Util.now())
finish(seg :: t(), end_time :: float()) :: 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

get_trace(seg)
get_trace(seg :: t()) :: AwsExRay.Trace.t()

Link to this function

id(seg)
id(seg :: t()) :: String.t()

Link to this function

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

Link to this function

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

Link to this function

set_aws(seg, params)
set_aws(seg :: t(), params :: map()) :: t()

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()

Link to this function

set_http_response(seg, res)
set_http_response(seg :: t(), res :: AwsExRay.Record.HTTPResponse.t()) ::
  t()

Link to this function

set_sql(seg, sql)
set_sql(seg :: t(), sql :: AwsExRay.Record.SQL.t()) :: t()

Link to this function

set_start_time(seg, start_time)
set_start_time(seg :: t(), start_time :: float()) :: t()

Link to this function

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