kanti/server-timing

Show timings of Database and HTTP Calls (send them to Sentry)

Installs: 11 575

Dependents: 0

Suggesters: 0

Security: 0

Stars: 9

Watchers: 2

Forks: 0

Open Issues: 2

Type:typo3-cms-extension

1.9.1 2024-03-07 09:22 UTC

README

Server-Timing

installation

composer require kanti/server-timing

at the moment there is nothing to configure

Server timings are not displayed in production for users who are not logged into the backend.

Included measurements:

  • php: from start of php call to the register shutdown function
  • console.command: from start of the console command call
  • middleware.in: will show how much time was spend in a middleware to prepare the Request
  • middleware.out: will show how much time was spend in a middleware to change the Response
  • db: shows the sql query's
  • mail: shows the mails that are send (only TYPO3 >=12)
  • dataP: Shows the DataProcessors that were executed
  • extbase: show all Extbase dispatches, (forwards are included in the original action call)
  • fileProcessing: show all file processing calls
  • http.client: external API calls are measured if they use the official TYPO3 RequestFactory or the GuzzleClientFactory)

if a measurement key has more than 4 entries, they will get combined into one total time with a count. And the 3 longest entries will be kept

Sentry Tracing

if you have sentry enabled (different Extension eg. pluswerk/sentry or networkteam/sentry-client) than you can activate the tracing.

  • sentry_sample_rate
    • if empty it will keep the setting that was set from the sentry extension.
    • if set to a number like 0.1 it will track 10% of all Requests in sentry.
  • sentry_cli_sample_rate
    • just like sentry_sample_rate but this setting is for the cli calls of the typo3 binary
  • stop_watch_limit is set for long-running processes, if you get memory problems you can lower this setting. (default: 100_000)
  • you can force the Tracing of Requests by adding the Cookie XDEBUG_TRACE with any value.
    Tracing

Measure your own timings:

stopWatch function (recommended)

  $stop = \Kanti\ServerTiming\Utility\TimingUtility::stopWatch('doSomething', 'additional Information');
  $result = $this->doSomethingExpensive();
  $stop();

start & stop functions

this has some limitations, there can only be one doSomething at a time.

  \Kanti\ServerTiming\Utility\TimingUtility::start('doSomething', 'additional Information');
  $result = $this->doSomethingExpensive();
  \Kanti\ServerTiming\Utility\TimingUtility::end('doSomething');

TODO List:

todos:

  • more tests

composer patches needed?

  • fluid renderings (possible solution with XClasses?)

wanted:

  • functional tests

nice to have?

  • ViewHelpers