Démarrer et planifier le workflow

Une fois votre workflow créé, vous pouvez l'exécuter manuellement à la demande ou le programmer pour qu'il s'exécute automatiquement à des heures précises. Les deux méthodes utilisent l' API NerdGraph pour déclencher l'exécution workflow.

Choisissez votre méthode de déclenchement

Choisissez l'approche la plus adaptée à votre cas d'utilisation :

Avant de commencer

Avant de déclencher le workflow, assurez-vous d'avoir :

• Workflow créé: Une définition workflow déjà déployée dans votre compte (à partir d'un modèle ou personnalisée).
• ID du compte: Votre ID de compte New Relic (disponible dans les paramètres du compte).
• Nom du workflow: Le nom exact figurant dans votre définition workflow.
• Entrées requises: Valeurs de tous les paramètres attendus par votre workflow.
• Secrets configurés: identifiants AWS, jeton Slack ou autres secrets stockés dans le gestionnaire de secrets.

Exécuter le workflow à la demande

Déclenchez manuellement des workflows à l'aide de l' API StartWorkflowRun. Cela exécute immédiatement le workflow avec les données que vous fournissez.

Exemple : Appeler une fonction AWS Lambda

La définition workflow suivante invoque une fonction AWS Lambda et enregistre la sortie. Remplacez 12345678 par votre identifiant de compte New Relic.

name: lambda1

  workflowInputs:
    username:
      type: String
      defaultValue: "User"
    key:
      type: String
      defaultValue: "${{ :secrets:12345678:USERNAME_AWS_ACCESS_KEY_ID }}"
    access:
      type: String
      defaultValue: "${{ :secrets:12345678:USERNAME_AWS_SECRET_ACCESS_KEY }}"
    token:
      type: String
      defaultValue: "${{ :secrets:12345678:USERNAME_AWS_SESSION_TOKEN }}"
    region:
      type: String
      defaultValue: us-east-1

  steps:
    - name: invoke1
      type: action
      action: aws.lambda.invoke
      version: 1
      inputs:
        awsAccessKeyId: ${{ .workflowInputs.key }}
        awsSecretAccessKey: ${{ .workflowInputs.access }}
        awsSessionToken: ${{ .workflowInputs.token }}
        region: ${{ .workflowInputs.region }}
        functionName: hello-you
        payload:
          user: ${{ .workflowInputs.username }}

    - name: logOutput
      type: action
      action: newrelic.ingest.sendLogs
      version: 1
      inputs:
        logs:
          - message: 'The lambda function message output is:${{ .steps.invoke1.outputs.payload.body }}'

Pour démarrer ce workflow, utilisez la mutation NerdGraph suivante. Avant d'exécuter cette mutation, assurez-vous d'avoir enregistré vos informations d'identification AWS à l'aide de la mutation secretsManagementCreateSecret. Pour plus d'informations, consultez l'Introduction à la gestion des secrets.

mutation {
  workflowAutomationStartWorkflowRun(
    # Specify the account where the workflow is defined
    scope: { type: ACCOUNT, id: "12345678" }

    # Reference the workflow definition by name
    definition: { name: "lambda1" }

    # Provide input values for the workflow
    workflowInputs: [
      { key: "key", value: "${{ :secrets:testUser123_AWS_ACCESS_KEY_ID }}" }
      {
        key: "access"
        value: "${{ :secrets:testUser123_AWS_SECRET_ACCESS_KEY }}"
      }
      { key: "token", value: "${{ :secrets:testUser123_AWS_SESSION_TOKEN }}" }
      { key: "region", value: "us-east-2" }
      { key: "username", value: "Julien" }
    ]
  ) {
    runId
  }
}

Explication des paramètres :

• scope: L'identifiant du compte où est stockée votre définition workflow
• definition: Le nom du workflow à exécuter (doit correspondre au champ name dans votre définition workflow )
• workflowInputs: paires clé-valeur qui remplacent les valeurs par défaut dans la section workflowInputs de votre définition workflow

La mutation renvoie un runId (par exemple, 7bd25287-2af8-42e1-b783-80f4e760a40b). Utilisez cet identifiant pour interroger les logs et afficher le résultat :

Planifier le workflow

Planifiez l'exécution automatique des workflows à des heures spécifiques à l'aide de l' API CreateSchedule. Les workflows planifiés exécutent des tâches récurrentes sans intervention manuelle.

Quand planifier le workflow :

• bilans de santé réguliers
• Traitement périodique des données
• Rapports quotidiens/hebdomadaires
• Fenêtres de maintenance programmées
• Sauvegardes ou nettoyages récurrents

Référence d'expression Cron

Les planifications utilisent des expressions cron pour définir le moment d'exécution des workflows. Format: minute hour day month weekday

Exemple : Planifier un bilan de santé quotidien

L'exemple suivant planifie l'exécution workflow lambda1 tous les jours à 9 h, heure de l'Est :

mutation {
  workflowAutomationCreateSchedule(
    # Specify the account where the workflow is defined
    scope: { type: ACCOUNT, id: "12345678" }

    # Reference the workflow definition by name
    definition: { name: "lambda1" }

    # Configure the schedule
    schedule: {
      # Cron expression: minute hour day month weekday
      # "0 9 * * *" = every day at 9:00 AM
      cronExpression: "0 9 * * *"
      # Timezone for the schedule
      timezone: "America/New_York"
      # Optional: Schedule name for identification
      name: "daily-lambda-health-check"
      # Optional: Add a description
      description: "Runs Lambda health check every morning at 9 AM"
    }

    # Provide input values for the workflow
    workflowInputs: [
      { key: "key", value: "${{ :secrets:testUser123_AWS_ACCESS_KEY_ID }}" }
      {
        key: "access"
        value: "${{ :secrets:testUser123_AWS_SECRET_ACCESS_KEY }}"
      }
      { key: "token", value: "${{ :secrets:testUser123_AWS_SESSION_TOKEN }}" }
      { key: "region", value: "us-east-2" }
      { key: "username", value: "HealthCheckBot" }
    ]
  ) {
    scheduleId
  }
}

Ce que vous obtenez en retour :

• scheduleId: Identifiant unique du planning (à utiliser pour mettre à jour ou supprimer le planning ultérieurement)

Gérer les horaires

Après avoir créé un planning :

• Afficher les planifications actives: Consultez toutes les exécutions planifiées dans le dashboardworkflow.
• Mise à jour du planning: Utilisez l’API UpdateSchedule pour modifier la fréquence ou les entrées.
• Supprimer une planification: utilisez l’API DeleteSchedule pour arrêter les exécutions récurrentes.

Pour obtenir la documentation complète de l'API, consultez la section API d'automatisation des workflows.

Prochaines étapes

Votre workflow est en cours ! Voici la prochaine étape :

Monitorer et gérer :

• Gérer le workflow: consulter l’historique des exécutions, vérifier les logs et résoudre les problèmes.
• Dépannage des workflows: Résoudre les problèmes d'exécution courants

Optimiser pour la production :

• bonnes pratiques: Modèles de gestion des erreurs, de performances et de fiabilité
• Limites du workflow: Comprendre les limites de délai d’expiration et de contrainte

Développez votre workflow :

• Catalogue d'actions: Explorez toutes les intégrations disponibles.
• API d'automatisation des workflows: Gestion programmatique workflow