コンテンツ パックを作成して公開するときには、コンテンツ パックが基本的な公開要件を満たしていることを確認します。
コンテンツ パックの要件と公開要件の両方を確認する必要があります。
コンテンツ パックの要件
コンテンツ パックはコンテンツ、品質、標準に関するいくつかの要件を満たす必要があります。
コンテンツの要件は次のとおりです。
- 最小 3 つのダッシュボード
- ダッシュボードあたり、最小 1 つ、理想的には 3 つ、最大 5 つのダッシュボード フィルタ
- ダッシュボードあたり最小 3 つのダッシュボード ウィジェット
- ダッシュボードあたり最大 6 つのダッシュボード ウィジェット
- 行あたり最大 3 つのダッシュボード ウィジェット
- 最小 5 つのアラート
- 最小 20 の抽出済みフィールド
コンテンツ パックの品質要件は次のとおりです。
- アラート
- アラートには有効な期間を使用します。
- ダッシュボード グループ
-
- 概要ダッシュボード グループを使用して開始することを検討してください。
- コンポーネント タイプ(コンピューティング、ネットワーク、ストレージなど)ではなく、メッセージ タイプ(概要やパフォーマンスなど)に基づいてダッシュボード グループを作成します。
- ダッシュボード ウィジェットが各ダッシュボード グループに適用可能な場合は、複数のダッシュボード グループで同じダッシュボード ウィジェットを複製します。
- コンテンツ パック内の少なくとも 3 つのダッシュボード グループをターゲットにします。
- ダッシュボード グループおよびダッシュボード ウィジェットの順序は変更できません(ユーザー コンテンツを除く)。
- ダッシュボード グループに名前を付けるときは、タイトルを一般的なものにし、コンポーネント固有の方法で使用されていない限り、製品固有の名前またはアプリケーション固有の名前を追加しないようにします。
- ダッシュボード ウィジェット
-
- 同じ行に 4 つ以上のダッシュボード ウィジェットを配置しないでください。
- 異なるフォーマットで類似した情報を表示する場合は、それぞれのフォーマットが有用であることを確認します。
- 関連するダッシュボードは見やすいように重ねて配置します。
- ダッシュボード ウィジェットにわかりやすい名前を付けます。ウィジェット タイトルではフィールド名を使用しないでください。
- 各ダッシュボード ウィジェットに、チャートが示す内容とそれが重要な理由に関する情報またはリンクが含まれていることを確認します。説明は、「ウィジェットが重要な理由」および「追加情報が見つかる場所」などの質問に答える内容にする必要があります。
- クエリ
-
- どのクエリにもフルテキストのキーワードを少なくとも 1 つ含め、できるだけ 3 つ以上のキーワードを含めます。
- クエリは、ソース、ホスト名、または設備などの環境固有の属性には基づきません。
- クエリで正規表現を使用するのは、キーワードと glob が十分でない場合のみにしてください。正規表現を使用する場合は、できるだけ多くのキーワードを指定してください。
- できるだけ具体的なクエリを作成します。コンテンツ パックのクエリは、コンテンツ パックが設計された製品またはアプリケーションに適用可能なイベントにのみ一致する必要があります。
- フィールド抽出
-
- クエリでフィールドのパフォーマンスを向上させるには、フィールドで追加のコンテキスト フィルタを使用します。
- 可能な限り、使用される正規表現の数を最小限に抑えます。
- 正規表現の値が該当するすべてのログ メッセージと一致することを確認します。
- できるだけ多くの前後のキーワード コンテキストを提供します。
- どのフィールドにもフルテキストのキーワードを少なくとも 1 つ含め、できるだけ 3 つ以上のキーワードを含めます。
- フィールドは製品またはアプリケーション固有であり、他の製品またはアプリケーション ログの結果を返しません。
- 可能な限り、ログ収集にエージェントを使用します。取り込み後のフィールド抽出の代わりに、フィールドの解析にエージェントを使用します。
- フィールドの命名
-
- 次の命名規則を使用します:Prefix_Field_Name。プリフィックスは、コンテンツ パックに適用可能である必要があります。
- すべて小文字を使用します。
- フィールドの追加コンテキストにキーワードを使用し、クエリのフィールド パフォーマンスを向上させます。
- フィルタ
-
- フィルタを使用するときは、検索バーで 1 つ以上のキーワードが定義されていない限り、「any」一致演算子を使用しないでください。「any」は、各フィルタが個別のクエリであることを意味します。たとえば、1 つのクエリで「any」演算子を使用して 3 つのフィルタを使用すると、そのクエリは 3 つのクエリとして扱われます。クエリの数が増えると結果の表示が遅くなります。「any」は「or」、「all」は「and」演算子と考えることができます。
- 複数の異なる値を持つテキスト フィルタを使用する場合は、1 つ以上のキーワードが検索バーで定義されていることを確認してください。
- コンテンツ パックの情報
-
- コンテンツ パックをエクスポートするときは、Company – Product vVersion という名前の形式を使用します。単語の折り返しを防ぐため、コンテンツ パック名は 30 文字未満にするのが理想的です。
- 名前空間を指定してエクスポートする場合は、名前空間の形式 Ext を使用します。ドメイン。製品。
- コンテンツ パックをエクスポートするときは、コンテンツ パックが対応する製品と、コンテンツパックが製品の監視にどのように役立つかについての詳細な説明とともにエクスポートします。
- コンテンツ パックの「セットアップ手順」セクションに情報を追加します。これらの手順は、エンド ユーザーがコンテンツ パックをセットアップして使用するのに役立ちます。
- コンテンツ パックの「アップグレード手順」セクションに情報を追加します。これらの手順は、アップグレードされたバージョンのコンテンツ パックのすべての機能をエンドユーザーが理解して使用するのに役立ちます。
- コンテンツ パックが設計されている製品またはデバイスのテスト済みバージョンに関する詳細情報を提供します。
- デフォルトでは、サポートされているすべてのバージョンの製品またはデバイスに対してコンテンツ パックに下位互換性があると想定されており、コンテンツ パックの新しいバージョンは、マーケットプレイスからのコンテンツ パックの更新後に以前の構成を妨げません。デフォルト以外の場合は、別のコンテンツ パックを配布するようにしてください。
- コンテンツ パックを分離するときは、コンテンツ パックの名前空間が異なること、および古いコンテンツ パックから新しいコンテンツ パックにアップグレードできないことを確認してください。また、誤ったデータや追加のアラートでユーザーを混乱させることなく、古いソリューションと新しいソリューションを並行して使用できるようにします。両方のコンテンツ パックのリリース ノートおよび「既知の問題」セクションに例外を追加します。
- コンテンツ パックに MajorMinor.Revision 形式のバージョン番号を指定します。Major バージョンは、1 つ以上の新しいダッシュボードなど、コンテンツ パックの複数の変更に対応します。Minor バージョンは、バグ修正、ウィジェット タイプの変更、1 つまたは 2 つのウィジェットの追加など、軽微な変更に対応します。Revision はオプションで、コンテンツ パックの作成者がリビジョン セットを使用して VMware に送信する新しいバージョンを準備するときに使用できますが、最終バージョンが公開された後は省略することができます。コンテンツ パックには 2 桁のバージョン番号のみを使用してください。
- エージェント グループ
- vRealize Log Insight は、ログの配信のために Syslog に転送された構成とその独自のエージェントの両方をサポートします。エージェントおよびエージェント グループ テンプレートで使用するように設計されたコンテンツ パックには、推奨される構成が含まれます。詳細については、各コンテンツ パックの手順を参照してください。
公開要件
コンテンツ パックを公開する前に、公開要件を満たしていることを確認してください。Developer Center のコンテンツ パックの発行元で、コンテンツ パックの推奨事項を確認し、VMware のレビューのためにバージョンをアップロードします。https://developercenter.vmware.com/web/loginsight
公開要件 | 説明 |
---|---|
コンテンツ パックのファイル形式 | VLCP ファイル。 |
イベント | コンテンツ パックの検証に必要な、適切なイベント。 |
概要 | 1 ~ 2 パラグラフで構成される、コンテンツ パックに関する概要。 |
ハイライト | そのコンテンツ パックのポイントを示す、ハイライト 3 件。 |
説明 | コンテンツ パックとその価値を表す、2 ~ 3 パラグラフの説明。 |
技術仕様 | 製品のバージョンおよび構成と、Log Insight のバージョンおよび構成を含む、システムの最小要件の説明。この他に、Log Insight にログを作成し、コンテンツ パックを配置するために製品を構成する際に必要となるすべての指示も提供します。 |
スクリーンショット | 実際のデータを含んだコンテンツ パックを示す 3 つ以上のスクリーンショット。 |
ビデオ(オプション) | コンテンツ パックがどのように価値をもたらすのかを例示 |
ホワイト ペーパー(オプション) | ログを vRealize Log Insight に転送するために製品やアプリケーションを構成する方法。 |