Cette page a été traduite par l'API Cloud Translation.

Déboguer WorkManager

Si vous remarquez que vos nœuds de calcul s'exécutent trop souvent ou pas du tout, voici quelques étapes de débogage qui peuvent vous aider à comprendre ce qui se passe.

Activer la journalisation

Pour déterminer la raison pour laquelle vos nœuds de calcul ne s'exécutent pas correctement, il peut être très utile d'examiner les journaux détaillés de WorkManager. Pour activer la journalisation, utilisez l'initialisation personnalisée.

Tout d'abord, désactivez le WorkManagerInitializer par défaut dans votre fichier AndroidManifest.xml en créant un fournisseur WorkManager auquel la règle de fusion du fichier manifeste remove est appliquée:

<provider
    android:name="androidx.work.impl.WorkManagerInitializer"
    android:authorities="${applicationId}.workmanager-init"
    tools:node="remove"/>

Maintenant que l'initialiseur de gestionnaire WorkManager est désactivé, vous pouvez utiliser l'initialisation à la demande. Pour ce faire, la classe android.app.Application doit fournir une implémentation pour androidx.work.Configuration.Provider:

Kotlin

class MyApplication() : Application(), Configuration.Provider {
    override fun getWorkManagerConfiguration() =
        Configuration.Builder()
            .setMinimumLoggingLevel(android.util.Log.DEBUG)
            .build()
}

Java

public class MyApplication extends Application implements Configuration.Provider {
    @NonNull
    @Override
    public Configuration getWorkManagerConfiguration() {
        return new Configuration.Builder()
                .setMinimumLoggingLevel(android.util.Log.DEBUG)
                .build();
    }
}

Lorsque vous définissez une configuration WorkManager personnalisée, votre WorkManager est initialisé lorsque vous appelez WorkManager.getInstance(Context) plutôt que automatiquement au démarrage de l'application. Consultez la section Configuration et initialisation personnalisées de WorkManager pour en savoir plus, y compris sur la prise en charge des versions de WorkManager antérieures à la version 2.1.0.

Lorsque la journalisation DEBUG est activée, vous voyez beaucoup plus de journaux avec le préfixe de balise de journal WM-.

Utiliser adb shell dumpsys jobscheduler

Vous pouvez utiliser adb pour obtenir plus d'informations sur la planification des tâches sous Android 6.0 (niveau d'API 23) ou version ultérieure. Si vous ne connaissez pas adb, consultez la section Outils de ligne de commande pour en savoir plus.

Une fois adb installé, exécutez la commande suivante pour examiner la liste des tâches attribuées à votre package:

adb shell dumpsys jobscheduler

Le résultat ressemble à ceci:

JOB #u0a172/4: 6412553 com.google.android.youtube/androidx.work.impl.background.systemjob.SystemJobService
  u0a172 tag=*job*/com.google.android.youtube/androidx.work.impl.background.systemjob.SystemJobService
  Source: uid=u0a172 user=0 pkg=com.google.android.youtube
  JobInfo:
    Service: com.google.android.youtube/androidx.work.impl.background.systemjob.SystemJobService
    Requires: charging=false batteryNotLow=false deviceIdle=false
    Extras: mParcelledData.dataSize=180
    Network type: NetworkRequest [ NONE id=0, [ Capabilities: NOT_METERED&INTERNET&NOT_RESTRICTED&TRUSTED&VALIDATED Uid: 10172] ]
    Minimum latency: +1h29m59s687ms
    Backoff: policy=1 initial=+30s0ms
    Has early constraint
  Required constraints: TIMING_DELAY CONNECTIVITY [0x90000000]
  Satisfied constraints: DEVICE_NOT_DOZING BACKGROUND_NOT_RESTRICTED WITHIN_QUOTA [0x3400000]
  Unsatisfied constraints: TIMING_DELAY CONNECTIVITY [0x90000000]
  Tracking: CONNECTIVITY TIME QUOTA
  Implicit constraints:
    readyNotDozing: true
    readyNotRestrictedInBg: true
  Standby bucket: RARE
  Base heartbeat: 0
  Enqueue time: -51m29s853ms
  Run time: earliest=+38m29s834ms, latest=none, original latest=none
  Last run heartbeat: 0
  Ready: false (job=false user=true !pending=true !active=true !backingup=true comp=true)

Lorsque vous utilisez WorkManager, le composant chargé de gérer l'exécution des nœuds de calcul est SystemJobService au niveau d'API 23 ou supérieur. Recherchez les instances de tâches attribuées à votre nom de package et à androidx.work.impl.background.systemjob.SystemJobService.

Pour chaque tâche, le résultat de la commande liste les contraintes obligatoires, satisfaites et non satisfaites. Vérifiez si les contraintes de votre nœud de calcul sont entièrement satisfaites.

Le résultat inclut également l'historique des tâches récemment exécutées. Vous pouvez donc l'utiliser pour vérifier si SystemJobService a été appelé récemment.

Job history:
     -1h35m26s440ms   START: #u0a107/9008 com.google.android.youtube/androidx.work.impl.background.systemjob.SystemJobService
     -1h35m26s362ms  STOP-P: #u0a107/9008 com.google.android.youtube/androidx.work.impl.background.systemjob.SystemJobService app called jobFinished

Demander des informations de diagnostic à partir de WorkManager 2.4.0+

Sur les versions de débogage de votre application, vous pouvez demander des informations de diagnostic à partir de la version 2.4.0 de WorkManager à l'aide de la commande suivante:

adb shell am broadcast -a "androidx.work.diagnostics.REQUEST_DIAGNOSTICS" -p "<your_app_package_name>"

Vous obtenez ainsi des informations sur :

Requêtes de travail terminées au cours des dernières 24 heures.
Requêtes de travail en cours d'exécution
Requêtes de travail planifiées

Voici un exemple de résultat (visible via logcat) :

adb shell am broadcast -a "androidx.work.diagnostics.REQUEST_DIAGNOSTICS" -p "androidx.work.integration.testapp"

adb logcat
...
2020-02-13 14:21:37.990 29528-29660/androidx.work.integration.testapp I/WM-DiagnosticsWrkr: Recently completed work:
2020-02-13 14:21:38.083 29528-29660/androidx.work.integration.testapp I/WM-DiagnosticsWrkr: Id  Class Name   State  Unique Name Tags
    08be261c-2def-4bd6-a716-1e4410968dc4     androidx.work.impl.workers.DiagnosticsWorker    SUCCEEDED  null    androidx.work.impl.workers.DiagnosticsWorker
    48ce04f1-8df9-450b-96ec-6eceabb9c690     androidx.work.impl.workers.DiagnosticsWorker    SUCCEEDED  null    androidx.work.impl.workers.DiagnosticsWorker
    c46f4699-c384-440c-a10e-26d56ce02963     androidx.work.impl.workers.DiagnosticsWorker    SUCCEEDED  null    androidx.work.impl.workers.DiagnosticsWorker
    ce125372-046e-484e-949f-9abb35ce62c3     androidx.work.impl.workers.DiagnosticsWorker    SUCCEEDED  null    androidx.work.impl.workers.DiagnosticsWorker
    72887ddd-8ed1-4018-b798-fac218e95e16     androidx.work.impl.workers.DiagnosticsWorker    SUCCEEDED  null    androidx.work.impl.workers.DiagnosticsWorker
    dcff3d61-320d-4996-8644-5d97944bd09c     androidx.work.impl.workers.DiagnosticsWorker    SUCCEEDED  null    androidx.work.impl.workers.DiagnosticsWorker
    acab0bf7-6087-43ad-bdb5-be0df9195acb     androidx.work.impl.workers.DiagnosticsWorker    SUCCEEDED  null    androidx.work.impl.workers.DiagnosticsWorker
    23136bcd-01dd-46eb-b910-0fe8a140c2a4     androidx.work.integration.testapp.ToastWorker   SUCCEEDED  null    androidx.work.integration.testapp.ToastWorker
    245f4879-c6d2-4997-8130-e4e90e1cab4c     androidx.work.integration.testapp.ToastWorker   SUCCEEDED  null    androidx.work.integration.testapp.ToastWorker
    17d05835-bb61-429a-ad11-fe43fc320a54     androidx.work.integration.testapp.ToastWorker   SUCCEEDED  null    androidx.work.integration.testapp.ToastWorker
    e95f12be-4b0c-4e64-88da-8ee07a31e42f     androidx.work.integration.testapp.ToastWorker   SUCCEEDED  null    androidx.work.integration.testapp.ToastWorker
    431c3ec2-4a55-469b-b50b-4072d35f1232     androidx.work.integration.testapp.ToastWorker   SUCCEEDED  null    androidx.work.integration.testapp.ToastWorker
    883a388f-f911-4098-9143-37bd8fbc098a     androidx.work.integration.testapp.ToastWorker   SUCCEEDED  null    androidx.work.integration.testapp.ToastWorker
    b904163c-6822-4299-8d5a-78df49b7e53d     androidx.work.integration.testapp.ToastWorker   SUCCEEDED  null    androidx.work.integration.testapp.ToastWorker
    453fd7b9-2b16-45b9-abc5-3d2ce7b6a4ba     androidx.work.integration.testapp.ToastWorker   SUCCEEDED  null    androidx.work.integration.testapp.ToastWorker
2020-02-13 14:21:38.083 29528-29660/androidx.work.integration.testapp I/WM-DiagnosticsWrkr: Running work:
2020-02-13 14:21:38.089 29528-29660/androidx.work.integration.testapp I/WM-DiagnosticsWrkr: Id  Class Name   State  Unique Name Tags
    b87c8a4f-4ac6-4e25-ba3e-4cea53ce468a     androidx.work.impl.workers.DiagnosticsWorker    RUNNING    null    androidx.work.impl.workers.DiagnosticsWorker
...