Documentation sur Oracle Cloud Infrastructure

Fonction d'expéditeur du journal APM

Découvrez comment utiliser la fonction prédéfinie Expéditeur de journaux APM dans le service des fonctions pour OCI pour déplacer les journaux de service vers un domaine APM.

Scénarios d'utilisation communs

Utilisez la fonction PBF d'expéditeur de journal APM pour déplacer les journaux de service vers un domaine APM en utilisant la fonction comme cible d'un connecteur de service. L'utilisation principale de cette fonction est de surveiller les intégrations d'Oracle Integration Cloud (OIC) à Application Performance Monitoring (APM) en connectant un journal de flux de données d'activités d'OCI à la fonction.

Les services liés à la fonction d'expéditeur de journal APM sont les suivants :

Portée

La portée de cette fonction comprend les éléments suivants :

Préalables et recommandations

Voici les meilleures pratiques à suivre pour utiliser cette fonction prédéfinie :

Configuration de la fonction d'expéditeur de journal APM

Pour créer une fonction d'expéditeur de journal APM, procédez comme suit :

  1. Dans la page Fonctions prédéfinies, sélectionnez Expéditeur de journal APM, puis Créer une fonction.
  2. Configurez le nom, le compartiment et l'application de la façon suivante :
    • Nom : Nom de votre choix pour la nouvelle fonction. Le nom doit commencer par une lettre ou un trait de soulignement, suivi de lettres, de chiffres, de tirets ou de traits de soulignement. Il peut comporter entre 1 et 255 caractères. Évitez d'entrer des informations confidentielles.

      Pour créer la fonction dans un autre compartiment, sélectionnez Changer de compartiment.

    • Application : Sélectionnez l'application dans laquelle vous voulez créer la fonction.

      Si aucune application appropriée n'existe déjà dans le compartiment courant, sélectionnez Créer une application et spécifiez les détails suivants :

      • Nom : Nom de la nouvelle application. Évitez d'entrer des informations confidentielles.
      • VCN : VCN (réseau en nuage virtuel) dans lequel exécuter des fonctions dans l'application. Facultativement, sélectionnez Compartiment du VCN : pour sélectionner un VCN d'un autre compartiment.
      • Sous-réseaux : Le ou les sous-réseaux (trois au maximum) dans lesquels exécuter des fonctions. Facultativement, sélectionnez Compartiment des sous-réseaux : pour sélectionner un sous-réseau dans un autre compartiment.
      • Forme : Architecture de processeur des instances de calcul sur lesquelles déployer et exécuter des fonctions dans l'application. Toutes les fonctions de l'application sont déployées et exécutées sur des instances de calcul de la même architecture. L'image de la fonction doit contenir les dépendances nécessaires pour l'architecture que vous sélectionnez.
      • Marqueurs : Si vous êtes autorisé à créer une ressource, vous disposez également des autorisations nécessaires pour appliquer des marqueurs à structure libre à cette ressource. Pour appliquer un marqueur défini, vous devez être autorisé à utiliser l'espace de noms de marqueur. Pour plus d'informations sur le marquage, voir Marqueurs de ressource. Si vous ne savez pas si vous devez appliquer des marqueurs, ignorez cette option ou demandez à un administrateur. Vous pouvez appliquer des marqueurs plus tard.
  3. Configurez la politique IAM pour les fonctions prédéfinies.

    Par défaut, OCI Functions crée un groupe dynamique et une politique IAM avec les énoncés de politique requis pour exécuter la fonction prédéfinie. Procédez comme suit :

    • Si vous voulez qu'OCI Functions crée automatiquement le groupe dynamique et la politique, n'effectuez aucune modification pour accepter le comportement par défaut.
    • Si vous ne voulez pas que le service des fonctions pour OCI crée automatiquement le groupe dynamique et la politique, sélectionnez Ne pas créer de groupe dynamique et de politique IAM.
    Important

    Si vous sélectionnez l'option Ne pas créer de groupe dynamique et de politique IAM, vous devez définir vous-même le groupe dynamique et la politique IAM.
  4. Configurez la mémoire de fonction et les valeurs de temporisation comme suit :
    • Mémoire (en Mo) : Quantité maximale de mémoire que la fonction peut utiliser en cours d'exécution, en mégaoctets. Il s'agit de la mémoire disponible pour l'image de fonction.
    • Temporisation (en secondes) : Durée maximale d'exécution de la fonction, en secondes. Si la fonction ne se termine pas dans le temps spécifié, le système annule la fonction. (Par défaut : 300)
  5. (Facultatif) Configurez l'accès simultané provisionné pour réduire les retards initiaux lors de l'appel de la fonction en spécifiant un nombre minimal d'appels de fonction simultanée pour lesquels vous voulez que l'infrastructure d'exécution soit constamment disponible. (Par défaut : Non sélectionné)

    Si cette option est sélectionnée, spécifiez le nombre d'unités d'accès simultané provisionnées affectées à cette fonction. Par défaut : 20.

    Pour plus d'informations sur la simultanéité provisionnée, voir Réduction de la latence initiale à l'aide de la simultanéité provisionnée.

  6. Définissez les paramètres de configuration de la fonction comme décrit dans Paramètres de configuration.
  7. Facultativement, entrez des marqueurs dans la section Marqueurs. Si vous êtes autorisé à créer une ressource, vous disposez également des autorisations nécessaires pour appliquer des marqueurs à structure libre à cette ressource. Pour appliquer un marqueur défini, vous devez être autorisé à utiliser l'espace de noms de marqueur. Pour plus d'informations sur le marquage, voir Marqueurs de ressource. Si vous ne savez pas si vous devez appliquer des marqueurs, ignorez cette option ou demandez à un administrateur. Vous pouvez appliquer des marqueurs plus tard.
  8. Sélectionnez Créer.

La boîte de dialogue de déploiement affiche les tâches de déploiement de la fonction (voir Fin du déploiement de fonction prédéfinie).

Options de configuration

Paramètres de configuration

Nom Description Obligatoire
APM_DOMAIN_ID ID du domaine qui surveille le journal du service. Oui
PBF_LOG_LEVEL Niveau de journalisation, les options sont DEBUG, INFO, WARN et ERROR. La valeur par défaut est INFO. Nombre

Permissions

L'exécution d'une fonction nécessite certaines politiques IAM. Si vous avez sélectionné l'option Ne pas créer de groupe dynamique et de politique IAM lors de la création de la fonction, vous devez définir vous-même le groupe dynamique et la politique IAM.

Pour définir les politiques appropriées :

  • Créez un groupe dynamique avec la règle : 
    ALL {resource.id = '<function_ocid>', resource.compartment.id = '<compartment_ocid>'
  • Configurez une politique IAM à l'aide du groupe dynamique : 
    Allow dynamic-group <dynamic-group-name> to read apm-domains in compartment <compartment-name>
Allow dynamic-group <dynamic-group-name> to {APM_DOMAIN_DATA_UPLOAD} in compartment <compartment-name>
Note

Remplacez <function-ocid> par l'OCID de la fonction que vous avez créée lors des étapes précédentes.
Note

Remplacez <dynamic-group-name> par le nom du groupe dynamique que vous avez créé à l'aide de l'OCID de la fonction.
Note

Remplacez <compartment_ocid> par l'OCID du compartiment qui contient la fonction.
Note

Remplacez <compartment_name> par le nom du compartiment qui contient le domaine APM.

Appel de cette fonction

Le centre de connecteurs utilise la fonction créée à l'aide de cette structure d'équilibreurs de charge pour déplacer les journaux de service vers un domaine APM.
  1. Créez une fonction à l'aide de ce fichier PBF.
  2. Créez un connecteur dans le centre de connecteurs pour transférer les journaux de flux de données d'activités vers la fonction :
    1. Ouvrez le menu de navigation et sélectionnez Analyse et intelligence artificielle. Sous Messagerie, sélectionnez Centre de connecteurs.
    2. Sélectionnez le bouton Créer un connecteur.
    3. Entrez un nom et une description facultative.
    4. Sélectionnez un compartiment.
    5. Sous Configurer le connecteur, réglez la source à Journalisation et la cible à Fonctions.
    6. Sous Configurer la source, pointez le groupe de journaux et les journaux vers un journal de service.
    7. Sous Configurer la cible, réglez l'application de fonction et la fonction à la fonction que vous avez créée à l'étape précédente.

      Note : Ne configurez pas de tâche.

    8. Sélectionnez le bouton Créer.

Dépannage

Codes de statut communs du service des fonctions pour OCI

Le tableau suivant résume les erreurs courantes du service des fonctions pour OCI que vous pourriez rencontrer lorsque vous utilisez des fonctions prédéfinies :

Code d'erreur Message d'erreur Action
200 Succès Aucune
404 NotAuthorizedOrNotFound Vérifiez que les politiques requises sont configurées (voir L'exécution des commandes de l'interface de ligne de commande Fn Project retourne une erreur de type 404).
444 Temporisation

La connexion entre le client et le service des fonctions pour OCI a été interrompue lors de l'exécution de la fonction (voir L'appel d'une fonction entraîne une temporisation du client et une erreur 444 est affichée dans les journaux de la fonction). Une nouvelle tentative peut résoudre le problème.

Notez que la plupart des clients ont une temporisation interne de 60 secondes. Même lorsque la temporisation de la fonction prédéfinie est réglée à 300 secondes, les éléments suivants peuvent être requis :

  • Lors de l'utilisation de l'interface de ligne de commande OCI : Utilisez --read-timeout 300
  • Lors de l'utilisation de la trousse SDK OCI : Réglez la temporisation de lecture à 300 lors de la création du client
  • Lors de l'utilisation de DBMS_CLOUD.SEND_REQUEST : Utilisez UTL_HTTP.set_transfer_timeout(300);

Pour plus d'informations, voir Appel de fonctions.
502 504 (différent) La plupart des problèmes retournent un code de statut 502 (voir L'appel d'une fonction retourne un message d'échec de fonction et une erreur 502). Une erreur 502 avec le message "error receive function response" peut être résolue en augmentant l'allocation de mémoire. Un 502 peut se produire occasionnellement lorsque la fonction est dans un état transitoire. Une nouvelle tentative peut résoudre le problème.

Pour en identifier la cause, activez les fonctions de journalisation pour la fonction prédéfinie (voir Stockage et consultation des journaux de fonction). Pour des informations détaillées sur le dépannage d'une fonction, voir Dépannage du service des fonctions pour OCI.

Messages d'erreur de fonction prédéfinie de l'expéditeur du journal APM

Le tableau suivant résume les erreurs que vous pourriez rencontrer lors de l'utilisation de cette fonction prédéfinie :

Code d'erreur Message d'erreur Action
S.O. Impossible d'extraire le point d'extrémité de chargement des données

Vérifiez que l'énoncé de politique requis suivant a été créé :

Allow dynamic-group <dynamic-group-name> to read apm-domains in compartment <compartment-name>
S.O. Échec du report dans l'agent de recouvrement APM

Vérifiez que l'énoncé de politique requis suivant a été créé :

Allow dynamic-group <dynamic-group-name> to {APM_DOMAIN_DATA_UPLOAD} in compartment <compartment-name>

Vérifiez que la passerelle appropriée est configurée pour le VCN de l'application. Voir Conditions requises et recommandations.

Pour en identifier la cause, activez les fonctions de journalisation pour la fonction prédéfinie (voir Stockage et consultation des journaux de fonction).

Conseils sur l'analyse des journaux

Toutes les fonctions prédéfinies fournissent une option permettant de spécifier le niveau de journalisation en tant que paramètre de configuration. Vous pouvez régler le niveau de journalisation à DEBUG pour obtenir plus d'informations.

Étant donné qu'une application comporte plusieurs fonctions, les entrées du journal des fonctions prédéfinies sont identifiées par le préfixe "PBF | <PBF NAME>".

Par exemple, une entrée de journal pour la fonction prédéfinie d'expéditeur de journaux APM ressemble à ce qui suit :

"PBF | APM Log Sender | ERROR | 2024-08-13T12:44:49.579050219Z | Unable to retrieve data upload endpoint"