Conseil
Cette procédure fait partie du cours qui vous apprend à créer un quickstart. Si vous ne l’avez pas déjà fait, consultez l’ introduction du cours.
Comme cette procédure s’appuie sur les dernières du laboratoire, assurez-vous de créer des composants de démarrage rapide et de les ajouter à un tableau de bord, des alertes et une source de données à votre démarrage rapide avant de procéder à celui-ci.
Dans les procédures précédentes, vous avez créé des composants quickstart et les avez ajoutés à leur répertoire respectif dans le modèle quickstart . Il est temps de créer le quickstart de Flashdb et de le publier sur GitHub afin qu'il soit disponible pour que tout le monde puisse l'utiliser.
Contribuer au quickstart sur GitHub
Si vous ne l’avez pas déjà fait, créez un fork du référentiel de démarrage rapide New Relic et clonez-le sur votre machine locale.
Ouvrez votre projet dans l'IDE de votre choix et accédez au répertoire \_template
.
Ici, copiez le répertoire quickstarts/example-quickstart
et son contenu dans le répertoire quickstarts
au niveau racine. Renommez le répertoire en flashdb
.
Ce répertoire contient un exemple de fichier config.yml pour créer un quickstart.
Accédez au fichier datasources/flashdb/config.yml
et ajoutez les détails de votre source de données. Pour votre information, la source de données flashdb doit être similaire à ce qui suit :
# Sets the URL name of the quickstart on public I/O (required)slug: flashdb
# Displayed in the UI (required)title: FlashDB
# Long-form description of the quickstart (required)description: | FlashDB is the fastest and lightest database in the universe. First, it can handle a large number of concurrent users without slowing down. Second, it has a very low latency, so queries are processed quickly. And finally, it scales easily as your data grows.
This quickstart allows users to monitor their database to ensure peak performance. It also notifies you if there's any problem with the database.
The flashdb quickstart includes: ## a dashboard where users can easily monitor: - Database methods - Average response time - Errors - Database size - Cache hits - Keys
## alert conditions where users are notified on: - slow read responses - low cache hit
# Displayed in search results and recommendations. Summarizes a quickstarts functionality.summary: | This quickstart allows users to monitor their flashdb database to ensure peak performance. It also notifies you if there's any problem with the database.
# Support level: New Relic | Verified | Community (required)level: Community
# Authors of the quickstart (required)authors: - Mehreen Tahir
# Keywords for filtering / searching criteria in the UIkeywords: - infrastructure - database
alertPolicies: - flashdbdashboards: - flashdb# Documentation referencesdocumentation: - name: Quickstart course url: https://developer.newrelic.com/contribute-to-quickstarts description: This doc guides you through the process of creating a quickstart
# Content / Designicon: logo.svgwebsite: https://developer.newrelic.com/contribute-to-quickstarts
Ici, vous avez ajouté un slug, un titre et une description pour que les gens reconnaissent et comprennent le but de votre quickstart. Vous vous référez également au tableau de bord et aux alertes associés pour créer le quickstart.
Ensuite, ajoutez un logo pour votre quickstart. Cela peut être soit ".svg" ou ".png". Votre répertoire quickstart devrait ressembler à ce qui suit.
Votre quickstart est maintenant prêt à être publié. Vous allez valider vos modifications sur GitHub où elles seront examinées par New Relic. Suivez la syntaxe de validation conventionnelle de New Relic pour valider vos modifications.
$git add -A$git commit -m "feat(flashdb): Added a quickstart for flashdb"
Important
Nous sommes toujours heureux de recevoir des contributions de la communauté. Nous attendons cependant un certain nombre de contributions pour flashdb suivant le même parcours. Pour nous aider à gérer efficacement vos contributions, nous vous encourageons à étiqueter votre contribution après ce cours particulier comme quickstart-course en utilisant la commande git tag
.
Envoyez vos modifications sur GitHub :
$git tag quickstart-course$git push
Créez un PR pour contribuer à votre quickstart
Une fois que vous avez envoyé vos modifications sur GitHub, vous pouvez créer une demande de tirage.
Accédez à votre référentiel quickstart (dépôt), cliquez sur Contribute puis sur Open pull request.
Cela vous amène à Open a pull request page. Ici, ajoutez un résumé pour votre quickstart et cliquez sur Create pull request.
Important
Lorsque vous contribuez à un quickstart, assurez-vous de procéder à des contrôles préalables.
Soumettez le PR et attendez l'examen. Une fois que votre quickstart a réussi toutes les vérifications, vous pouvez prévisualiser votre quickstart sur New Relic I/O.
Cela vous amène à votre quickstart sur New Relic I/O.
Important
À ce stade, votre quickstart sera automatiquement validé dans GitHub. S'il s'agissait d'une soumission réelle, elle serait alors approuvée et intégrée à New Relic I/O pour que votre utilisateur puisse la voir. Comme il s'agit d'un cours de démonstration, nous n'examinerons pas réellement ce PR. Nous apprécierions que vous souleviez cette PR comme « brouillon » afin qu'elle ne finisse pas dans la file d'attente de nos réviseurs.
Devoirs
Si vous ne l'avez pas déjà fait, nous vous encourageons à lire certains documents connexes tels que :
Les documents ci-dessus vous donnent une longueur d'avance sur votre parcours d'observabilité avec New Relic. Nous accueillons toujours avec plaisir les contributions de la communauté, alors n'hésitez pas à nous contacter.