Debugger

Avant-propos

Si vous souhaitez vérifier votre marquage, un debugger est disponible dans le SDK pour consulter les hits et évènements générés.

Le debugger AT Internet n’est pas utilisable avec le JAR.

Initialisation (>= 2.2.2)

Dans la nouvelle version du Debugger ATInternet, il y a un prérequis supplémentaire. Il vous faut ajouter une nouvelle permission dans le fichier AndroidManifest.xml

<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />

Ensuite, il suffit de rajouter le code suivant dans la méthode onCreate de votre Activity :

package com.atinternet.atinternetdemo;

import android.app.Activity;
import android.os.Bundle;

import com.atinternet.tracker.ATInternet;
import com.atinternet.tracker.Debugger;
import com.atinternet.tracker.Tracker;

public class MainActivity extends Activity {

    private Tracker tracker;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        tracker = ATInternet.getInstance().getDefaultTracker();
        Debugger.create(this, tracker);
    }
}

Avec ce code, le Debugger se présente comme une petite bulle déplaçable sur l’écran qui suivra votre navigation sur l’application.

Cependant, tant que l’application n’est pas complètement « tuée », le Debugger sera présent. Pour le supprimer, il suffit d’ajouter un appel à la méthode remove() du Debugger :

@Override
protected void onStop() {
    super.onStop();
    Debugger.remove();
}

Ce code peut être être ajouté n’importe où vous avez besoin de détruire le Debugger.

Initialisation (< 2.2.2)

Dans le cas d’une navigation par Fragments, vous devez ajouter le code suivant dans la FragmentActivity qui contient les Fragments de votre application.

Pour afficher le debugger dans l’une de vos vues de votre application, il est recommandé d’ajouter le code suivant dans la méthode onCreate de votre Activity :

package com.atinternet.atinternetdemo;

import android.app.Activity;
import android.os.Bundle;

import com.atinternet.tracker.ATInternet;
import com.atinternet.tracker.Debugger;
import com.atinternet.tracker.Tracker;

public class MainActivity extends Activity {

    private Tracker tracker;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        tracker = ATInternet.getInstance().getDefaultTracker();
        Debugger.show(this, tracker);
    }
}

Vérifier que dans votre fichier AndroidManifest, l’Activity sur laquelle vous utilisez le Debugger ne présente pas d’attribut configChanges avec la valeur screenSize pour une utilisation optimale.

Le debugger apparaîtra alors sous forme d’un logo AT Internet en bas à droite de votre vue. Vous pouvez déplacer le logo afin de ne pas gêner l’utilisation de votre application.

Version >= 2.3.0 et Android API >= 23

Depuis la version 2.3.0, la création du Debugger embarque la vérification d’autorisation pour son affichage. Pour cela, si votre application est compatible avec Android API 23+, il suffit de rajouter ce code dans la même Activity que l’initialisation :

@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
    if (requestCode == ATInternet.ALLOW_OVERLAY_INTENT_RESULT_CODE) {
       if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
          if (Settings.canDrawOverlays(this)) {
              Debugger.create(this, tracker);
          }
       }
    }
}

Utilisation

Depuis la version 2.1.1, une fonction pour afficher/cacher le debugger est disponible:

Debugger.setViewerVisibility(true); // show the debugger (default)
Debugger.setViewerVisibility(false); // Hide the debugger

Appuyez sur le logo AT Internet pour faire apparaître le journal d’évènement :

Le journal vous permet de visualiser les différents évènements envoyés ou stockés sur l’appareil. L’icône situé à gauche détermine si l’évènement a été envoyé, stocké, si une alerte a été levée ou si une erreur est survenue. L’icône situé à droite vous permet de connaitre la catégorie de l’évènement (marquage d’écran, de touch …).

Pour visualiser le détail de l’évènement envoyé, appuyez sur l’URL affichée :

Visualisation des hits stockés

Si vous avez configuré le SDK pour stocker les hits en cas de perte de connexion ou de manière permanente, le debugger vous permet également de les visualiser. Pour cela, appuyez sur l’icône situé en haut à gauche du journal d’évènement :

Cette fenêtre vous permet de voir les dates de génération des hits, ainsi que son url. L’icône situé à droite vous permet de connaitre la catégorie du hit (marquage d’écran, de touch …). La corbeille située à droite vous permet de supprimer un hit du stockage. La corbeille située dans la barre principale vous permet de supprimer tous les hits stockés.

Pour visualiser le détail du hit stocké, appuyez sur l’URL affichée :