Avant de créer une macro, passez en revue les autorisations de macro, et les règles de nommage, et d’expression ci-dessous. Une macro qui ne respecte pas ces règles échoue à la validation lorsque vous essayez de l’enregistrer.
Règles et limites des macros
Important
Les macros sont visibles par tous les utilisateurs de votre organisation. N’incluez pas d’informations sensibles ou spécifiques à un compte lorsque vous créez ou mettez à jour une macro.
Accéder aux macros
Dans la plateforme New Relic, accédez à Administration > NRQL Macros. Depuis cette page, vous pouvez afficher, créer, modifier et supprimer des macros.
Créer une macro
Depuis la page NRQL Macros, créez une macro en fournissant un nom unique et une expression. Suivez les règles de nommage et d’ expression. Ne préfixez pas le nom avec le caractère $. Par exemple, pour enregistrer une condition de clause WHERE, saisissez appName = 'ProductionApp' AND environment = 'prod' sans le mot-clé WHERE.
Une fois que vous avez créé une macro, elle apparaît dans la liste NRQL Macros. Vous pouvez l’utiliser dans n’importe quelle requête NRQL dans tout New Relic.
Vous pouvez également créer, mettre à jour, et effectuer des requêtes sur des macros par programmation à l’aide de l’ API NerdGraph. Avant de créer, ou de mettre à jour des macros, passez en revue les règles de nommage, les règles d’expression, et les limitations.
Pour commencer, accédez à l’ explorateur d’API NerdGraph. Si vous avez besoin d’aide pour utiliser l’explorateur d’API NerdGraph, consultez le tutoriel de l’explorateur d’API NerdGraph.
Utilisez la mutation entityManagementCreateNrqlMacro :
mutation CreateMacro($name: String!, $expression: String!, $orgId: ID!) { entityManagementCreateNrqlMacro( nrqlMacroEntity: { expression: $expression name: $name scope: { type: ORGANIZATION, id: $orgId } } ) { entity { id name expression } }}Variables d’exemple :
{ "name": "prod_filter", "expression": "(appName = 'ProductionApp' AND environment = 'prod')", "orgId": "your-organization-id"}Pour trouver l’ID de votre organisation, consultez Trouver l’ID de votre organisation ou de votre macro.
Utiliser une macro dans une requête
Pour utiliser une macro dans vos requêtes NRQL, tapez $ suivi du nom de la macro dans le générateur de requêtes. Par exemple, supposons que vous ayez une macro nommée prod_filter avec l’expression appName = 'ProductionApp' AND environment = 'prod'. Vous pouvez l’utiliser dans une requête comme celle-ci :
SELECT count(*) FROM Transaction WHERE $prod_filter SINCE 1 hour agoLorsque la requête s’exécute, New Relic remplace la macro par son expression :
SELECT count(*) FROM Transaction WHERE appName = 'ProductionApp' AND environment = 'prod' SINCE 1 hour agoConseil
Entourez les noms de macros contenant des caractères spéciaux avec des backticks au moment de la requête. Par exemple : $`my#Macro`.
Important
Les macros sont intégrées en ligne avant l’exécution, ce qui affecte la priorité des opérateurs binaires. Par exemple, une macro nommée five définie comme 1 + 4, et utilisée comme $five * 3 est évaluée à 13, et non à 15, car l’expression devient 1 + 4 * 3. Pour éviter cela, entourez l’expression de parenthèses lorsque vous définissez la macro, comme dans (1 + 4), ou entourez la macro de parenthèses lorsque vous l’utilisez, comme dans ($five) * 3. L’une ou l’autre approche est correctement évaluée à 15.
Les exemples suivants montrent des macros résolvant des problèmes de requête courants :
Gérer les macros
Modifier une macro
Depuis la page NRQL Macros, sélectionnez la macro et mettez à jour son expression, en suivant les règles d’expression.
Vous pouvez également mettre à jour l’expression d’une macro par programmation à l’aide de NerdGraph. Consultez les règles d’expression avant de la mettre à jour.
Utilisez la mutation entityManagementUpdateNrqlMacro .
mutation UpdateMacro($expression: String!, $macroId: ID!) { entityManagementUpdateNrqlMacro( id: $macroId nrqlMacroEntity: { expression: $expression } ) { entity { id name expression } }}Variables d’exemple :
{ "expression": "(appName = 'ProductionApp' AND environment = 'prod' AND region = 'us-east-1')", "macroId": "your-macro-id"}Pour trouver l’ID d’une macro, consultez Trouver l’ID de votre organisation ou de votre macro.
Important
Lorsque vous modifiez une macro, toutes les requêtes utilisant cette macro utilisent automatiquement la version mise à jour. Passez en revue vos modifications pour vous assurer qu’elles ne cassent pas les requêtes existantes. En raison de la mise en cache, il peut y avoir un léger délai avant que la mise à jour ne prenne effet. Vous ne pouvez pas mettre à jour le nom d’une macro après sa création. Si vous devez modifier le nom, supprimez la macro et créez-en une nouvelle.