Fonction de trace AWS Lambda native pour Node.js

La configuration d' Instana AutoTrace pour Node.js vous permet de suivre vos fonctions AWS Lambda à l'aide de la couche Lambda de Instana et d'un gestionnaire de fonctions personnalisé.

Cette approche ne nécessite aucune modification de code de la fonction Lambda et s'effectue par le biais d'une simple configuration. Cette configuration peut parfaitement être automatisée ou incluse dans un pipeline de déploiement Lambda.

Pour activer le suivi des fonctions Lambda Node.js, procédez comme suit :

1. Ajoutez la couche Instana Lambda à votre fonction.
   1. Dans la page de configuration de votre fonction Lambda, cliquez sur la Layers case, puis sur Add a layer.

      

   2. Dans la fenêtre contextuelle qui s'ouvre, sélectionnez « Fournir un ARN de couche », puis copiez-collez l'ARN de la couche Lambda « Instana » correspondant à votre région; vous trouverez l'ARN approprié pour la couche Lambda « Instana » dans la section « Couches Lambda » de Instana.

      

2. Configurez le gestionnaire Lambda.

   Définissez le gestionnaire sur instana-aws-lambda-auto-wrap.handler si vous utilisez CommonJS.

   Définissez le gestionnaire sur instana-aws-lambda-auto-wrap-esm.handler si vous utilisez les modules ES ( ES6 ) (disponible à partir de la version 223 de la couche).

   Pour modifier le paramètre du gestionnaire Lambda, recherchez la section "Paramètres de base" sur la page de configuration.

   

   Cliquez sur Editer et insérez instana-aws-lambda-auto-wrap.handler dans la zone "Gestionnaire".

   

   La couche Lambda d' Instana déclenche automatiquement le gestionnaire d'exécution par défaut d' Node.jsindex.handler. Si vous utilisez un gestionnaire personnalisé, indiquez-le dans la variable d'environnement LAMBDA_HANDLER afin d'en informer la couche Lambda d' Instana. Voir la section suivante pour toutes les variables d'environnement qui doivent être définies.

   Remarque : la page de configuration de Lambda peut afficher un message d'avertissement indiquant que Lambda ne parvient pas à trouver le fichier instana-aws-lambda-auto-wrap.js. Ce message peut également s'afficher ultérieurement lorsque vous revenez sur la page de configuration. Ne vous laissez pas distraire par cet avertissement. Le gestionnaire réside dans la couche Instana Lambda, mais la page de configuration d'AWS Lambda n'en tient pas compte.
3. Configurez les variables d'environnement.

   Ajoutez les variables d'environnement suivantes :

   • INSTANA_ENDPOINT_URL: Cette variable correspond à votre point de terminaison de surveillance sans serveur. Veillez à utiliser la valeur correcte pour votre région qui commence par https://serverless-.
   • INSTANA_AGENT_KEY: votre clé d'agent.
   • LAMBDA_HANDLER: définissez votre gestionnaire personnalisé. Si votre fichier principal est myModule.js, qui exporte la fonction myHandler, définissez la variable d'environnement sur myModule.myHandler. La valeur par défaut est index.handler.

   Dans l'exemple suivant, le gestionnaire Lambda principal d'origine est index.js, et vous n'avez donc pas besoin de définir la variable d'environnement LAMBDA_HANDLER.

   

   Dans l'exemple suivant, le gestionnaire Lambda principal d'origine est server.js, et vous devez donc définir la variable d'environnement LAMBDA_HANDLER sur server.handler.

   

   Vous pouvez également obtenir les valeurs correctes de ces variables d'environnement en vous rendant dans votre installation d' Instana, puis en cliquant sur... Plus -> Agents -> Installation des agents d' Instana -> Plateforme : AWS -> Technologie : AWS Lambda.

4. Sauvegardez la définition de la fonction Lambda.

   

Toutes les étapes décrites précédemment peuvent être effectuées soit via la console Web AWS, soit à l'aide de l'un des outils de gestion habituels d' AWS, tels que :

• l' interface de ligne de commandeaws
• l' interface de ligne de commande de l'infrastructure sans serveur
• AWS Cloud Development Kit

Voici un exemple de commande CLI aws qui pourrait servir de point de départ si vous souhaitez automatiser l'intégration d'Instana de vos instances AWS Lambda :

# Do not copy and paste this verbatim!
# It will overwrite any previously defined collection of layers and
# environment variables.
aws --region $YOUR_REGION lambda update-function-configuration \
  --function-name $YOUR_LAMBDA_FUNCTION_NAME \
  --layers $INSTANA_LAYER_ARN \
  --handler instana-aws-lambda-auto-wrap.handler \
  --environment "Variables={INSTANA_ENDPOINT_URL=... , INSTANA_AGENT_KEY=... , ...}"

Pour installer manuellement le collecteur Instana Node.js, exécutez la commande suivante :

npm install --save @instana/aws-lambda@latest

Modifiez le code de la fonction en suivant les instructions de la section « Envelopper manuellement le gestionnaire ».

Si votre équipe utilise des déploiements Lambda basés sur des conteneurs, vous pouvez utiliser les conteneurs de base disponibles sur Instanaicr.io/instana/aws-lambda-nodejs ou inclure l'extrait de code suivant dans votre Dockerfile et définir les arguments de compilation sur les versions appropriées.

Instana ne prend actuellement en charge que x86_64 l'architecture.

# This is the container image that delivers Instana's monitoring capabilities.
# It will not become the base image for your Lambda container image, it just provides a few files.
FROM icr.io/instana/aws-lambda-nodejs:latest as instana-layer

# This is the actual base image for your Lambda container image. You can also use any other base image that is suitable
# for container image based Lambda functions.
FROM public.ecr.aws/lambda/nodejs:22

# Copy Instana's Node.js monitoring components into your Lambda container image.
COPY --from=instana-layer /opt/extensions/ /opt/extensions/
COPY --from=instana-layer /opt/nodejs/ /opt/nodejs/

# The remainder of your Dockerfile, as it was without adding the Instana layer. The following is just an example:
COPY index.js package.json package-lock.json /var/task/
WORKDIR /var/task
RUN npm install

# Override the CMD. This can also be done as a parameter override outside of the Dockerfile, for example in the AWS console.
# If you use ES modules, use CMD [ "instana-aws-lambda-auto-wrap-esm.handler" ] instead.
CMD [ "instana-aws-lambda-auto-wrap.handler" ]

curl -s https://icr.io/v2/instana/aws-lambda-nodejs/tags/list | jq .

Modifiez le fichier serverless.yml pour intégrer le traçage d' Instana s au Serverless Framework. Suivez ces étapes :

1. Copiez l' ARN de couche de la liste et ajoutez l'ARN à la section des couches de la définition de fonction cible.
2. Ajoutez des variables d'environnement INSTANA_AGENT_KEY, INSTANA_ENDPOINT_URL et LAMBDA_HANDLER. Pour plus d'informations, consultez la page InstanaAutoTrace setup.

Voir l'exemple suivant serverless.yml:

service: service-a

provider:
  name: aws
  runtime: nodejs16.x
  stage: dev
  region: us-east-2

functions:
  with-layer:
    environment:
      INSTANA_ENDPOINT_URL: INSTANA_ENDPOINT_URL
      INSTANA_AGENT_KEY: INSTANA_AGENT_KEY
      LAMBDA_HANDLER: src/index.handler
    layers:
      - arn:aws:lambda:us-east-2:410797082306:layer:instana-nodejs:111
    handler: instana-aws-lambda-auto-wrap.handler

service: service-b

provider:
  name: aws
  runtime: nodejs12.x
  stage: dev
  region: us-east-2

plugins:
  - serverless-offline

custom:
  serverless-offline:
    useDocker: true

functions:
  with-serverless-offline:
    environment:
      NODE_PATH: $NODE_PATH:/opt/nodejs/node_modules
      INSTANA_ENDPOINT_URL: INSTANA_ENDPOINT_URL
      INSTANA_AGENT_KEY: INSTANA_AGENT_KEY
      LAMBDA_HANDLER: src/index.handler
    layers:
      - arn:aws:lambda:us-east-2:410797082306:layer:instana-nodejs:111
    handler: instana-aws-lambda-auto-wrap.handler

service: service-c

provider:
  name: aws
  runtime: nodejs12.x
  stage: dev
  region: us-east-2

plugins:
  - serverless-webpack

package:
  individually: true

functions:
  with-serverless-webpack:
    environment:
      INSTANA_ENDPOINT_URL: INSTANA_ENDPOINT_URL
      INSTANA_AGENT_KEY: INSTANA_AGENT_KEY
      LAMBDA_HANDLER: src/index.handler
    layers:
      - arn:aws:lambda:us-east-2:410797082306:layer:instana-nodejs:110
    handler: instana-aws-lambda-auto-wrap.handler
    entrypoint: src/index.handler