ストリーミングダッシュボードのカスタムウィジェットの作成

カスタムウィジェットを使用すると、独自のNRQLクエリから作成したチャートの視覚化によって、Media Streamingダッシュボードを拡張できます。組み込みの品質メトリクスが、チームでモニターする必要がある特定のデータポイントをカバーしていない場合に、これらを使用します。

あなたが始める前に

カスタムウィジェットを作成する前に、以下が必要です：

• Streaming Video & AdsエージェントがインストールされたNew Relicアカウントへのアクセス。まだ設定していない場合は、Streaming Video & Adsエージェントのインストールをご覧ください。
• 品質メトリクスセクションに表示される+ Add Custom Widgetボタン。そうでない場合は、New Relicアカウントチームに連絡してアクセスをリクエストしてください。

NRQLクエリを記述する

NRQLエディターは、有効なNRQLクエリをすべてサポートしています。NRQL構文の概要については、『NRQLの概要』をご覧ください。

クエリの要件

カスタムウィジェットのクエリには、標準のNRQLに加えて2つの追加要件があります：

• クエリに直接SINCEまたはUNTIL句を記述しないでください。クエリの実行時に、ダッシュボードのタイムピッカーが自動的に時間範囲を追加します。
• ダッシュボードレベルのフィルターバーの選択に応答するには、クエリにフィルタープレースホルダーを含めます。

フィルタープレースホルダー

クエリの実行時に、ダッシュボードはグローバルフィルターを適用します。クエリに直接プレーンなWHERE句を記述した場合、ダッシュボードはユーザーが選択したフィルター条件をそこに挿入できません。フィルターのプレースホルダーは、クエリの実行時にアクティブなフィルター条件に置き換えられる特別なNRQLコメントです。

例 — 既存のWHERE句がない場合：

SELECT count(*) FROM VideoAction /* {whereClause} */

フィルターCity = Ashburnを適用した場合：

SELECT count(*) FROM VideoAction WHERE city = 'Ashburn' SINCE 30 minutes ago UNTIL now

例 — 既存のWHERE句：

SELECT count(*) FROM VideoAction
WHERE actionName = 'QOE_AGGREGATE' /* {andWhereClause} */

フィルターCity = Ashburnを適用した場合：

SELECT count(*) FROM VideoAction
WHERE actionName = 'QOE_AGGREGATE' AND city = 'Ashburn' SINCE 30 minutes ago UNTIL now

例 — 混在する集計を使用した比率クエリ：

FROM VideoAction
SELECT filter(sum(elapsedTime), WHERE actionName = 'CONTENT_HEARTBEAT' /* {andWhereClause} */)
     / filter(uniqueCount(viewId) /* {aggregatorWhereClause} */)
  AS 'avgWatchTime'
TIMESERIES

フィルターCity = Ashburnを適用した場合：

FROM VideoAction
SELECT filter(sum(elapsedTime), WHERE actionName = 'CONTENT_HEARTBEAT' AND city = 'Ashburn')
     / filter(uniqueCount(viewId), WHERE city = 'Ashburn')
  AS 'avgWatchTime'
TIMESERIES SINCE 30 minutes ago UNTIL now

アクティブなフィルターがない場合：

FROM VideoAction
SELECT filter(sum(elapsedTime), WHERE actionName = 'CONTENT_HEARTBEAT')
     / uniqueCount(viewId)
  AS 'avgWatchTime'
TIMESERIES SINCE 30 minutes ago UNTIL now

ブロックされたキーワードと文字

偶発的なデータ変更を防ぐため、NRQLエディターは以下を含むクエリを拒否します：

• キーワードDROP、DELETE、INSERT、UPDATE、CREATE、または ALTER
• クエリのチェーンを可能にするセミコロン（;）

これらのいずれかを含むクエリは検証に失敗し、保存やプレビューができません。

クエリの例

以下の例は、動画および広告監視の一般的なクエリパターンを示しています。それぞれが、そのクエリ構造に適切なフィルタープレースホルダーを使用します。

基本的な時系列 — ビデオの合計開始数：

SELECT count(*) AS 'Video Starts'
FROM VideoAction
WHERE actionName = 'CONTENT_START' /* {andWhereClause} */
TIMESERIES

フィルターインテグレーションを使用したユニーク視聴者数：

SELECT uniqueCount(viewId) AS 'Unique Viewers'
FROM VideoAction /* {whereClause} */
TIMESERIES

イベントタイプ全体のエラー率：

SELECT count(*) AS 'Error Count'
FROM VideoErrorAction, VideoAction
WHERE actionName = 'CONTENT_ERROR' /* {andWhereClause} */
TIMESERIES

平均視聴時間（ネストされた集計との比率）：

FROM VideoAction
SELECT filter(sum(elapsedTime), WHERE actionName = 'CONTENT_HEARTBEAT' /* {andWhereClause} */)
     / filter(uniqueCount(viewId) /* {aggregatorWhereClause} */)
  AS 'avgWatchTime'
TIMESERIES

制限

グローバルフィルターが有効な場合、一部のNRQLクエリパターンはサポートが限定的であるか、未テストです。完全なリストについては、Streaming Video & Adsの制限事項をご覧ください。

カスタムウィジェットを作成する

カスタムウィジェットを作成するには：

1. one.newrelic.com > All Capabilities > Streaming Video & Adsに移動し、Video OverviewまたはAds Overviewを選択します。
2. Video Quality MetricsまたはAd Quality Metricsセクションまでスクロールダウンします。
3. セクションヘッダーの+ Add Custom Widgetをクリックしてください。
4. ウィジェットの一意のタイトルを入力してください。
5. NRQLエディタでNRQLクエリを記述してください。構文、フィルターのプレースホルダー、例については、上のNRQLクエリの記述をご覧ください。
6. ライブデータに対する結果をプレビューするには、Run Queryをクリックします。この操作ではウィジェットは保存されません。プレビューを使用して、チャートが期待どおりのデータをレンダリングすることを確認し、フィルターがアクティブなときにフィルターのプレースホルダーが正しく解決されることを検証し、保存する前に構文エラーや論理エラーを検出してください。
7. プレビューが読み込まれると、チャートタイプのピッカーが表示されます。デフォルトはLineです — 必要に応じて別のタイプを選択してください。クエリ結果に推奨されないチャートタイプはグレーアウトして表示される場合がありますが、それでも次のいずれかを選択できます：Billboard、Line、Area、Bar、Table、またはPie。
8. Saveをクリックします。New Relicは、メトリクスセレクターのドロップダウンのCustom Metricsセクションにウィジェットを追加し、品質メトリクスグリッドの上部にレンダリングします。ウィジェットはセッション間で保持されます。

カスタムウィジェットを編集する

カスタムウィジェットを編集するには：

1. Quality Metricsセクションで、変更するカスタムウィジェットを見つけます。
2. ウィジェットカードの鉛筆アイコンをクリックします。既存のタイトルとクエリが事前に入力された状態でエディタが開きます。
3. 変更を行い、Run Queryをクリックして確認し、Saveをクリックします。

保存時：

• 元の作成日とウィジェットの識別情報は保持されます。
• ウィジェットは更新されたクエリで直ちに再レンダリングされます。
• タイトルを変更すると、メトリクスセレクタのドロップダウンで更新されます。

カスタムウィジェットを削除する

カスタムウィジェットを削除するには：

1. Quality Metricsセクションで、ウィジェットカードのアイコンをクリックします。
2. Deleteを選択します。
3. プロンプトで確認します：「『[Widget Title]』を削除してもよろしいですか？この操作は元に戻せません。」

削除された場合：

• New Relicはウィジェットを完全に削除します。
• ダッシュボードからウィジェットカードが直ちに削除されます。
• メトリクスセレクターのドロップダウンからタイトルのエントリが削除されます。
• ウィジェットが選択されていた場合、ダッシュボードは自動的にその選択を解除します。

トラブルシューティング

以下の症状から該当するものを探してください。問題は、最も一般的なものから順に並んでいます。

ダッシュボードフィルターを適用してもウィジェットが更新されない

クエリにフィルタープレースホルダーがありません。/* {whereClause} */、/* {andWhereClause} */、または/* {aggregatorWhereClause} */がない場合、ウィジェットは常に記述されたとおりにクエリを実行し、ダッシュボードのフィルターバーの選択を無視します。クエリ構造に適切なものを選択するには、フィルタープレースホルダーを参照してください。

フィルターは適用されるが、クエリがエラーを返すかデータを返さない

間違ったプレースホルダーのタイプを使用した可能性があります。確認事項：

• クエリにWHERE句がない場合は、/* {whereClause} */を使用します。
• クエリレベルですでにクエリにWHERE句が含まれている場合は、/* {andWhereClause} */を使用してください。
• プレースホルダーが既存の内部 WHERE のない filter() 集計内にある場合は、/* {aggregatorWhereClause} */ を使用してください。

誤ったプレースホルダーを使用すると、クエリの実行時に無効なNRQLが生成され、失敗の原因となります。

クエリが検証に失敗するか、保存されない

クエリに、DROP、DELETE、またはセミコロンなどのブロックされたキーワードまたは文字が含まれていないか確認してください。また、クエリが以下の要件を満たしているか確認してください：

• クエリにはSELECT句とFROM句の両方が含まれています。
• エディターのインライン検証で構文エラーが指摘されていないこと。

ウィジェットを保存できません — タイトルがすでに存在します

同じダッシュボードコンテキスト（ビデオまたは広告品質メトリクス）に同じタイトルのウィジェットがすでに存在する場合、保存に失敗し、トースト通知が表示されます：

• タイトル: ウィジェットの保存に失敗しました
• 説明: この名前のウィジェットはすでに存在します

タイトルの照合では大文字と小文字は区別されません — My WidgetとMY WIDGETは同じタイトルとして扱われます。別のタイトルを選択するか、先に既存のウィジェットの名前を変更してください。

ウィジェットは保存されるが、ページを更新すると消える

これは保存の失敗を示している可能性があります。保存時に表示されたトースト通知を確認してください — ネットワークエラーが原因で保存に失敗したかどうかが示されます。保存を再試行してください。問題が解決しない場合は、New Relicアカウントチームにお問い合わせください。

新しいウィジェットを追加できません

このダッシュボードコンテキスト（動画または広告品質メトリクス）の50ウィジェットのソフトリミットに達しました。既存のカスタムウィジェットを少なくとも1つ削除してから、新しいウィジェットを追加してみてください。

「+ カスタムウィジェットを追加」ボタンが表示されません

New Relicがこの機能へのアクセスを制御します。アクセスをリクエストするには、New Relicアカウントチームにお問い合わせください。