Lorsque vous créez un pack de contenu et que vous souhaitez le publier, assurez-vous qu'il répond aux exigences de publication de base.

Vous devez vérifier les exigences de packs de contenu et les exigences de publication.

Exigences des packs de contenu

Les packs de contenu doivent répondre à certaines exigences en matière de contenu, de qualité et de normes.

Les exigences de contenu incluent les éléments suivants :

  • Minimum de trois tableaux de bord
  • Minimum de un, de préférence trois, et jusqu'à cinq filtres par tableau de bord
  • Minimum de trois widgets par tableau de bord
  • Maximum de six widgets par tableau de bord
  • Maximum de trois widgets de tableau de bord par ligne
  • Minimum de cinq alertes
  • Minimum de 20 champs extraits

Les exigences de qualité pour un pack de contenu sont les suivantes :

Alertes
Utilisez des périodes significatives pour les alertes.
Groupes de tableaux de bord
  • Pensez à démarrer par un groupe de tableaux de bord de présentation.
  • Créez des groupes de tableaux de bord en fonction des types de messages (par exemple, présentation ou performances), et non des types de composants (par exemple, calcul, réseau ou stockage).
  • Dupliquez le même widget de tableau de bord dans plusieurs groupes de tableaux de bord s'il s'applique dans chaque groupe de tableaux de bord.
  • Ciblez au moins trois groupes de tableaux de bord dans un pack de contenu.
  • Vous ne pouvez pas réorganiser les groupes de tableaux de bord et les widgets de tableau de bord, sauf avec le contenu utilisateur.
  • Lorsque vous nommez des groupes de tableaux de bord, définissez le titre comme étant générique et évitez d'ajouter des noms spécifiques à un produit ou à une application, sauf s'ils sont utilisés d'une manière spécifique à un composant.
Widgets de tableau de bord
  • Ne placez pas plus de trois widgets de tableau de bord sur la même ligne.
  • Lorsque vous affichez des informations similaires dans différents formats, assurez-vous que chaque format apporte de la valeur.
  • Tableaux de bord liés à une pile pour faciliter l'affichage.
  • Attribuez des noms descriptifs aux widgets de tableau de bord. N'utilisez pas de noms de champs dans les titres de widgets.
  • Assurez-vous que chaque widget de tableau de bord contient des informations ou des liens sur ce que le graphique montre et pourquoi il est important. Les notes doivent répondre aux questions suivantes : « Pourquoi le widget est-il important ? » et « Où peut-on trouver des informations supplémentaires ? ».
Requêtes
  • Chaque requête comporte au moins un mot clé en texte intégral et idéalement au moins trois mots clés.
  • Les requêtes ne sont pas basées sur des attributs spécifiques à l'environnement tels que source, nom d'hôte ou installations.
  • Utilisez des expressions régulières dans les requêtes uniquement si les mots clés et les globs ne suffisent pas. Lorsque vous utilisez des expressions régulières, fournissez autant de mots clés que possible.
  • Faites en sorte que les requêtes soient aussi spécifiques que possible. Les requêtes de pack de contenu ne doivent correspondre qu'à des événements applicables au produit ou à l'application pour lequel le pack de contenu a été conçu.
Extraction de champs
  • Utilisez des filtres de contexte supplémentaires dans les champs pour améliorer les performances des champs dans les requêtes.
  • Dans la mesure du possible, réduisez le nombre d'expressions régulières utilisées.
  • Vérifiez qu'une valeur d'expression régulière correspond à chaque message de journal applicable.
  • Fournissez autant de contexte antérieur et postérieur au mot clé que possible.
  • Chaque champ comporte au moins un mot clé en texte intégral et idéalement au moins trois mots clés.
  • Les champs sont spécifiques à un produit ou à une application et ne renvoient pas de résultats pour les journaux d'autres produits ou applications.
  • Dans la mesure du possible, utilisez des agents pour la collecte de journaux. Utilisez des agents pour l'analyse des champs au lieu de l'extraction de champs après l'ingestion.
Affectation de noms de champs
  • Utilisez la norme d'affectation de noms suivante : Préfixe_Champ_Nom. Le préfixe doit s'appliquer au pack de contenu.
  • Utilisez toutes les lettres minuscules.
  • Utilisez des mots clés dans le contexte supplémentaire du champ pour améliorer les performances de celui-ci dans les requêtes.
Filtres
  • Lorsque vous utilisez des filtres, n'utilisez pas l'opérateur « any » de correspondance, sauf si un ou plusieurs mots clés sont définis dans la barre de recherche. « any » signifie que chaque filtre est une requête distincte. Par exemple, lorsque trois filtres sont utilisés avec l'opérateur « any » dans une requête, celle-ci est traitée comme trois requêtes. Un nombre plus élevé de requêtes génère des résultats plus lents. Vous pouvez considérer « any » comme opérateur « or » et « all » comme opérateur « and ».
  • Lorsque vous utilisez le filtre de texte avec plusieurs valeurs différentes, assurez-vous qu'un ou plusieurs mots-clés sont définis dans la barre de recherche.
Informations sur le pack de contenu
  • Lors de l'exportation d'un pack de contenu, utilisez le format d'affectation de noms SociétéProduit vVersion. Idéalement, le nom du pack de contenu doit comporter moins de 30 caractères pour éviter le retour automatique à la ligne.
  • Lors de l'exportation avec un espace de noms, utilisez le format d'espace de noms Ext.Domaine.Produit.
  • Lorsque vous exportez un pack de contenu, exportez-le avec une description détaillée du produit que le pack de contenu traite et la manière dont le pack de contenu permet de surveiller le produit.
  • Ajoutez des informations à la section Instructions relatives à la configuration d'un pack de contenu. Ces instructions aident l'utilisateur final à configurer et à utiliser le pack de contenu.
  • Ajoutez des informations dans la section Instructions relatives à la mise à niveau d'un pack de contenu. Ces instructions permettent à l'utilisateur final de comprendre et d'utiliser toutes les fonctionnalités de la version mise à niveau du pack de contenu.
  • Fournissez des informations détaillées sur les versions testées du produit ou du périphérique pour lequel le pack de contenu est conçu.
  • Par défaut, on part du principe que les packs de contenu sont rétrocompatibles pour toutes les versions prises en charge du produit ou du périphérique, et que les nouvelles versions du pack de contenu ne s'interrompent pas avec les configurations précédentes après la mise à jour du pack de contenu depuis Marketplace. Si ce n'est pas le cas, veillez à fournir un pack de contenu séparé.
  • Lorsque vous séparez un pack de contenu, assurez-vous que les packs de contenu comportent des espaces de noms différents et qu'il n'est pas possible d'effectuer la mise à niveau de l'ancien vers le nouveau pack de contenu. En outre, prenez en charge l'utilisation des anciennes et des nouvelles solutions en parallèle, sans troubler les utilisateurs avec des données incorrectes ou des alertes supplémentaires. Ajoutez des exceptions aux sections Notes de mise à jour et Problèmes connus pour les deux packs de contenu.
  • Attribuez au pack de contenu un numéro de version au format Majeure.Mineure.Révision. La version majeure concerne les modifications multiples du pack de contenu, par exemple un ou plusieurs nouveaux tableaux de bord. La version mineure concerne une petite modification, telle qu'un correctif de bogue, une modification du type de widget ou l'ajout d'au moins deux widgets. La révision est facultative et peut être utilisée par les auteurs de packs de contenu lors de la préparation d'une nouvelle version à envoyer à VMware avec l'ensemble des révisions. Toutefois, vous pouvez l'ignorer après la publication de la version finalisée. Utilisez uniquement des numéros de version à deux chiffres pour les packs de contenu.
Groupes d'agents
vRealize Log Insight prend en charge les deux configurations syslog transférées et ses propres agents pour l'envoi des journaux. Les packs de contenu conçus pour être utilisés avec l'agent et les modèles de groupes d'agents incluent des configurations suggérées. Pour plus d'informations, consultez les instructions de chaque pack de contenu.

Exigences de publication

Avant de publier un pack de contenu, vérifiez qu'il répond aux exigences de publication. Utilisez l'éditeur du pack de contenu dans le Centre des développeurs pour obtenir les recommandations sur le pack de contenu et pour charger une version à examiner sur VMware. https://developercenter.vmware.com/web/loginsight

Exigence de publication Description
Format de fichier de pack de contenu Fichier VLCP.
Événements Événements appropriés nécessaires à la validation d'un pack de contenu.
Présentation Présentation de un à deux paragraphes du pack de contenu.
Points importants Trois points importants, montrant la valeur du pack de contenu.
Description Description de deux à trois paragraphes du pack de contenu et sa valeur.
Spécifications techniques Décrivez la configuration minimale requise y compris les versions et la configuration du produit et de Log Insight. En outre, indiquez toutes les instructions nécessaires pour configurer le produit à consigner dans Log Insight et remplissez le pack de contenu.
Captures d'écran Au moins trois captures d'écran affichant le pack de contenu avec les données réelles.
Vidéo (Facultative) Exemple de l'apport en termes de valeur du pack de contenu.
Livre blanc (Facultatif) Comment configurer le produit ou l'application pour transférer des journaux vers vRealize Log Insight.