🛠️Adding Additional Measurements

You can add custom measurements using the start and stop methods. If not explicitly stopped, the event will be measured until the middleware receives the response.

Basic

ServerTiming::start('Running expensive task');
// Simulate a task
sleep(5);
ServerTiming::stop('Running expensive task');

Alternatively, set a known duration using the setDuration method (in milliseconds):

ServerTiming::setDuration('Running expensive task', 1200);

Or pass a callable for measurement:

ServerTiming::setDuration('Running expensive task', function() {
    sleep(5);
});

Adding Textual Information

You can add textual information to the Server-Timing header without specifying a duration.

ServerTiming::addMetric('User: '.$user->id);

Advance

Below is a comprehensive example demonstrating the usage of the Server Timing middleware, including adding custom measurements and textual information:

// In your controller or service
use CoreFoundation\Facades\ServerTiming;

class UserController extends BaseController
{
    public function __construct(
        protected UserService $userService,
        protected UserResource $userResource,
        protected UserCollection $userCollection
    ) {
    }

    public function index(Request $request): JsonResponse
    {
        try {
            // Your amazing code, something like this.
            $filterable = $request->query();
            ServerTiming::start('User Query');
            $users = $this->userService->index($filterable);
            // Stop measuring the task
            ServerTiming::stop('User Query');
            // Add textual information
            ServerTiming::addMetric('User Id: ' . auth()->user()->id);
        } catch (Exception $exception) {
            return $this->handleException($exception);
        }

        return $this->successResponse(
            message: $this->lang("fetch-success"),
            payload: $this->userCollection->collection($users)
        );
    }
}

Additional APM Features

While server timing is a significant component, our APM package includes other features designed to provide a holistic view of your application's performance.

By leveraging the APM features, you can gain valuable insights into your application's performance, enabling you to make informed optimizations and ensure a smooth user experience. The Server Timing headers provide a clear and detailed view of how long different parts of your request handling take, directly within your browser's developer tools. This makes it easier to identify performance bottlenecks and optimize your application's performance effectively.