API Overview

The PHP extension comes with the following APIs:

  • Tideways\Profiler Static class, no instance can be created.

    • Tideways\Profiler::addEventMarker - Mark current time in timeline with a marker

    • Tideways\Profiler::containsDeveloperTraceRequest - Is a cookie, header or query string set that will elevate the profiler to developer callgraph mode when valid?

    • Tideways\Profiler::createSpan - Create custom spans in Timeline

    • Tideways\Profiler::currentTraceId - If Tideways is enabled return the trace Id of current request.

    • Tideways\Profiler::detectTransactionFunction -

    • Tideways\Profiler::detectExceptionFunction -

    • Tideways\Profiler::disableCallgraphProfiler - Disable Callgraph Profiler if running

    • Tideways\Profiler::disableTracingProfiler - Disable Timeline Profiler if running

    • Tideways\Profiler::enableCallgraphProfiler - Enable the Callgraph Profiler for this request

    • Tideways\Profiler::enableTracingProfiler - Enable the Timeline Profiler for this request when its only running in monitorig mode.

    • Tideways\Profiler::generateServerTimingHeaderValue - Get headers used for Server Timing in HTTP Response

    • Tideways\Profiler::generateDistributedTracingHeaders - Get headers used for distributed tracing passable to an external service.

    • Tideways\Profiler::generateReferencedTracesHeaders - Get headers to reference the current request, passable to another request.

    • Tideways\Profiler::getLayerMetrics - Access to metrics about the layer performance in a request.

    • Tideways\Profiler::getTransactionName - Return the current transaction name that was matched by Tideways or by setTransactionName.

    • Tideways\Profiler::isStarted - Does the profiler currently run and collect data?

    • Tideways\Profiler::isTracing - Is the profiler currently running in tracing mode?

    • Tideways\Profiler::isProfiling - Is the profiler currently running in callgraph profiling mode?

    • Tideways\Profiler::logFatal - Mark the request as failed based on an error that occurred.

    • Tideways\Profiler::logException - Mark the request as failed based on the given exception.

    • Tideways\Profiler::markAsWebTransaction - Mark the request as web-based, if it is serving web requests in the CLI due to its runtime (Roadrunner, Swoole, Octane, ..)

    • Tideways\Profiler::markAsCliTransaction - Mark the request as cli-based, if it is serving long-running CLI-like requests in the web (e.g. AJAX cronjobs)

    • Tideways\Profiler::markPageCacheHit - For Page Cache Hit ratio mark current request as HIT.

    • Tideways\Profiler::markPageCacheMiss - For Page Cache Hit ratio mark current request as MISS.

    • Tideways\Profiler::setCustomVariable - Set a key value pair variable onto the root span of the trace, viewable from UI.

    • Tideways\Profiler::setServiceName - Set the service name the request is served by.

    • Tideways\Profiler::setTransactionName - Set the transaction name the request is running in.

    • Tideways\Profiler::setTags - For Custom Tags for Tagged Transactions

    • Tideways\Profiler::start - Start the Profiler

    • Tideways\Profiler::stop - Stop the Profiler

    • Tideways\Profiler::triggerCallgraphOn -

    • Tideways\Profiler::watch -

    • Tideways\Profiler::watchCallback -

  • Tideways\Profiler\Span - represents a custom span

    • Tideways\Profiler\Span::annotate -

    • Tideways\Profiler\Span::finish -

    • Tideways\Profiler\Span::getId -

    • Tideways\Profiler\Span::logException -

Still need help? Email [email protected]