Démarrer avec la CLI New Relic

Installer la CLI New Relic

Téléchargez la CLI New Relic pour votre système d’exploitation, comme décrit ci-dessous. Vous pouvez également télécharger des binaires pré-compilés pour toutes les plateformes, y compris .deb et .rpm package et notre Windows x64 .msi programme d'installation.

Linux

En utilisant Snapcraft, exécutez :

$
sudo snap install newrelic-cli

macOS

En utilisant Homebrew, exécutez :

$
brew install newrelic-cli

Windows

En utilisant Scoop, exécutez :

$
scoop bucket add newrelic-cli https://github.com/newrelic/newrelic-cli.git
$
scoop install newrelic-cli

Créez votre profil CLI New Relic

Après avoir installé la CLI New Relic, il est temps de créer votre premier profil. Les profils contiennent des informations d’identification et des paramètres que vous pouvez appliquer à n’importe quelle commande CLI, ce qui est utile lors du basculement entre les comptes.

Exécutez la commande profiles add :

$
# Create the tutorial account for the US region
$
newrelic profiles add --profile tutorial --apiKey YOUR_NEW_RELIC_USER_KEY -r YOUR_REGION
$
# Set the profile as defaults
$
newrelic profiles default --profile tutorial

Obtenez les détails de votre candidature

Maintenant, ajoutez une balise à l’application que vous avez instrumentée avec New Relic. Les tags sont des paires valeur-clé qui peuvent vous aider à organiser et à filtrer votre entité. Une entité (par exemple, une application) peut avoir un maximum de 100 paires valeur-clé qui lui sont liées.

Avant de rechercher votre application à l'aide de la CLI New Relic, notez ou copiez votre ID de compte et le nom de votre application dans New Relic : vous avez besoin des deux pour trouver des applications sur la plateforme New Relic.

Récupérez les détails de votre application sous forme d'objet JSON

Pour rechercher votre application APM, utilisez la commande apm application search :

$
newrelic apm application search --accountId YOUR_ACCOUNT_ID --name NAME_OF_YOUR_APP

Trouver la valeur guid

Si l'ID de compte est valide et que le nom de l'application existe dans votre compte, apm application search génère des données similaires à cet exemple :

[
  {
    "accountId": YOUR_ACCOUNT_ID,
    "applicationId": YOUR_APP_ID,
    "domain": "APM",
    "entityType": "APM_APPLICATION_ENTITY",
    "guid": "A_LONG_GUID",
    "name": "NAME_OF_YOUR_APP",
    "permalink": "https://one.newrelic.com/redirect/entity/A_LONG_GUID",
    "reporting": true,
    "type": "APPLICATION"
  }
]

Lorsque vous avez recherché avec succès votre application, recherchez la valeur guid . C'est un identifiant unique pour votre application. Vous devriez le copier ou l'écrire.

Ajoutez une tag simple à votre application

Maintenant que vous disposez du GUID, vous pouvez pointer la CLI New Relic directement vers votre application. L'ajout d'une tag est le moyen le plus simple de tester les fonctionnalités de la CLI (ne vous inquiétez pas, la balise peut être supprimée en utilisant entity tags delete).

Ici, vous ajoutez une tag d’environnement à votre application. Ajoutez la balise dev:testing (ou toute autre paire valeur-clé) à votre application à l'aide de la commande entities tags create :

$
newrelic entity tags create --guid YOUR_APP_GUID --tag devkit:testing

Ajouter des ensembles tag

Et si vous souhaitez ajouter plusieurs balises ? les ensembles de balises à la rescousse ! Alors que les balises sont des paires de valeurs-clés séparées par des deux points, les ensembles tag sont des listes de balises séparées par des virgules. Par exemple:

tag1:value1,tag2:value2

Pour ajouter plusieurs balises à votre application à la fois, modifiez et exécutez ce snippet:

$
newrelic entity tags create --guid YOUR_APP_GUID --tag tag1:test,tag2:test

Récupérez le tag de votre application

Vous avez créé et ajouté des balises à votre application, mais pour tester leur fonctionnement, vous devez les récupérer.

Exécutez la commande entity tags get :

$
newrelic entity tags get --guid YOUR_APP_GUID

Toutes les balises associées à votre application sont récupérées sous forme d'un éventail JSON :

[
  {
    "Key": "tag1",
    "Values": ["true"]
  },
  {
    "Key": "tag2",
    "Values": ["test"]
  },
  {
    "Key": "tag3",
    "Values": ["testing"]
  }
  // ...
]

Étape bonus : créer un marqueur de déploiement

le déploiement des applications se passe souvent mal. Les marqueurs de déploiement sont des étiquettes qui, une fois attachées aux données de votre application, vous aident à suivre le déploiement et à résoudre les problèmes qui se sont produits.

Pour créer un marqueur de déploiement, exécutez la commande apm deployment create en utilisant le même identifiant d'application que celui de votre recherche précédente :

$
newrelic apm deployment create --applicationId YOUR_APP_ID --revision $(git describe --tags --always)

Vérifiez la réponse JSON pour la révision et l'horodatage du déploiement

Vous pouvez intégrer ce workflow dans un système d'intégration continue ou de déploiement continu (CI/CD (intégration et livraison continue)) pour indiquer les changements dans le comportement de votre application après déploiement.

Voici un exemple :

{
  "id": 37075986,
  "links": {
    "application": 204261368
  },
  "revision": "v1.2.4",
  "timestamp": "2020-03-04T15:11:44-08:00",
  "user": "Developer Toolkit Test Account"
}