Migration des règles de suppression vers les règles cloud de Pipeline

Téléchargez et ajoutez le script de validation

Téléchargez le fichier outputs.tf à partir de la base de données GitHub du fournisseur New Relic Terraform et ajoutez-le à votre espace de travail Terraform CI/CD (intégration et livraison continue).

Ce script fournit un système de validation et d'extraction des ressources de règles de suppression, en exportant leurs identifiants au format JSON pour une utilisation dans les procédures de migration.

Configurez le script pour vos types de règles de suppression

Le script prend en charge deux types de règles de suppression :

• Règles de suppression autonomes: newrelic_nrql_drop_rule ressources définies directement dans votre configuration (non encapsulées dans un module)

• Règles de suppression modulaires: newrelic_nrql_drop_rule ressources encapsulées dans un module Terraform

  Dans le fichier outputs.tf que vous venez d'ajouter, définissez les indicateurs appropriés dans le bloc locals pour activer le traitement de vos types de règles de suppression :

  locals {
    # Enable for standalone drop rules
    enable_standalone_drop_rules = true
  
    # Enable for modular drop rules
    enable_modular_drop_rules = false
  }

  Copier

  Définissez enable_standalone_drop_rules sur true si vous avez des règles de suppression autonomes. Configurez enable_modular_drop_rules à true si vous avez des règles de suppression modulaires. Vous pouvez activer les deux si vous possédez les deux types.

Ajoutez vos règles de dépôt autonomes (le cas échéant).

Si vous avez des règles de suppression autonomes et que vous les avez activées à l'étape précédente, identifiez toutes les ressources autonomes newrelic_nrql_drop_rule dans votre configuration Terraform.

Par exemple, si votre configuration Terraform comporte ces règles de suppression autonomes :

resource "newrelic_nrql_drop_rule" "drop_debug_logs" {
  account_id  = var.new_relic_account_id
  description = "Filters out debug level logs"
  action      = "drop_data"
  nrql        = "SELECT * FROM Log WHERE level = 'debug'"
}

resource "newrelic_nrql_drop_rule" "drop_health_checks" {
  account_id  = var.new_relic_account_id
  description = "Removes health check logs"
  action      = "drop_data"
  nrql        = "SELECT * FROM Log WHERE endpoint = '/health'"
}

resource "newrelic_nrql_drop_rule" "drop_pii_data" {
  account_id  = var.new_relic_account_id
  description = "Filters out PII data"
  action      = "drop_data"
  nrql        = "SELECT * FROM Log WHERE contains(message, 'SSN')"
}

Pour chaque ressource, vous devez noter l'identifiant de la ressource et la référence complète de la ressource. Par exemple, dans la ressource newrelic_nrql_drop_rule.drop_debug_logs:

• L'identifiant de la ressource est drop_debug_logs
• La référence complète de la ressource est newrelic_nrql_drop_rule.drop_debug_logs

Dans le fichier outputs.tf, ajoutez ces ressources à la liste standalone_rules dans la section des règles de suppression autonomes désignées :

# Configure standalone drop rules here
standalone_rules = local.enable_standalone_drop_rules ? [
  {
    name     = "drop_debug_logs"
    resource = newrelic_nrql_drop_rule.drop_debug_logs
  },
  {
    name     = "drop_health_checks"
    resource = newrelic_nrql_drop_rule.drop_health_checks
  },
  {
    name     = "drop_pii_data"
    resource = newrelic_nrql_drop_rule.drop_pii_data
  }
] : []

$
terraform state list | \
>
  grep 'newrelic_nrql_drop_rule' | \
>
  grep -v '^module\.' | \
>
  sed -E \
>
    -e '/\.([^[]+)\["/ s/^.*\.([^[]+)\["([^"]+)"\].*$/  {\n    name     = "\1_\2"\n    resource = &\n  },/' \
>
    -e 't' \
>
    -e '/\.([^[]+)\[[0-9]/ s/^.*\.([^[]+)\[([0-9]+)\].*$/  {\n    name     = "\1_\2"\n    resource = &\n  },/' \
>
    -e 't' \
>
    -e 's/^.*\.([^ ]+)$/  {\n    name     = "\1"\n    resource = &\n  },/'

Ajoutez vos règles de dépôt modulaires (le cas échéant).

Si vous avez des règles de dépôt modulaires et que vous les avez activées à l'étape 2, vous devez vous assurer que vos modules exportent un attribut all_rules avant de les ajouter au script.

Prérequis: Vos modules doivent exporter un attribut all_rules qui contient des références à toutes les ressources newrelic_nrql_drop_rule gérées par le module.

Si vous avez les mêmes trois règles de suppression que celles décrites à l'étape précédente, ajoutez cette sortie à votre module :

output "all_rules" {
  description = "A map of all drop rule resource objects created by this module."
  value = {
    debug_logs    = newrelic_nrql_drop_rule.drop_debug_logs
    health_checks = newrelic_nrql_drop_rule.drop_health_checks
    pii_data      = newrelic_nrql_drop_rule.drop_pii_data
  }
}

Ensuite, dans le fichier outputs.tf, ajoutez le module à la liste _modular_rules_raw dans la section des règles de suppression modulaire désignée :

# Configure modular drop rules here
_modular_rules_raw = local.enable_modular_drop_rules ? [
  {
    name     = "production_drop_rules"
    resource = module.drop_rules["production_drop_rules"].all_rules
  }
] : []

$
terraform state list | \
>
  grep '^module\..*newrelic_nrql_drop_rule' | \
>
  sed -E 's/(\.newrelic_nrql_drop_rule.*)//' | \
>
  sort -u | \
>
  sed -E 's/^module\.([^[]+)\["([^"]+)"\]$/  {\n    name     = "\2"\n    resource = module.\1\["\2"].all_rules\n  },/'

Exécuter le plan Terraform

Dans votre environnement CI/CD (intégration et livraison continue), exécutez :

$
terraform plan

Si le plan réussit, vous devriez voir un message de réussite dans le résultat :

Changes to Outputs:
  + a_validation_success = "✅ All listed resources export pipeline_cloud_rule_entity_id"

Cela confirme que toutes les ressources de règles de suppression sont correctement configurées et exportent l'attribut pipeline_cloud_rule_entity_id. Vous pouvez maintenant procéder à l'exécution de terraform apply.

Si vous voyez des erreurs de validation comme celle-ci :

Changes to Outputs:
  + validation_errors = [
      + "❌ Drop rule 'drop_debug_logs' does not export `pipeline_cloud_rule_entity_id` or it is null",
      + "❌ Drop rule 'drop_health_checks' does not export `pipeline_cloud_rule_entity_id` or it is null",
      + "❌ Drop rule 'drop_pii_data' does not export `pipeline_cloud_rule_entity_id` or it is null",
    ]

Cela signifie que vous n'utilisez pas New Relic Terraform Provider >= v3.73.0. Mettez à jour la version de votre fournisseur dans votre configuration Terraform vers la version 3.73.0 ou supérieure, puis exécutez à nouveau terraform plan .

Exécutez terraform apply

Après avoir vérifié que le résultat du plan affiche le message de réussite, exécutez :

$
terraform apply

Une fois l'application terminée avec succès, vous verrez un résultat similaire à celui-ci :

Apply complete! Resources: 0 added, 0 changed, 0 destroyed.

Outputs:

a_validation_success = "✅ All listed resources export pipeline_cloud_rule_entity_id"
experimental_drop_rule_resource_ids = "{\"drop_rule_resource_ids\":[{\"id\":\"3806526:106878882\",\"name\":\"drop_debug_logs\",\"pipeline_cloud_rule_entity_id\":\"MzgwNjUyNnxORVVMS...\"},{\"id\":\"3806526:106878883\",\"name\":\"drop_health_checks\",\"pipeline_cloud_rule_entity_id\":\"MzgwNjUyNnxORVVMS...\"},{\"id\":\"3806526:106878884\",\"name\":\"drop_pii_data\",\"pipeline_cloud_rule_entity_id\":\"MzgwNjUyNnxORVVMS...\"}]}"
experimental_drop_rule_resource_ids_formatted = <<EOT
{
  "drop_rule_resource_ids": [
    {
      "name": "drop_debug_logs",
      "id": "3806526:106878882",
      "pipeline_cloud_rule_entity_id": "MzgwNjUyNnxORVVMS..."
    },
    {
      "name": "drop_health_checks",
      "id": "3806526:106878883",
      "pipeline_cloud_rule_entity_id": "MzgwNjUyNnxORVVMS..."
    },
    {
      "name": "drop_pii_data",
      "id": "3806526:106878884",
      "pipeline_cloud_rule_entity_id": "MzgwNjUyNnxORVVMS..."
    }
  ]
}
EOT

Copiez la sortie JSON

Copiez la chaîne JSON complète de la sortie experimental_drop_rule_resource_ids_formatted. Vous en aurez besoin pour la phase 2.

Définir les variables d'environnement requises

Avant d'exécuter la commande CLI, assurez-vous que les variables d'environnement requises sont définies :

$
export NEW_RELIC_API_KEY="your-api-key"
$
export NEW_RELIC_ACCOUNT_ID="your-account-id"
$
export NEW_RELIC_REGION="US"  # Optional, defaults to 'US'

Enregistrez la sortie JSON dans un fichier

Créez un fichier JSON (par exemple, drop_rules.json) dans votre répertoire d'espace de travail Terraform et collez la sortie JSON de la phase 1.

{
  "drop_rule_resource_ids": [
    {
      "name": "drop_debug_logs",
      "id": "3806526:106878882",
      "pipeline_cloud_rule_entity_id": "MzgwNjUyNnxORVVMS..."
    },
    {
      "name": "drop_health_checks",
      "id": "3806526:106878883",
      "pipeline_cloud_rule_entity_id": "MzgwNjUyNnxORVVMS..."
    },
    {
      "name": "drop_pii_data",
      "id": "3806526:106878884",
      "pipeline_cloud_rule_entity_id": "MzgwNjUyNnxORVVMS..."
    }
  ]
}

Exécutez la commande de migration de l'interface de ligne de commande New Relic

Accédez à votre répertoire d'espace de travail Terraform et exécutez :

$
newrelic migrate nrqldroprules tf-importgen-ci --file drop_rules.json

Paramètres de la commande :

Exemple utilisant le paramètre --json :

Si vous préférez ne pas créer de fichier, vous pouvez transmettre directement la chaîne JSON :

$
newrelic migrate nrqldroprules tf-importgen-ci \
>
  --json '{"drop_rule_resource_ids":[{"name":"drop_debug_logs","id":"3806526:106878882","pipeline_cloud_rule_entity_id":"MzgwNjUyNnxORVVMS..."}]}'

Examinez les fichiers générés

La commande CLI génère trois fichiers de configuration Terraform dans votre espace de travail :

• provider.tf: configuration du fournisseur Terraform et New Relic avec contraintes de version.

• imports.tf: Blocs d'importation qui relient les nouvelles ressources aux règles cloud Pipeline existantes dans New Relic.

• pcrs.tf: Définitions de ressources de règles cloud Pipeline (générées automatiquement lors de l'exécution de la commande).

  La commande affiche également des recommandations pour supprimer les anciennes règles de suppression de l'état Terraform, que vous utiliserez dans la phase 3.

Validez et envoyez la configuration générée

Ajoutez les fichiers Terraform générés à votre référentiel git :

$
git add .
$
git commit -m "Add Pipeline cloud rule migration configuration"
$
git push origin your-branch-name

Cela déclenchera le traitement des modifications par votre pipeline CI/CD lors de la phase 3.

Examinez le plan Terraform

Après avoir poussé vos modifications, votre pipeline CI/CD se déclenchera automatiquement et publiera un commentaire de plan sur votre demande de tirage. Le résultat du plan affichera :

• Ressources importées : Trois ressources newrelic_pipeline_cloud_rule

• Résumé du plan : Plan: 3 to import, 0 to add, 0 to change, 0 to destroy

  / Exemple de sortie du plan Terraform : diff Terraform effectuera les actions suivantes : # newrelic_pipeline_cloud_rule.drop_debug_logs sera importée ressource "newrelic_pipeline_cloud_rule" "drop_debug_logs" { account_id = 3806526 description = "Filtre les logs de niveau débogage de l'environnement de production pour réduire le volume de données" id = "MzgwNjUyNnxOR0VQfFBJUEVMSU5FX0NMT1VEX1JVTEV8MDE5OTRjZjgtYmFmNy03MjU3LWE3M2MtZWY5OTkxYTQxMjgy" name = " Règle de suppression NRQL ID : 106878882 créée par l'utilisateur ID : 1004672904 créée à : 2025-09-15T10:43:13.122888Z" NRQL = "DELETE FROM `Log` WHERE ((`level` = 'debug') AND (`environment` = 'production'))" } # newrelic_pipeline_cloud_rule.drop_health_checks sera importée ressource "newrelic_pipeline_cloud_rule" "drop_health_checks" { account_id = 3806526 description = "Supprime les attributs userEmail et userName des données MyCustomEvent" id = "MzgwNjUyNnxOR0VQfFBJUEVMSU5FX0NMT1VEX1JVTEV8MDE5OTRjZmItMTQ0Yy03NDM5LWJhNDYtZjI4MTg0ODc5YmE2" name = " ID de la règle de suppression NRQL : 106878884 créé par l'utilisateur ID : 1004672904 créé le : 2025-09-15T10:45:47.049993Z" NRQL = "DELETE `userEmail`, `userName` FROM `MyCustomEvent`" } # newrelic_pipeline_cloud_rule.drop_pii_data sera importée ressource "newrelic_pipeline_cloud_rule" "drop_pii_data" { account_id = 3806526 description = "Exclut l'attribut containerId des agrégats métriques" id = "MzgwNjUyNnxOR0VQfFBJUEVMSU5FX0NMT1VEX1JVTEV8MDE5OTRjZmItMTQ4Ni03MDI4LWJlMDktZmYzOTM2NWQ4ODUw" name = " Règle de suppression NRQL ID : 106878885 créée par l'utilisateur ID : 1004672904 créée le : 2025-09-15T10:45:47.060296Z" NRQL = "DELETE `containerId` FROM `MetricAggregate`" } Plan : 3 à importer, 0 à ajouter, 0 à modifier, 0 à détruire. /

Appliquer les modifications

Une fois que vous avez examiné le plan et confirmé qu'il vous semble correct, commentez votre demande de tirage :

$
terraform apply

Votre pipeline CI/CD exécutera la commande Terraform apply, qui importera les règles cloud Pipeline dans l'état Terraform.

Exemple de résultat de l'application :

newrelic_pipeline_cloud_rule.drop_health_checks: Importing...
newrelic_pipeline_cloud_rule.drop_health_checks: Import complete
newrelic_pipeline_cloud_rule.drop_debug_logs: Importing...
newrelic_pipeline_cloud_rule.drop_debug_logs: Import complete
newrelic_pipeline_cloud_rule.drop_pii_data: Importing...
newrelic_pipeline_cloud_rule.drop_pii_data: Import complete

Apply complete! Resources: 3 imported, 0 added, 0 changed, 0 destroyed.

Nettoyer les anciennes règles de drop de l'État

Une fois l'importation terminée avec succès, vous devez supprimer les anciennes ressources newrelic_nrql_drop_rule de votre état Terraform. Utilisez les recommandations fournies dans la sortie CLI de la phase 2.

Dans votre environnement CI/CD (intégration et livraison continues) ou localement, exécutez les commandes terraform state rm pour chaque ancienne règle de suppression :

$
terraform state rm newrelic_nrql_drop_rule.drop_debug_logs
$
terraform state rm newrelic_nrql_drop_rule.drop_health_checks
$
terraform state rm newrelic_nrql_drop_rule.drop_pii_data

Vérifiez la migration

Après avoir nettoyé l'État :

• Vérifiez le résultat pour confirmer que toutes les importations ont été effectuées avec succès.
• Vérifiez dans l'interface utilisateur de New Relic que vos règles cloud Pipeline sont toujours actives et fonctionnelles.
• Exécutez terraform plan pour confirmer qu'il n'y a pas de modifications en attente (le résultat devrait afficher « Aucune modification »).
• Confirmez que les anciennes règles de suppression n'apparaissent plus dans terraform state list.

Fusionnez votre demande de tirage

Une fois la vérification terminée, fusionnez votre demande de tirage pour finaliser la migration. Votre configuration Terraform gère désormais les règles cloud de Pipeline au lieu des règles de suppression NRQL.

Accédez à votre espace de travail Terraform.

Ouvrez votre terminal et accédez au répertoire contenant vos fichiers de configuration Terraform avec les ressources newrelic_nrql_drop_rule.

$
cd /path/to/your/terraform/workspace

Exécutez la commande de mise à jour de l'interface de ligne de commande New Relic

Exécutez la commande suivante pour mettre à jour votre état Terraform :

$
newrelic migrate nrqldroprules tf-update

Cette commande automatiquement :

• Analyse votre espace de travail Terraform pour identifier toutes les ressources newrelic_nrql_drop_rule.
• Exécute les opérations terraform plan et terraform apply sur ces ressources.
• Met à jour votre fichier d'état Terraform avec l'attribut pipeline_cloud_rule_entity_id pour chaque règle de suppression.

Vérifier la mise à jour de l'état

Une fois la commande terminée, votre fichier d'état Terraform contient désormais la modélisation entre les règles de suppression et les règles cloud Pipeline. Vous pouvez le vérifier en consultant votre état :

$
terraform show -json | grep pipeline_cloud_rule_entity_id

Vous devriez voir les valeurs pipeline_cloud_rule_entity_id pour chaque règle de suppression dans le résultat. Cela confirme que votre fichier d'état a été mis à jour avec succès. L'interface de ligne de commande lira automatiquement ces valeurs à l'étape suivante.

Exécutez la commande de génération d'importation de l'interface de ligne de commande New Relic

Dans votre répertoire d'espace de travail Terraform, exécutez :

$
newrelic migrate nrqldroprules tf-importgen

Cette commande automatiquement :

• Vérifie que les ressources de la règle de suppression contiennent des valeurs pipeline_cloud_rule_entity_id.
• Génère des blocs d'importation pour chaque règle cloud Pipeline.
• Exécute terraform plan -generate-config-out=generated_pipeline_rules.tf pour créer la configuration de règle cloud Pipeline.
• Exécute terraform apply pour importer les règles cloud Pipeline dans l'état Terraform.

Examiner les résultats de l'importation

Une fois la commande exécutée avec succès, les règles cloud de Pipeline sont importées dans votre état Terraform. La commande génère le fichier generated_pipeline_rules.tf contenant les définitions de ressources de règles cloud Pipeline créées par terraform plan -generate-config-out.

Exécutez la commande de désinscription de l'interface de ligne de commande New Relic

Dans votre répertoire d'espace de travail Terraform, exécutez :

$
newrelic migrate nrqldroprules tf-delist

Cette commande :

• Affiche des avertissements de sécurité confirmant que les ressources ne seront retirées que de l'état
• Supprime toutes les ressources newrelic_nrql_drop_rule de l'état Terraform
• Fournit des instructions pour nettoyer vos fichiers de configuration Terraform

Nettoyez votre configuration Terraform

Une fois la commande delist terminée, vous devez placer un commentaire ou supprimer tous les blocs de ressources newrelic_nrql_drop_rule de vos fichiers configuration Terraform pour empêcher leur recréation.

Vérifiez la migration

Après avoir nettoyé vos fichiers de configuration, vérifiez la migration :

$
# Confirm Pipeline cloud rules are in state
$
terraform state list | grep pipeline_cloud_rule
$

$
# Confirm old drop rules are removed from state
$
terraform state list | grep nrql_drop_rule
$

$
# Verify no pending changes
$
terraform plan

En cas de succès, terraform plan devrait afficher « Aucun changement ».