File size: 12,147 Bytes
065fee7 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 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 85 86 87 88 89 90 91 92 93 94 95 96 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 122 123 124 125 126 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 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 |
.. _aiohttp-client-tracing-reference:
Tracing Reference
=================
.. currentmodule:: aiohttp
.. versionadded:: 3.0
A reference for client tracing API.
.. seealso:: :ref:`aiohttp-client-tracing` for tracing usage instructions.
Request life cycle
------------------
A request goes through the following stages and corresponding fallbacks.
Overview
^^^^^^^^
.. blockdiag::
:desctable:
blockdiag {
orientation = portrait;
start[shape=beginpoint, description="on_request_start"];
redirect[description="on_request_redirect"];
end[shape=endpoint, description="on_request_end"];
exception[shape=flowchart.terminator, description="on_request_exception"];
acquire_connection[description="Connection acquiring"];
headers_received;
headers_sent[description="on_request_headers_sent"];
chunk_sent[description="on_request_chunk_sent"];
chunk_received[description="on_response_chunk_received"];
start -> acquire_connection;
acquire_connection -> headers_sent;
headers_sent -> headers_received;
headers_sent -> chunk_sent;
chunk_sent -> chunk_sent;
chunk_sent -> headers_received;
headers_received -> chunk_received;
chunk_received -> chunk_received;
chunk_received -> end;
headers_received -> redirect;
headers_received -> end;
redirect -> headers_sent;
chunk_received -> exception;
chunk_sent -> exception;
headers_sent -> exception;
}
Connection acquiring
^^^^^^^^^^^^^^^^^^^^
.. blockdiag::
:desctable:
blockdiag {
orientation = portrait;
begin[shape=beginpoint];
end[shape=endpoint];
exception[shape=flowchart.terminator, description="Exception raised"];
queued_start[description="on_connection_queued_start"];
queued_end[description="on_connection_queued_end"];
create_start[description="on_connection_create_start"];
create_end[description="on_connection_create_end"];
reuseconn[description="on_connection_reuseconn"];
resolve_dns[description="DNS resolving"];
sock_connect[description="Connection establishment"];
begin -> reuseconn;
begin -> create_start;
create_start -> resolve_dns;
resolve_dns -> exception;
resolve_dns -> sock_connect;
sock_connect -> exception;
sock_connect -> create_end -> end;
begin -> queued_start;
queued_start -> queued_end;
queued_end -> reuseconn;
queued_end -> create_start;
reuseconn -> end;
}
DNS resolving
^^^^^^^^^^^^^
.. blockdiag::
:desctable:
blockdiag {
orientation = portrait;
begin[shape=beginpoint];
end[shape=endpoint];
exception[shape=flowchart.terminator, description="Exception raised"];
resolve_start[description="on_dns_resolvehost_start"];
resolve_end[description="on_dns_resolvehost_end"];
cache_hit[description="on_dns_cache_hit"];
cache_miss[description="on_dns_cache_miss"];
begin -> cache_hit -> end;
begin -> cache_miss -> resolve_start;
resolve_start -> resolve_end -> end;
resolve_start -> exception;
}
Classes
-------
.. class:: TraceConfig(trace_config_ctx_factory=SimpleNamespace)
Trace config is the configuration object used to trace requests
launched by a :class:`ClientSession` object using different events
related to different parts of the request flow.
:param trace_config_ctx_factory: factory used to create trace contexts,
default class used :class:`types.SimpleNamespace`
.. method:: trace_config_ctx(trace_request_ctx=None)
:param trace_request_ctx: Will be used to pass as a kw for the
``trace_config_ctx_factory``.
Build a new trace context from the config.
Every signal handler should have the following signature::
async def on_signal(session, context, params): ...
where ``session`` is :class:`ClientSession` instance, ``context`` is an
object returned by :meth:`trace_config_ctx` call and ``params`` is a
data class with signal parameters. The type of ``params`` depends on
subscribed signal and described below.
.. attribute:: on_request_start
Property that gives access to the signals that will be executed
when a request starts.
``params`` is :class:`aiohttp.TraceRequestStartParams` instance.
.. attribute:: on_request_chunk_sent
Property that gives access to the signals that will be executed
when a chunk of request body is sent.
``params`` is :class:`aiohttp.TraceRequestChunkSentParams` instance.
.. versionadded:: 3.1
.. attribute:: on_response_chunk_received
Property that gives access to the signals that will be executed
when a chunk of response body is received.
``params`` is :class:`aiohttp.TraceResponseChunkReceivedParams` instance.
.. versionadded:: 3.1
.. attribute:: on_request_redirect
Property that gives access to the signals that will be executed when a
redirect happens during a request flow.
``params`` is :class:`aiohttp.TraceRequestRedirectParams` instance.
.. attribute:: on_request_end
Property that gives access to the signals that will be executed when a
request ends.
``params`` is :class:`aiohttp.TraceRequestEndParams` instance.
.. attribute:: on_request_exception
Property that gives access to the signals that will be executed when a
request finishes with an exception.
``params`` is :class:`aiohttp.TraceRequestExceptionParams` instance.
.. attribute:: on_connection_queued_start
Property that gives access to the signals that will be executed when a
request has been queued waiting for an available connection.
``params`` is :class:`aiohttp.TraceConnectionQueuedStartParams`
instance.
.. attribute:: on_connection_queued_end
Property that gives access to the signals that will be executed when a
request that was queued already has an available connection.
``params`` is :class:`aiohttp.TraceConnectionQueuedEndParams`
instance.
.. attribute:: on_connection_create_start
Property that gives access to the signals that will be executed when a
request creates a new connection.
``params`` is :class:`aiohttp.TraceConnectionCreateStartParams`
instance.
.. attribute:: on_connection_create_end
Property that gives access to the signals that will be executed when a
request that created a new connection finishes its creation.
``params`` is :class:`aiohttp.TraceConnectionCreateEndParams`
instance.
.. attribute:: on_connection_reuseconn
Property that gives access to the signals that will be executed when a
request reuses a connection.
``params`` is :class:`aiohttp.TraceConnectionReuseconnParams`
instance.
.. attribute:: on_dns_resolvehost_start
Property that gives access to the signals that will be executed when a
request starts to resolve the domain related with the request.
``params`` is :class:`aiohttp.TraceDnsResolveHostStartParams`
instance.
.. attribute:: on_dns_resolvehost_end
Property that gives access to the signals that will be executed when a
request finishes to resolve the domain related with the request.
``params`` is :class:`aiohttp.TraceDnsResolveHostEndParams` instance.
.. attribute:: on_dns_cache_hit
Property that gives access to the signals that will be executed when a
request was able to use a cached DNS resolution for the domain related
with the request.
``params`` is :class:`aiohttp.TraceDnsCacheHitParams` instance.
.. attribute:: on_dns_cache_miss
Property that gives access to the signals that will be executed when a
request was not able to use a cached DNS resolution for the domain related
with the request.
``params`` is :class:`aiohttp.TraceDnsCacheMissParams` instance.
.. attribute:: on_request_headers_sent
Property that gives access to the signals that will be executed
when request headers are sent.
``params`` is :class:`aiohttp.TraceRequestHeadersSentParams` instance.
.. versionadded:: 3.8
.. class:: TraceRequestStartParams
See :attr:`TraceConfig.on_request_start` for details.
.. attribute:: method
Method that will be used to make the request.
.. attribute:: url
URL that will be used for the request.
.. attribute:: headers
Headers that will be used for the request, can be mutated.
.. class:: TraceRequestChunkSentParams
.. versionadded:: 3.1
See :attr:`TraceConfig.on_request_chunk_sent` for details.
.. attribute:: method
Method that will be used to make the request.
.. attribute:: url
URL that will be used for the request.
.. attribute:: chunk
Bytes of chunk sent
.. class:: TraceResponseChunkReceivedParams
.. versionadded:: 3.1
See :attr:`TraceConfig.on_response_chunk_received` for details.
.. attribute:: method
Method that will be used to make the request.
.. attribute:: url
URL that will be used for the request.
.. attribute:: chunk
Bytes of chunk received
.. class:: TraceRequestEndParams
See :attr:`TraceConfig.on_request_end` for details.
.. attribute:: method
Method used to make the request.
.. attribute:: url
URL used for the request.
.. attribute:: headers
Headers used for the request.
.. attribute:: response
Response :class:`ClientResponse`.
.. class:: TraceRequestExceptionParams
See :attr:`TraceConfig.on_request_exception` for details.
.. attribute:: method
Method used to make the request.
.. attribute:: url
URL used for the request.
.. attribute:: headers
Headers used for the request.
.. attribute:: exception
Exception raised during the request.
.. class:: TraceRequestRedirectParams
See :attr:`TraceConfig.on_request_redirect` for details.
.. attribute:: method
Method used to get this redirect request.
.. attribute:: url
URL used for this redirect request.
.. attribute:: headers
Headers used for this redirect.
.. attribute:: response
Response :class:`ClientResponse` got from the redirect.
.. class:: TraceConnectionQueuedStartParams
See :attr:`TraceConfig.on_connection_queued_start` for details.
There are no attributes right now.
.. class:: TraceConnectionQueuedEndParams
See :attr:`TraceConfig.on_connection_queued_end` for details.
There are no attributes right now.
.. class:: TraceConnectionCreateStartParams
See :attr:`TraceConfig.on_connection_create_start` for details.
There are no attributes right now.
.. class:: TraceConnectionCreateEndParams
See :attr:`TraceConfig.on_connection_create_end` for details.
There are no attributes right now.
.. class:: TraceConnectionReuseconnParams
See :attr:`TraceConfig.on_connection_reuseconn` for details.
There are no attributes right now.
.. class:: TraceDnsResolveHostStartParams
See :attr:`TraceConfig.on_dns_resolvehost_start` for details.
.. attribute:: host
Host that will be resolved.
.. class:: TraceDnsResolveHostEndParams
See :attr:`TraceConfig.on_dns_resolvehost_end` for details.
.. attribute:: host
Host that has been resolved.
.. class:: TraceDnsCacheHitParams
See :attr:`TraceConfig.on_dns_cache_hit` for details.
.. attribute:: host
Host found in the cache.
.. class:: TraceDnsCacheMissParams
See :attr:`TraceConfig.on_dns_cache_miss` for details.
.. attribute:: host
Host didn't find the cache.
.. class:: TraceRequestHeadersSentParams
See :attr:`TraceConfig.on_request_headers_sent` for details.
.. versionadded:: 3.8
.. attribute:: method
Method that will be used to make the request.
.. attribute:: url
URL that will be used for the request.
.. attribute:: headers
Headers that will be used for the request.
|