Class: NewRelic::Agent::Transaction::ExternalRequestSegment
- Inherits:
-
Segment
- Object
- Segment
- NewRelic::Agent::Transaction::ExternalRequestSegment
- Defined in:
- lib/new_relic/agent/transaction/external_request_segment.rb
Overview
This class represents an external segment in a transaction trace.
Instance Method Summary collapse
-
#add_request_headers(request) ⇒ Object
This method adds New Relic request headers to a given request made to an external API and checks to see if a host header is used for the request.
-
#get_request_metadata ⇒ String
Obtain an obfuscated
String
suitable for delivery across public networks that identifies this application and transaction to another application which is also running a New Relic agent. -
#process_response_metadata(response_metadata) ⇒ Object
Process obfuscated
String
sent from a called application that is also running a New Relic agent and save information in current transaction for inclusion in a trace. -
#read_response_headers(response) ⇒ Object
This method extracts app data from an external response if present.
Instance Method Details
#add_request_headers(request) ⇒ Object
This method adds New Relic request headers to a given request made to an external API and checks to see if a host header is used for the request. If a host header is used, it updates the segment name to match the host header.
object (must belong to a subclass of NewRelic::Agent::HTTPClients::AbstractRequest)
64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/new_relic/agent/transaction/external_request_segment.rb', line 64 def add_request_headers(request) process_host_header(request) synthetics_header = transaction&.raw_synthetics_header synthetics_info_header = transaction&.raw_synthetics_info_header insert_synthetics_header(request, synthetics_header, synthetics_info_header) if synthetics_header return unless record_metrics? transaction.distributed_tracer.insert_headers(request) rescue => e NewRelic::Agent.logger.error('Error in add_request_headers', e) end |
#get_request_metadata ⇒ String
Obtain an obfuscated String
suitable for delivery across public networks that identifies this application and transaction to another application which is also running a New Relic agent. This String
can be processed by process_request_metadata
on the receiving application.
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/new_relic/agent/transaction/external_request_segment.rb', line 127 def NewRelic::Agent.record_api_supportability_metric(:get_request_metadata) return unless CrossAppTracing.cross_app_enabled? if transaction # build hash of CAT metadata # rmd = { NewRelicID: NewRelic::Agent.config[:cross_process_id], NewRelicTransaction: [ transaction.guid, false, transaction.distributed_tracer.cat_trip_id, transaction.distributed_tracer.cat_path_hash ] } # flag cross app in the state so transaction knows to add bits to payload # transaction.distributed_tracer.is_cross_app_caller = true # add Synthetics header if we have it # rmd[:NewRelicSynthetics] = transaction.raw_synthetics_header if transaction.raw_synthetics_header # obfuscate the generated request metadata JSON # obfuscator.obfuscate(::JSON.dump(rmd)) end rescue => e NewRelic::Agent.logger.error('error during get_request_metadata', e) end |
#process_response_metadata(response_metadata) ⇒ Object
Process obfuscated String
sent from a called application that is also running a New Relic agent and save information in current transaction for inclusion in a trace. This String
is generated by get_response_metadata
on the receiving application.
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
# File 'lib/new_relic/agent/transaction/external_request_segment.rb', line 170 def () NewRelic::Agent.record_api_supportability_metric(:process_response_metadata) if transaction app_data = ::JSON.parse(obfuscator.deobfuscate())[APP_DATA_KEY] # validate cross app id # if Array === app_data and CrossAppTracing.trusted_valid_cross_app_id?(app_data[0]) @app_data = app_data update_segment_name else NewRelic::Agent.logger.error('error processing response metadata: invalid/non-trusted ID') end end nil rescue => e NewRelic::Agent.logger.error('error during process_response_metadata', e) end |
#read_response_headers(response) ⇒ Object
This method extracts app data from an external response if present. If a valid cross-app ID is found, the name of the segment is updated to reflect the cross-process ID and transaction name.
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/new_relic/agent/transaction/external_request_segment.rb', line 84 def read_response_headers(response) return unless record_metrics? && CrossAppTracing.cross_app_enabled? return unless CrossAppTracing.response_has_crossapp_header?(response) unless data = CrossAppTracing.extract_appdata(response) NewRelic::Agent.logger.debug("Couldn't extract_appdata from external segment response") return end if CrossAppTracing.valid_cross_app_id?(data[0]) @app_data = data update_segment_name else NewRelic::Agent.logger.debug('External segment response has invalid cross_app_id') end rescue => e NewRelic::Agent.logger.error('Error in read_response_headers', e) end |