ZF Zend Framework

Zend_Db_Profiler peut être activé pour permettre le profilage de requête. Les profils incluent les requêtes exécutées par l'adaptateur, ainsi que leur temps d'exécution, permettant l'inspection des requêtes qui ont été exécutées sans avoir besoin de rajouter le code spécifique de débogage aux classes. L'utilisation avancée permet aussi au développeur de filtrer quelles requêtes il souhaite profiler.

Le profileur s'active soit en passant une directive au constructeur de l'adaptateur, soit en spécifiant à l'adaptateur de l'activer plus tard.

$params = array(
    'host'     => '127.0.0.1',
    'username' => 'webuser',
    'password' => 'xxxxxxxx',
    'dbname'   => 'test',
    'profiler' => true  // active le profileur ; mettre à false pour désactiver (désactivé par défaut)
);

$db = Zend_Db::factory('PDO_MYSQL', $params);

// stoppe le profileur :
$db->getProfiler()->setEnabled(false);

// active le profileur :
$db->getProfiler()->setEnabled(true);

La valeur de l'option profiler est souple. Elle est interprétée différemment suivant son type. La plupart du temps, vous devriez simplement utiliser une variable booléenne, mais d'autres valeurs vous permettent de personnaliser le comportement du profileur.

Un argument booléen active le profileur si c'est une valeur true, ou le désactive si false. La classe de profileur est celle par défaut, par exemple Zend_Db_Profiler.

$params['profiler'] = true;
$db = Zend_Db::factory('PDO_MYSQL', $params);

Une instance d'un objet profileur fait que l'adaptateur utilise cet objet. L'objet doit être de type Zend_Db_Profiler ou une sous-classe. L'activation du profileur est faite séparément.

$profiler = Mon_Db_Profiler();
$profiler->setEnabled(true);
$params['profiler'] = $profiler;
$db = Zend_Db::factory('PDO_MYSQL', $params);

L'argument peut être un tableau associatif contenant une ou toutes les clés suivantes : "enabled", "instance", et "class". Les clés "enabled" et "instance" correspondent aux types booléen et instance décrites ci-dessus. La clé "class" est utilisée pour nommer une classe à prendre en tant que profileur personnalisé. La classe doit être de type Zend_Db_Profiler ou une sous-classe. La classe est instanciée sans aucun argument de constructeur. L'option "class" est ignorée quand l'option "instance" est fournie.

$params['profiler'] = array(
    'enabled' => true,
    'class'   => 'Mon_Db_Profiler'
);
$db = Zend_Db::factory('PDO_MYSQL', $params);

Enfin, l'argument peut être un objet de type Zend_Config contenant des propriétés, qui sont traitées comme les clés de tableaux décrites ci-dessus. Par exemple, une fichier "config.ini" peut contenir les données suivantes :

[main]
db.profiler.class   = "Mon_Db_Profiler"
db.profiler.enabled = true

Cette configuration peut être appliquée par le code PHP suivant :

$config = new Zend_Config_Ini('config.ini', 'main');
$params['profiler'] = $config->db->profiler;
$db = Zend_Db::factory('PDO_MYSQL', $params);

La propriété "instance" peut être utilisée comme ceci :

$profiler = new Mon_Db_Profiler();
$profiler->setEnabled(true);
$configData = array(
    'instance' => $profiler
    );
$config = new Zend_Config($configData);
$params['profiler'] = $config;
$db = Zend_Db::factory('PDO_MYSQL', $params);

A n'importe quel moment, vous pouvez récupérer le profileur en utilisant la méthode getProfiler() de l'adaptateur :

$profileur = $db->getProfiler();

Ceci retourne une instance de Zend_Db_Profiler. Avec cette instance, le développeur peut examiner les requêtes en utilisant un éventail de méthodes :

La valeur de retour de getLastQueryProfile() et les éléments individuels de getQueryProfiles() sont des objets de type Zend_Db_Profiler_Query qui permettent d'inspecter les requêtes :

L'information que Zend_Db_Profiler fourni est utile pour profiler des goulots d'étranglement dans les applications, ainsi que pour déboguer les requêtes qui viennent d'être exécutées. Par exemple, pour voir la dernière requête qui vient de s'exécuter :

$query = $profileur->getLastQueryProfile();
echo $query->getQuery();

Si une page se génère lentement, utilisez le profileur pour déterminer le nombre total de requêtes, et ensuite passer d'une requête à l'autre pour voir laquelle a été la plus longue:

$tempsTotal       = $profileur->getTotalElapsedSecs();
$nombreRequetes   = $profileur->getTotalNumQueries();
$tempsLePlusLong  = 0;
$requeteLaPlusLongue = null;

foreach ($profileur->getQueryProfiles() as $query) {
    if ($query->getElapsedSecs() > $tempsLePlusLong) {
        $tempsLePlusLong  = $query->getElapsedSecs();
        $requeteLaPlusLongue = $query->getQuery();
    }
}

echo 'Exécution de ' . $nombreRequetes . ' requêtes en ' . $tempsTotal . ' secondes' . "\n";
echo 'Temps moyen : ' . $tempsTotal / $nombreRequetes . ' secondes' . "\n";
echo 'Requêtes par seconde: ' . $nombreRequetes / $tempsTotal . ' seconds' . "\n";
echo 'Requête la plus lente (secondes) : ' . $tempsLePlusLong . "\n";
echo "Requête la plus lente (SQL) : \n" . $requeteLaPlusLongue . "\n";

En plus de l'inspection de requête, le profileur permet aussi au développeur de filtrer quelles requêtes il veut profiler. Les méthodes suivantes fonctionnent avec une instance de Zend_Db_Profiler :

// Seules les requêtes qui durent au moins 5 secondes sont profilées :
$profileur->setFilterElapsedSecs(5);

// Profil de toutes les requêtes, peu importe leur durée :
$profileur->setFilterElapsedSecs(null);

// profile uniquement les requêtes SELECT
$profileur->setFilterQueryType(Zend_Db_Profiler::SELECT);

// profile les requêtes SELECT, INSERT, et UPDATE
$profileur->setFilterQueryType(Zend_Db_Profiler::SELECT | Zend_Db_Profiler::INSERT | Zend_Db_Profiler::UPDATE);

// profile les requêtes DELETE
$profileur->setFilterQueryType(Zend_Db_Profiler::DELETE);

// Efface tous les filtres
$profileur->setFilterQueryType(null);

// Récupère uniquement les profils des requêtes SELECT
$profiles = $profiler->getQueryProfiles(Zend_Db_Profiler::SELECT);

// Récupère uniquement les profils des requêtes SELECT, INSERT, et UPDATE
$profiles = $profiler->getQueryProfiles(Zend_Db_Profiler::SELECT | Zend_Db_Profiler::INSERT | Zend_Db_Profiler::UPDATE);

// Récupère uniquement les profils des requêtes DELETE (on peut donc comprendre pourquoi les données
// disparaissent)
$profiles = $profiler->getQueryProfiles(Zend_Db_Profiler::DELETE);

Un profileur spécialisé est un objet qui hérite de Zend_Db_Profiler. Les profileurs spécialisés traitent les informations de profiling de manière spécifique.

// Dans votre fichier d'amorçage
$profiler = new Zend_Db_Profiler_Firebug('All DB Queries');
$profiler->setEnabled(true);

// Attacher le profileur à votre adaptateur de base de données
$db->setProfiler($profiler)

// Dispatcher votre contrôleur frontal

// Toutes les requêtes dans vos fichiers de modèles, vues et contrôleurs
// seront maintenant profilées et envoyées à Firebug

$profiler = new Zend_Db_Profiler_Firebug('All DB Queries');
$profiler->setEnabled(true);

// Attacher le profileur à votre adaptateur de base de données
$db->setProfiler($profiler)

$request  = new Zend_Controller_Request_Http();
$response = new Zend_Controller_Response_Http();
$channel  = Zend_Wildfire_Channel_HttpHeaders::getInstance();
$channel->setRequest($request);
$channel->setResponse($response);

// Démarrer l'output buffering
ob_start();

// Maintenant vous pouvez lancer les requêtes qui doivent être profilées

// Envoi des données de profiling vers le navigateur
$channel->flush();
$response->sendHeaders();