Get a notification when your PHP code is done executing

These days we can use PHP for almost anything, be it a simple function, a complex algorithm, or anything that comes to mind. Usually, what we want PHP to do happens very quickly, and we don't even have to wait for it to finish.

Long-running PHP tasks are a problem

However, sometimes you are writing a PHP code, process, or job that may take a long time to run. For example, you may decide to crawl a website or run a long-running parsing algorithm.

I'm sure almost every developer has, at some point, written a PHP code that takes a long time to run. They then had to continuously check the task, wait for it to finish running, and ensure the PHP code was working as expected. As you can see, this gets tedious very quickly and wastes time and effort.

Push notifications fix this problem

One common way to solve this is to track the status of our PHP code and send a push notification when the code is done running or when it fails. By doing so, we can leave and forget about the long-running PHP code and focus on the important things we need to do, and by the time something happens, we will instantly get a push notification to let us know.

To do so, we can use LogSnag to track the status of our PHP code. LogSnag is a simple, easy-to-use, robust event tracking and notification system that lets you track your PHP code and send push notifications when something happens.

Let's walk you through setting up and using LogSnag to track the status of our PHP code.

Setting up LogSnag

Sign up for a free LogSnag account.
Create your first project from the dashboard.
Head to settings and copy your API token.

PHP code snippets

Now that we have our account and project setup, we can copy the following code snippet, update the values with your information, and paste it into your code.

Using PHP with cURL

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.logsnag.com/v1/log',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{"project":"my-project","channel":"crawler","event":"Crawling is complete","description":"Successfully crawled 1,230 pages.","icon":"🔥","notify":true}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer YOUR_API_TOKEN'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Using PHP with Guzzle

<?php
$client = new Client();
$headers = [
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer YOUR_API_TOKEN'
];
$body = '{
  "project": "my-project",
  "channel": "crawler",
  "event": "Crawling is complete",
  "description": "Successfully crawled 1,230 pages.",
  "icon": "🔥",
  "notify": true
}';
$request = new Request('POST', 'https://api.logsnag.com/v1/log', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

Using PHP with HTTP_Request2

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://api.logsnag.com/v1/log');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer YOUR_API_TOKEN'
));
$request->setBody('{"project":"my-project","channel":"crawler","event":"Crawling is complete","description":"Successfully crawled 1,230 pages.","icon":"🔥","notify":true}');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

Using PHP with pecl_http

<?php
$client = new http\Client;
$request = new http\Client\Request;
$request->setRequestUrl('https://api.logsnag.com/v1/log');
$request->setRequestMethod('POST');
$body = new http\Message\Body;
$body->append('{"project":"my-project","channel":"crawler","event":"Crawling is complete","description":"Successfully crawled 1,230 pages.","icon":"🔥","notify":true}');
$request->setBody($body);
$request->setOptions(array());
$request->setHeaders(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer YOUR_API_TOKEN'
));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();

PHP integration details

LogSnag provides several other features that can be used to simplify your job as a developer. For example, suppose you're working with a team. In that case, you can also add the rest of your team to your LogSnag project and allow them to see the status of your PHP code and receive push notifications when something important happens.

LogSang also keeps track of your previous events, so you can see what has happened in the past and search through previous events. We found this to be very powerful when we are working on larger projects and need to see what has happened in the past.

In addition, LogSnag allows you to create simple dashboards, charts, and graphs that give you more insight into your code and the events you track.

Other use-cases for LogSnag

View all common use-cases with PHP