Anforderungen für das Veröffentlichen von Inhaltspaketen

Achten Sie beim Erstellen und Veröffentlichen eines Inhaltspakets darauf, dass dieses die allgemeinen Anforderungen für die Veröffentlichung erfüllt.

Sie müssen sowohl die Anforderungen für Inhaltspakete als auch die Anforderungen für Veröffentlichungen überprüfen.

Anforderungen für Inhaltspakete

Inhaltspakete müssen bestimmte Anforderungen an Inhalt, Qualität und Standards erfüllen.

Anforderungen an die Inhalte:

• Mindestens drei Dashboards
• Mindestens ein, idealerweise drei und höchstens fünf Dashboard-Filter pro Dashboard
• Mindestens drei Dashboard-Widgets für Dashboards
• Höchstens sechs Dashboard-Widgets für Dashboards
• Höchstens drei Dashboard-Widgets pro Zeile
• Mindestens fünf Warnungen
• Mindestens 20 extrahierte Felder

Qualitätsanforderungen an Inhaltspakete:

Warnungen

Verwenden Sie aussagekräftige Zeiträume für Warnungen.

Dashboard-Gruppen

• Erwägen Sie, mit einer Übersichts-Dashboard-Gruppe zu beginnen.
• Erstellen Sie Dashboard-Gruppen basierend auf Nachrichtentypen (z. B. Übersicht oder Leistung) und nicht auf Komponententypen (z. B. Computing, Netzwerk oder Speicher).
• Duplizieren Sie dasselbe Dashboard-Widget in mehreren Dashboard-Gruppen, wenn das Dashboard-Widget in jeder Dashboard-Gruppe anwendbar ist.
• Richten Sie mindestens drei Dashboard-Gruppen auf ein Inhaltspaket aus.
• Dashboard-Gruppen und Dashboard-Widgets können nicht neu angeordnet werden, mit Ausnahme des Benutzerinhalts.
• Berücksichtigen Sie bei der Benennung von Dashboard-Gruppen den generischen Titel und vermeiden Sie das Hinzufügen produkt- oder anwendungsspezifischer Namen, es sei denn, diese werden komponentenspezifisch verwendet.

Dashboard-Widgets

• Fügen Sie nicht mehr als drei Dashboard-Widgets in dieselbe Zeile ein.
• Wenn Sie ähnliche Informationen in verschiedenen Formaten anzeigen, stellen Sie sicher, dass jedes Format einen Nutzen bringt.
• Stapeln Sie zusammengehörige Dashboards zur leichteren Ansicht.
• Geben Sie den Dashboard-Widgets aussagekräftige Namen. Verwenden Sie keine Feldnamen in Widget-Titeln.
• Stellen Sie sicher, dass jedes Dashboard-Widget Informationen oder Links darüber enthält, was das Diagramm zeigt und warum es wichtig ist. Die Hinweise sollten Fragen beantworten, wie zum Beispiel „Warum ist das Widget wichtig?“ und „Wo können zusätzliche Informationen gefunden werden?“.

Abfragen

• Jede Abfrage enthält mindestens ein Volltext-Schlüsselwort und idealerweise mindestens drei Schlüsselwörter.
• Abfragen basieren nicht auf umgebungsspezifischen Attributen wie Quelle, Hostname oder Betrieb.
• Verwenden Sie in Abfragen nur dann reguläre Ausdrücke, wenn Schlüsselwörter und Globs nicht ausreichen. Wenn Sie reguläre Ausdrücke verwenden, geben Sie so viele Schlüsselwörter wie möglich an.
• Machen Sie Abfragen so spezifisch wie möglich. Inhaltspaketabfragen sollten nur mit Ereignissen übereinstimmen, die für das Produkt oder die Anwendung gelten, für die das Inhaltspaket konzipiert wurde.

Feldextraktion

• Verwenden Sie zusätzliche Kontextfilter für Felder, um die Feldleistung in Abfragen zu verbessern.
• Minimieren Sie nach Möglichkeit die Anzahl der verwendeten regulären Ausdrücke.
• Stellen Sie sicher, dass ein regulärer Ausdruck mit jeder anwendbaren Protokollmeldung übereinstimmt.
• Stellen Sie so viel Kontext wie möglich vor und nach dem Schlüsselwort bereit.
• Jedes Feld enthält mindestens ein Volltext-Schlüsselwort und idealerweise mindestens drei Schlüsselwörter.
• Felder sind produkt-/anwendungsspezifisch und geben keine Ergebnisse für die Protokolle von anderen Produkten oder Anwendungen zurück.
• Verwenden Sie nach Möglichkeit Agenten für die Protokollerfassung. Verwenden Sie Agenten für das Analysieren von Feldern anstelle der Feldextraktion nach der Aufnahme.

Feldbenennung

• Verwenden Sie den folgenden Benennungsstandard: Präfix_Feld_Name. Das Präfix muss für das Inhaltspaket gelten.
• Verwenden Sie nur Kleinbuchstaben.
• Verwenden Sie Schlüsselwörter im zusätzlichen Kontext des Felds, um die Feldleistung in Abfragen zu verbessern.

Filter

• Verwenden Sie bei der Verwendung von Filtern nicht den Übereinstimmungsoperator „beliebige“, es sei denn, ein oder mehrere Schlüsselwörter sind in der Suchleiste definiert. „beliebige“ bedeutet, dass jeder Filter eine separate Abfrage ist. Wenn beispielsweise drei Filter mit dem Operator „beliebige“ in einer Abfrage verwendet werden, wird die Abfrage als drei Abfragen behandelt. Mehr Abfragen führen zu langsameren Ergebnissen. Sie können sich den Operator „beliebige“ als „oder“ und den Operator „alle“ als „und“ vorstellen.
• Wenn Sie den Textfilter mit mehreren unterschiedlichen Werten verwenden, stellen Sie sicher, dass ein oder mehrere Schlüsselwörter in der Suchleiste definiert sind.

Informationen zum Inhaltspaket

• Verwenden Sie beim Exportieren eines Inhaltspakets das Namensformat Unternehmen – Produkt – Version. Im Idealfall sollte der Name des Inhaltspakets weniger als 30 Zeichen umfassen, um Zeilenumbrüche zu verhindern.
• Verwenden Sie beim Exportieren mit einem Namespace das Namespace-Format Ext.Domäne.Produkt.
• Wenn Sie ein Inhaltspaket exportieren, exportieren Sie auch eine detaillierte Beschreibung des Produkts, auf das sich das Inhaltspaket bezieht, und wie das Inhaltspaket zur Überwachung des Produkts beiträgt.
• Fügen Sie Informationen zum Abschnitt „Anweisungen zur Einrichtung“ eines Inhaltspakets hinzu. Diese Anweisungen helfen dem Endbenutzer beim Einrichten und Verwenden des Inhaltspakets.
• Fügen Sie Informationen im Abschnitt „Anweisungen zum Upgrade“ eines Inhaltspakets hinzu. Diese Anweisungen helfen dem Endbenutzer, alle Funktionen in der aktualisierten Version des Inhaltspakets zu verstehen und zu verwenden.
• Geben Sie detaillierte Informationen zu den getesteten Versionen des Produkts oder Geräts an, für die das Inhaltspaket ausgelegt ist.
• Standardmäßig wird davon ausgegangen, dass Inhaltspakete für alle unterstützten Versionen des Produkts oder Geräts abwärtskompatibel sind und dass neue Versionen des Inhaltspakets mit den vorherigen Konfigurationen nach einer Aktualisierung des Inhaltspakets über das Download-Center nicht unterbrochen werden. Ist dies nicht der Fall, stellen Sie sicher, dass Sie ein separates Inhaltspaket bereitstellen.
• Wenn Sie ein Inhaltspaket trennen, stellen Sie sicher, dass die Inhaltspakete unterschiedliche Namespaces aufweisen und dass kein Upgrade vom alten auf das neue Inhaltspaket möglich ist. Unterstützen Sie auch die Verwendung alter und neuer Lösungen parallel, ohne Benutzer mit falschen Daten oder zusätzlichen Warnungen zu verwirren. Fügen Sie für beide Inhaltspakete Ausnahmen zu den Abschnitten „Versionshinweise“ und „Bekannte Probleme“ hinzu.
• Geben Sie dem Inhaltspaket eine Versionsnummer im Format Hauptversion.Nebenversion.Revision. Die Hauptversion ist für mehrere Änderungen im Inhaltspaket vorgesehen, z. B. für ein oder mehrere neue Dashboards. Bei der Nebenversion handelt es sich um eine kleine Änderung, z. B. eine Fehlerbehebung, eine Änderung des Widget-Typs oder das Hinzufügen von ein oder zwei Widgets. Die Revision ist optional und kann von Autoren von Inhaltspaketen verwendet werden, wenn eine neue Version vorbereitet wird, die mit dem Revisionssatz an VMware gesendet werden soll, aber nach der Veröffentlichung der finalen Version übersprungen werden kann. Verwenden Sie nur zweistellige Versionsnummern für Inhaltspakete.

Agentengruppen

vRealize Log Insight unterstützt beide weitergeleiteten Konfigurationen von syslog und seine eigenen Agenten für die Bereitstellung von Protokollen. Inhaltspakete, die für die Verwendung mit Agenten- und Agentengruppenvorlagen entwickelt wurden, enthalten vorgeschlagene Konfigurationen. Weitere Informationen finden Sie in den Anweisungen der einzelnen Inhaltspakete.

Anforderungen für Veröffentlichungen

Überprüfen Sie vor der Veröffentlichung eines Inhaltspakets, ob dieses die Anforderungen für Veröffentlichungen erfüllt. Verwenden Sie den Publisher für Inhaltspakete im Developer Center für Empfehlungen für Inhaltspakete und zum Hochladen einer Version zur Überprüfung für VMware. https://developercenter.vmware.com/web/loginsight

Anforderung für Veröffentlichungen	Beschreibung
Dateiformat des Inhaltspakets	VLCP-Datei.
Ereignisse	Die für die Validierung des Inhaltspakets erforderlichen und geeigneten Ereignisse.
Überblick	Eine kurze Übersicht (ein bis zwei Absätze) über das Inhaltspaket.
Highlights	Drei Highlights, die den Nutzen des Inhaltspakets herausheben.
Beschreibung	Eine kurze Beschreibung (zwei bis drei Absätze) des Inhaltspakets und seines Nutzens.
Technische Spezifikationen	Beschreiben Sie die Mindestsystemanforderungen, zum Beispiel die Produktversionen und -konfiguration sowie die Log Insight-Version und -Konfiguration. Geben Sie außerdem die nötigen Anweisungen zur Konfiguration des Produkts für die Protokollierung in Log Insight und für das Auffüllen des Inhaltspakets an.
Screenshots	Mindestens drei Screenshots, die das Inhaltspaket mit realen Daten zeigen.
Video (optional)	Beispiel dafür, wie mit dem Inhaltspaket nützliche Erkenntnisse gewonnen werden können.
Whitepaper (optional)	Anleitung zum Konfigurieren des Produkts oder der Anwendung, damit Protokolle an vRealize Log Insight weitergeleitet werden.