Actions AWS CloudWatch

Cette page fournit une référence pour les actions AWS CloudWatch disponibles dans le catalogue des actions d'automatisation des workflows. Utilisez ces actions pour récupérer et charger des données de log dans AWS CloudWatch.

Prérequis

Pour les prérequis et la configuration des identifiants, consultez Configurer les identifiants AWS.

Get événement de log

L’identifiant de l’action est aws.cloudwatch.getLogEvents.

Récupère un lot d'événements de log à partir d'un flux de log spécifié dans AWS CloudWatch Logs.

Le tableau suivant décrit les champs d’entrée pour cette action.

Saisir	Type	Description	Exemple
`awsRoleArn`	Chaîne	Facultatif. ARN du rôle IAM à assumer pour les appels d'API AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Chaîne	Facultatif. ID de clé d’accès AWS. Passer en tant que secret.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Chaîne	Facultatif. Clé d’accès secrète AWS. Passer en tant que secret.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Chaîne	Facultatif. Jeton de session temporaire pour l'authentification STS. Transmettez en tant que secret.	`${{ :secrets:awsSessionToken }}`
`region`	Chaîne	Obligatoire. Région AWS du groupe de log cible.	`us-east-2`
`logStreamName`	Chaîne	Obligatoire. Nom du flux de log à partir duquel récupérer les événements.	`2023/10/27/[$LATEST]abcdef123456`
`logGroupName`	Chaîne	Facultatif. Nom du groupe de log contenant le flux de log.	`/aws/lambda/my-function`
`logGroupIdentifier`	Chaîne	Facultatif. ARN ou nom du groupe de logs. Utilisez à la place de `logGroupName` lorsque vous référencez un groupe de logs par ARN.	`arn:partition:service:region:account-id:resource`
`startTime`	Int	Facultatif. Début de la plage de temps, exprimé sous forme d'horodatage Unix en millisecondes.	`1759296000000`
`endTime`	Int	Facultatif. Fin de la plage de temps, exprimée sous forme d'horodatage Unix en millisecondes.	`1759296000000`
`limit`	Int	Facultatif. Nombre maximum d'événements de log à renvoyer.	`50`
`startFromHead`	Booléen	Facultatif. Si `true` , renvoie d'abord les événements de log les plus anciens. La valeur par défaut est `false` .	`true`
`unmask`	Booléen	Facultatif. Si `true` , renvoie les données d'événement de log non masquées. La valeur par défaut est `false` .	`false`
`nextToken`	Chaîne	Facultatif. Jeton de pagination d'une réponse précédente pour récupérer la page de résultats suivante.	`f/39218833627378687642013305455131706539523449361490509828/s`

Le tableau suivant décrit les champs de sortie pour cette action.

Sortir	Type	Exemple
`response`	Objet	`{"events": [{"timestamp": 123, "message": "string", "ingestionTime": 123}], "nextForwardToken": "string", "nextBackwardToken": "string"}`
`success`	Booléen	`true` ou `false`
`errorMessage`	Chaîne	`"An error occurred (ExpiredTokenException) when calling the GetLogEvents operation: The security token included in the request is expired"`

Sortir

Type

Exemple

response

Objet

{"events": [{"timestamp": 123, "message": "string", "ingestionTime": 123}], "nextForwardToken": "string", "nextBackwardToken": "string"}

success

Booléen

true

false

errorMessage

Chaîne

"An error occurred (ExpiredTokenException) when calling the GetLogEvents operation: The security token included in the request is expired"

L'exemple de workflow suivant montre comment utiliser cette action.

name: get-lambda-logs
description: 'Retrieve log events from an AWS Lambda function'
workflowInputs:
  region:
    type: String
    defaultValue: us-east-2
  logGroupName:
    type: String
    defaultValue: /aws/lambda/my-function
  logStreamName:
    type: String
    defaultValue: 2023/10/27/[$LATEST]abcdef123456
steps:
  - name: get_events_step
    type: action
    action: aws.cloudwatch.getLogEvents
    version: '1'
    inputs:
      region: ${{ .workflowInputs.region }}
      logGroupName: ${{ .workflowInputs.logGroupName }}
      logStreamName: ${{ .workflowInputs.logStreamName }}
      limit: 100
    next: end

Téléverser des événements de log

L’identifiant de l’action est aws.cloudwatch.putLogEvents.

Télécharge un lot d'événements de log vers le flux de log spécifié dans AWS CloudWatch Logs.