Gérer les extensions Firebase installées

Pour installer ou gérer des extensions, vous devez disposer de l'un des rôles suivants : Propriétaire ou éditeur ou Administrateur Firebase.

Console Firebase CLI Firebase SDK généré automatiquement

Répertorier les instances d'extension installées d'un projet

Vous pouvez lister toutes les instances des extensions que vous avez installées.

Exécutez la commande extensions-list:

firebase ext:list --project=projectId-or-alias

Afficher les détails et la configuration d'une instance d'extension installée

1. Accédez à votre tableau de bord Firebase Extensions dans la console Firebase.

2. Sur la fiche de l'instance d'extension installée, cliquez sur Gérer.

Surveiller une instance d'extension installée

Dans la console Firebase, vous pouvez surveiller l'activité d'une extension installée, y compris en vérifiant son état, son utilisation et ses journaux.

Définir des alertes de budget

En règle générale, il est recommandé de définir des alertes budgétaires, mais elles peuvent être particulièrement importantes lorsque vous faites confiance au code d'un tiers pour l'exécuter dans votre projet.

Assurez-vous de configurer des alertes de budget pour votre projet Firebase.

Afficher les fonctions créées par les extensions

1. Accédez au tableau de bord des fonctions de la console Firebase.

2. Dans l'onglet Dashboard (Tableau de bord), vous pouvez afficher les fonctions de Firebase Extensions (ainsi que toutes les autres fonctions que vous avez déployées pour votre projet).

   Les fonctions créées par les extensions ont un nom au format suivant : ext-extension-instance-id-functionName

   Par exemple : ext-awesome-task-simplifier-onUserCreate

Afficher les jobs Cloud Scheduler créés par les extensions

1. Ouvrez la page Cloud Scheduler de votre projet dans la console Google Cloud.

2. Dans la liste des tâches, vous pouvez afficher les tâches Cloud Scheduler à partir de Firebase Extensions (ainsi que toutes les autres tâches que vous avez créées pour votre projet).

   Les jobs créés par des extensions ont des noms au format suivant : firebase-ext-extension-instance-id-functionName

   Par exemple : firebase-ext-awesome-task-simplifier-doTask

Afficher et gérer les tâches Cloud Tasks mises en file d'attente par les extensions

Certaines extensions utilisent Cloud Tasks pour exécuter des tâches plus longues: le plus souvent, des tâches de traitement qui s'exécutent à différents moments du cycle de vie d'une extension (installation, reconfiguration et après les mises à niveau).

Normalement, ces tâches s'exécutent et se terminent automatiquement, sans intervention de votre part. Toutefois, si vous devez gérer manuellement les tâches mises en file d'attente d'une extension (par exemple, pour suspendre la file d'attente ou supprimer d'une file d'attente une tâche qui n'a pas encore commencé), procédez comme suit:

1. Dans la section Extensions de la console Firebase, ouvrez la page d'informations de l'instance de l'extension.

2. Sur la page d'informations, ouvrez la section API et ressources. Si l'extension utilise Cloud Tasks, une section Files d'attente Cloud Tasks s'affiche avec une ou plusieurs entrées.

3. Cliquez sur Afficher la file d'attente pour la file d'attente que vous souhaitez gérer. La page "Détails de la file d'attente" s'ouvre dans la console Google Cloud. Vous pouvez y afficher les tâches en file d'attente, suspendre la file d'attente, supprimer des tâches de la file d'attente, etc. Consultez la section Gérer les files d'attente et les tâches dans la documentation Cloud Tasks.

   Remarque :Vous pouvez mettre une file d'attente en pause, mais si vous la laissez en pause trop longtemps, les tâches peuvent échouer avec des erreurs d'authentification lorsque vous reprenez la file d'attente. (L'authentification de la tâche expire une heure après son intégration à la file d'attente.)
   Avertissement:Ne supprimez pas la file d'attente. L'extension en a besoin pour fonctionner. Si vous supprimez accidentellement la file d'attente, procédez comme suit:

   1. Installez une nouvelle instance de l'extension.
   2. Ne désinstallez l'ancienne instance qu'après avoir installé la nouvelle.

Afficher les secrets Cloud Secret Manager créés par des extensions

1. Ouvrez la page Secret Manager de votre projet dans la console Google Cloud.

2. Dans la liste "Secrets", vous pouvez afficher les secrets créés pour Firebase Extensions (ainsi que tous les autres secrets que vous avez créés pour votre projet).

   Les secrets créés par les extensions ont des noms au format suivant : ext-extension-instance-id-paramnName

   Par exemple : ext-awesome-task-simplifier-API_KEY

   Les secrets sont associés à la clé firebase-extensions-managed. Ne supprimez pas ce libellé, sauf si vous souhaitez empêcher Firebase de gérer le secret.

Vérifier si une extension installée est opérationnelle

Vous pouvez consulter toutes les erreurs des fonctions (y compris celles créées par Firebase Extensions) dans la console.

1. Dans l'onglet État de votre tableau de bord "Fonctions", vous pouvez consulter un aperçu des erreurs et des informations sur les performances de toutes les fonctions de votre projet.

2. Pour afficher des informations sur une extension spécifique, utilisez le filtre en haut de la page pour sélectionner une fonction spécifique.

Vérifier la fréquence d'exécution d'une extension installée

1. Dans l'onglet Tableau de bord de votre tableau de bord "Fonctions", recherchez la fonction spécifique pour l'Firebase Extension que vous souhaitez vérifier.

2. Cliquez sur  (le menu à développer) tout à droite de l'entrée, puis sélectionnez Statistiques d'utilisation détaillées.

3. Dans la console Google Cloud affichée, vous pouvez examiner en détail les différentes invocations d'une fonction et même inspecter son code source.

Afficher les journaux d'une extension

Si vous essayez de déboguer votre projet ou d'envoyer un rapport de bug à Firebase, il est utile de consulter les journaux des fonctions exécutées dans votre projet.

Dans l'onglet Journaux de votre tableau de bord "Fonctions", utilisez le filtre en haut de la page pour sélectionner les fonctions créées par votre extension.

Mettre à jour une instance d'extension installée vers la dernière version

Vous pouvez mettre à jour une instance installée d'une extension vers sa dernière version publiée. Vous pouvez mettre à jour une instance installée, car elle est déjà en cours d'exécution ou configurée dans votre workflow de test, de projet ou d'application.

Remarque :Si vous avez installé une extension à l'aide d'un SDK généré automatiquement, utilisez la même méthode pour la mettre à niveau, et non la console ni la CLI.

Lorsque vous mettez à jour une instance, toutes les ressources et la logique spécifiques à l'extension de l'instance sont écrasées pour utiliser le code source et les fichiers de la nouvelle version. L'ID d'instance et le compte de service de l'extension ne changent pas.

Au cours du processus de mise à jour, vous serez informé de tout changement apporté à la nouvelle version et vous pourrez spécifier des valeurs pour les nouveaux paramètres.

1. Accédez à votre tableau de bord Firebase Extensions, puis sur la fiche de l'instance d'extension installée, cliquez sur Gérer.

2. En haut à droite, cliquez sur Mettre à jour l'extension.

   Si aucune nouvelle version de l'extension n'est disponible, aucun bouton de mise à jour ne s'affiche sur la page d'informations.

3. Consultez les nouveautés de la mise à jour et configurez l'extension (si nécessaire).

4. Cliquez sur Mettre à jour l'extension.

Reconfigurer une instance d'extension installée

Vous pouvez modifier les valeurs des paramètres configurés par l'utilisateur pour une instance d'extension installée. Ces nouvelles valeurs seront utilisées dans tous les futurs déclencheurs de l'instance, mais tous les artefacts ou éléments structurels précédents créés par l'extension (comme les images stockées ou les buckets de stockage existants) ne seront pas modifiés.

Remarque :Si vous avez installé une extension à l'aide d'un SDK généré automatiquement, utilisez la même méthode pour la reconfigurer, et non la console ni la CLI.

1. Accédez à votre tableau de bord Firebase Extensions, puis sur la fiche de l'instance d'extension installée, cliquez sur Gérer.

2. En haut à droite, cliquez sur Reconfigurer l'extension.

3. Suivez les instructions à l'écran pour reconfigurer les valeurs des paramètres de votre extension.

4. Cliquez sur Enregistrer.

Remarque :L'enregistrement des modifications apportées à une extension peut prendre entre trois et cinq minutes.

Désinstaller une instance d'extension

Vous pouvez désinstaller une instance d'une extension de votre projet Firebase. Cette action supprime le compte de service et toutes les ressources (comme un ensemble de fonctions) que Firebase a créées spécifiquement pour cette instance de l'extension. Toutefois, les éléments suivants ne sont pas supprimés:

• Tous les artefacts créés par l'extension (comme les images stockées).

• Toutes les autres ressources de votre projet, comme une instance de base de données ou un bucket Cloud Storage. Même si l'extension a interagi avec ces autres ressources, elles ne sont pas spécifiques à l'extension. Elles ne sont donc pas supprimées si l'extension est désinstallée.

Pour désinstaller une extension:

1. Accédez à votre tableau de bord Firebase Extensions, puis sur la fiche de l'instance d'extension installée, cliquez sur Gérer.

2. En bas de l'écran, cliquez sur Désinstaller l'extension.

3. Vérifiez ce qui sera supprimé, puis cliquez sur Désinstaller l'extension pour confirmer la suppression.

Remarque :Si vous avez installé l'extension à l'aide du SDK généré automatiquement, veillez également à supprimer la configuration de l'instance de votre code Cloud Functions.