Module: TingYun::Agent::CrossAppTracing

Extended by:
Instrumentation::Support::ExternalError
Defined in:
lib/ting_yun/agent/cross_app/cross_app_tracing.rb

Defined Under Namespace

Classes: Error

Constant Summary collapse

TY_ID_HEADER =

The cross app id header for “outgoing” calls

'X-Tingyun-Id'.freeze
TY_DATA_HEADER = 
'X-Tingyun-Tx-Data'.freeze

Class Method Summary collapse

Methods included from Instrumentation::Support::ExternalError

capture_exception, handle_error, set_attributes

Class Method Details

.add_transaction_trace_info(request, response, cross_app) ⇒ Object 



87
88
89
90
91
92
93
94
 
# File 'lib/ting_yun/agent/cross_app/cross_app_tracing.rb', line 87

def add_transaction_trace_info(request, response, cross_app)
  state = TingYun::Agent::TransactionState.tl_get
  ::TingYun::Agent::Collector::TransactionSampler.add_node_info(:uri => TingYun::Agent::HTTPClients::URIUtil.filter_uri(request.uri))
  if cross_app
    ::TingYun::Agent::Collector::TransactionSampler.tl_builder.set_txId_and_txData(state.client_transaction_id || state.request_guid,
                                                                                   TingYun::Support::Serialize::JSONWrapper.load(get_ty_data_header(response).gsub("'",'"')))
  end
end

.cross_app_enabled? ⇒ Boolean 



133
134
135
136
137
 
# File 'lib/ting_yun/agent/cross_app/cross_app_tracing.rb', line 133

def cross_app_enabled?
  TingYun::Agent.config[:tingyunIdSecret] && TingYun::Agent.config[:tingyunIdSecret].size > 0 &&
      TingYun::Agent.config[:'nbs.action_tracer.enabled'] &&
      TingYun::Agent.config[:'nbs.transaction_tracer.enabled']
end

.finish_trace(state, t0, node, request, response) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/ting_yun/agent/cross_app/cross_app_tracing.rb', line 56

def finish_trace(state, t0, node, request, response)
  t1 = Time.now.to_f
  duration = (t1- t0) * 1000
  state.timings.external_duration = duration

  begin
    if request
      cross_app = response_is_cross_app?(response)

      metrics = metrics_for(request, response, cross_app)
      node_name = metrics.pop
      scoped_metric = metrics.pop

      ::TingYun::Agent.instance.stats_engine.record_scoped_and_unscoped_metrics(state, scoped_metric, metrics, duration)

      if node
        node.name = node_name
        add_transaction_trace_info(request, response, cross_app)
      end
    end
  rescue => err
    TingYun::Agent.logger.error "Uncaught exception while finishing an HTTP request trace", err
  ensure
    if node
      stack = state.traced_method_stack
      stack.pop_frame(state, node, node_name, t1)
    end
  end
end

.get_ty_data_header(response) ⇒ Object 



168
169
170
171
172
173
174
 
# File 'lib/ting_yun/agent/cross_app/cross_app_tracing.rb', line 168

def get_ty_data_header(response)
  if defined?(::HTTP) && defined?(::HTTP::Message) && response.class == ::HTTP::Message
    response.header[TY_DATA_HEADER].first rescue nil
  else
    response[TY_DATA_HEADER] rescue nil
  end
end

.inject_request_headers(state, request) ⇒ Object

Inject the X-Process header into the outgoing request.



140
141
142
143
144
 
# File 'lib/ting_yun/agent/cross_app/cross_app_tracing.rb', line 140

def inject_request_headers(state, request)
  cross_app_id  = TingYun::Agent.config[:tingyunIdSecret]

  request[TY_ID_HEADER] = "#{cross_app_id};c=1;x=#{state.request_guid}"
end

.metrics_for(request, response, cross_app) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/ting_yun/agent/cross_app/cross_app_tracing.rb', line 97

def metrics_for(request, response, cross_app)

  metrics = [ "External/NULL/ALL" ]

  if TingYun::Agent::Transaction.recording_web_transaction?
    metrics << "External/NULL/AllWeb"
  else
    metrics << "External/NULL/AllBackground"
  end

  if cross_app
    begin
      metrics.concat metrics_for_cross_app_response( request, response )
    rescue => err
      # Fall back to regular metrics if there's a problem with x-process metrics
      TingYun::Agent.logger.debug "%p while fetching x-process metrics: %s" %
                                      [ err.class, err.message ]
      metrics.concat metrics_for_regular_request( request )
    end
  else
    metrics.concat metrics_for_regular_request( request )
  end

  return metrics
end

.metrics_for_cross_app_response(request, response) ⇒ Object

Return the set of metric objects appropriate for the given cross app response.



158
159
160
161
162
163
164
165
166
 
# File 'lib/ting_yun/agent/cross_app/cross_app_tracing.rb', line 158

def metrics_for_cross_app_response(request, response )
  my_data =  TingYun::Support::Serialize::JSONWrapper.load get_ty_data_header(response).gsub("'",'"')
  uri = "#{request.uri.to_s.gsub(/\/\z/,'').gsub('/','%2F')}/#{request.from}"
  metrics = []
  metrics << "cross_app;#{my_data["id"]};#{my_data["action"]};#{uri}"
  metrics << "External/#{my_data["action"]}:#{uri}"

  return metrics
end

.metrics_for_regular_request(request) ⇒ Object 



124
125
126
127
128
129
130
 
# File 'lib/ting_yun/agent/cross_app/cross_app_tracing.rb', line 124

def metrics_for_regular_request( request )
  metrics = []
  metrics << "External/#{request.uri.to_s.gsub(/\/\z/,'').gsub('/','%2F')}/#{request.from}"
  metrics << "External/#{request.uri.to_s.gsub(/\/\z/,'').gsub('/','%2F')}/#{request.from}"

  return metrics
end

.response_is_cross_app?(response) ⇒ Boolean

Returns true if Cross Application Tracing is enabled, and the given response has the appropriate headers.



148
149
150
151
152
153
154
 
# File 'lib/ting_yun/agent/cross_app/cross_app_tracing.rb', line 148

def response_is_cross_app?( response )
  return false unless response
  return false unless cross_app_enabled?
  return false unless get_ty_data_header(response)

  return true
end

.start_trace(state, t0, request) ⇒ Object 



48
49
50
51
52
53
54
 
# File 'lib/ting_yun/agent/cross_app/cross_app_tracing.rb', line 48

def start_trace(state, t0, request)
  inject_request_headers(state, request) if cross_app_enabled?
  stack = state.traced_method_stack
  node = stack.push_frame(state, :http_request, t0)

  return node
end

.tl_trace_http_request(request) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/ting_yun/agent/cross_app/cross_app_tracing.rb', line 29

def tl_trace_http_request(request)
  state = TingYun::Agent::TransactionState.tl_get
  return yield unless state.execution_traced?
  return yield unless state.current_transaction #如果还没有创建Transaction，就发生跨应用，就直接先跳过跟踪。

  t0 = Time.now.to_f
  begin
    node = start_trace(state, t0, request)
    response = yield
    capture_exception(response, request)
  rescue => e
    klass = "External/#{request.uri.to_s.gsub(/\/\z/,'').gsub('/','%2F')}/#{request.from}"
    handle_error(e, klass)
  ensure
    finish_trace(state, t0, node, request, response)
  end
  return response
end