Azure Monitor ブックを使用した対話型レポートの作成Create interactive reports with Azure Monitor workbooks

ブックでは、テキスト、 分析クエリ、Azure メトリック、パラメーターを組み合わせて内容豊富な対話型レポートを作成します。Workbooks combine text, Analytics queries, Azure Metrics, and parameters into rich interactive reports. ブックは、同じ Azure リソースにアクセスできる他のチーム メンバーが編集できます。Workbooks are editable by any other team members who have access to the same Azure resources.

Workbooks は次のようなシナリオで便利です。Workbooks are helpful for scenarios like:

  • 目的のメトリック (ユーザー数、リテンション率、コンバージョン率など) が事前にわからない状況でアプリの使用方法を探すとき。他の使用状況分析ツールとは異なり、ブックを使用すると複数の種類の視覚化ツールや分析ツールを結合できるため、この種のフリーフォーム探索に適しています。Exploring the usage of your app when you don't know the metrics of interest in advance: numbers of users, retention rates, conversion rates, etc. Unlike other usage analytics tools, workbooks let you combine multiple kinds of visualizations and analyses, making them great for this kind of free-form exploration.
  • 主なやり取りや他のメトリックのユーザー数を示することで、新しくリリースされた機能のパフォーマンスをチームに説明するとき。Explaining to your team how a newly released feature is performing, by showing user counts for key interactions and other metrics.
  • チームの他のメンバーと A/B 実験の結果を共有するとき。Sharing the results of an A/B experiment in your app with other members of your team. 実験の目標をテキストで説明した後に、その実験の評価に使用される使用状況メトリックと Analytics クエリ、および各メトリックが目標を上回ったかまたは下回ったかどうかを明確に提示します。You can explain the goals for the experiment with text, then show each usage metric and Analytics query used to evaluate the experiment, along with clear call-outs for whether each metric was above- or below-target.
  • 停止がアプリの使用に及ぼす影響を報告し、データ、テキスト説明、および次の手順についての話し合いを組み合わせて将来の停止を防止するとき。Reporting the impact of an outage on the usage of your app, combining data, text explanation, and a discussion of next steps to prevent outages in the future.

テンプレートまたは保存済みブックから始めるStarting with a template or saved workbook

ブックは、個別に編集可能なグラフ、テーブル、テキスト、入力コントロールで構成される複数のセクションで構成されます。A workbook is made up of sections consisting of independently editable charts, tables, text, and input controls. ブックの理解を深めるには、ブックを開くのが最良の方法です。To better understand workbooks, it is best to open one up.

アプリの Application Insights エクスペリエンス内から、左側のメニューの [Workbooks] を選択します。Select Workbooks from the left-hand menu from inside the Application Insights experience for your app.

ブックへのナビゲーションのスクリーンショット

これにより、作業を開始する際に役立つ多数の作成済みブックが含まれたブック ギャラリーが起動します。This launches a workbook gallery with a number of prebuilt workbooks to help you get started.

ブック ギャラリーのスクリーンショット

ここでは、 [クイック スタート] という見出しの下にある [既定のテンプレート] から始めます。We'll start with the Default Template, which is located under the heading Quick start.

ブック ギャラリーのスクリーンショット

ブックのセクションを編集、再配置、複製、および削除するEditing, rearranging, cloning, and deleting workbook sections

ブックには、編集モード閲覧モードの 2 つのモードがあります。Workbooks have two modes: editing mode, and reading mode. 既定のブックを最初に起動したときは、編集モードでブックが開きます。When the default workbook is first launched, it opens in editing mode. このモードでは、他の方法では非表示になるステップやパラメーターも含め、ブックのすべてのコンテンツが表示されます。This shows all the content of the workbook, including any steps and parameters that are otherwise hidden. 閲覧モードでは、簡素化されたレポート スタイルのビューが表示されます。Reading mode presents a simplified report style view. これにより、レポートの作成時に生じた複雑さを排除できます。変更が必要な場合は、数回クリックするだけで元になるメカニズムを表示できます。This allows you to abstract away the complexity that went into creating a report while still having the underlying mechanics only a few clicks away when needed for modification.

Application Insights の [ブック] セクションの編集コントロール

  1. セクションの編集が完了したら、セクションの左下隅にある [編集完了] をクリックします。When you're done editing a section, click Done Editing in the bottom left corner of the section.

  2. セクションの複製を作成するには、 [このセクションの複製] アイコンをクリックします。To create a duplicate of a section, click the Clone this section icon. セクションを複製すると、前のイテレーションを失うことなくクエリを繰り返すことができるので便利です。Creating duplicate sections is a great to way to iterate on a query without losing previous iterations.

  3. ブックのセクションを移動するには、 [上へ移動] アイコンまたは [下へ移動] アイコンをクリックします。To move up a section in a workbook, click the Move up or Move down icon.

  4. セクションを完全に削除するには、 [削除] アイコンをクリックします。To remove a section permanently, click the Remove icon.

テキストと [マークダウン] セクションを追加するAdding text and Markdown sections

ブックに見出し、説明、およびコメントを追加すると、テーブルやグラフのセットをナレーションに変えるのに役立ちます。Adding headings, explanations, and commentary to your workbooks helps turn a set of tables and charts into a narrative. ブックのテキスト セクションは、見出し、ボールド、斜体、箇条書きなどのテキスト形式として、マークダウン構文をサポートします。Text sections in workbooks support the Markdown syntax for text formatting, like headings, bold, italics, and bulleted lists.

ブックにテキスト セクションを追加するには、ブックの下部またはセクションの下部にある [テキストの追加] ボタンを使用します。To add a text section to your workbook, use the Add text button at the bottom of the workbook, or at the bottom of any section.

クエリ セクションを追加するAdding query sections

ブックのクエリ セクション

ブックにクエリ セクションを追加するには、ブックの下部またはセクションの下部にある [クエリの追加] ボタンを使用します。To add query section to your workbook, use the Add query button at the bottom of the workbook, or at the bottom of any section.

クエリ セクションは柔軟性が高く、次のような質問の回答を得るために使用できます。Query sections are highly flexible and can be used to answer questions like:

  • 使用状況が減少したのと同じ期間にサイトが投げた例外の数はいくつですか?How many exceptions did your site throw during the same time period as a decline in usage?
  • あるページを閲覧しているユーザーのページ読み込み時間の分布は何でしたか?What was the distribution of page load times for users viewing some page?
  • サイトのある一連のページを閲覧したユーザーのうち、ある別の一連のページを閲覧しなかったユーザーの数は?How many users viewed some set of pages on your site, but not some other set of pages? これは、サイトの機能の異なるサブセットを使用する (Kusto クエリ言語join 演算子を kind=leftanti 修飾子とともに使用する) ユーザーのクラスターが存在するかどうかを理解するのに便利です。This can be useful to understand if you have clusters of users who use different subsets of your site's functionality (use the join operator with the kind=leftanti modifier in the Kusto query language).

ブックを起動したアプリケーションのコンテキストからのクエリだけに限定されているわけではありません。You also aren't only limited to querying from the context of the application you launched the workbook from. Application Insight によって監視される複数のアプリや Log Analytics ワークスペースでクエリを実行できます (ただし、これらのリソースへのアクセス許可が必要です)。You can query across multiple Application Insights monitored apps as well as Log Analytics workspaces as long as you have access permission to those resources.

その他の外部の Application Insight リソースからクエリを実行するには、app 識別子を使用します。To query from additional external Application Insights resources use the app identifier.

union app('app01').requests, app('app02').requests, requests
| summarize count() by bin(timestamp, 1h)

このクエリは、3 つの異なるアプリケーションからの要求を組み合わせています。This query is combining requests from three different applications. app01 という名前のアプリ、app02 という名前のアプリ、ローカルの Application Insights リソースからの要求です。An app named app01, an app named app02, and the requests from the local Application Insights resource.

外部の Log Analytics ワークスペースからデータを取得するには、workspace 識別子を使用します。To pull in data from an external Log Analytics workspace use the workspace identifier.

リソース間のクエリの詳細については、公式のガイダンスをご覧ください。To learn more about cross-resource queries refer to the official guidance.

分析クエリの詳細設定Advanced analytic query settings

各セクションには独自の詳細設定があります。これらの設定には、 [パラメーターの追加] ボタンの右側にある設定アイコン Application Insights の [ブック] セクションの編集コントロール からアクセスできます。Each section has its own advanced settings, which are accessible via the settings icon Application Insights Workbooks section editing controls located to the right of the Add parameters button.

Application Insights の [ブック] セクションの編集コントロール

任意の幅Custom width 項目を任意のサイズにするには、この設定を使用します。多数の項目を 1 行に収めることができるので、グラフやテーブルを内容豊富な対話型レポートに効果的に整理できます。Set this to make an item an arbitrary size, so you can fit many items on a single line allowing you to better organize your charts and tables into rich interactive reports.
条件付きで表示するConditionally visible 閲覧モード時にパラメーター値に基づいてステップを非表示にするには、この設定を使用します。Use this to hide steps based on a parameter when in reading mode.
パラメーターをエクスポートするExport a parameter グリッドまたはグラフ内で選択した行について、後のステップで値を変更したり、表示したりすることができます。This allows a selected row in the grid or chart to cause later steps to change values or become visible.
編集中でないときにクエリを表示するShow query when not editing 閲覧モードのときでも、グラフまたはテーブルの上にクエリが表示されます。This displays the query above the chart or table even when in reading mode.
編集中でないときに、[分析で開く] ボタンを表示するShow open in analytics button when not editing グラフの右隅に青色の Analytics アイコンが追加され、ワンクリックでアクセスできるようになります。This adds the blue Analytics icon to the right-hand corner of the chart to allow one-click access.

これらの設定のほとんどは非常に直感的ですが、パラメーターのエクスポートを理解するには、この機能を使用しているブックを確認することをお勧めします。Most of these settings are fairly intuitive, but to understand Export a parameter it is better to examine a workbook that makes use of this functionality.

作成済みのブックの 1 つで、アクティブ ユーザーに関する情報が提供されます。One of the prebuilt workbooks provides information on Active Users.

ブックの最初のセクションは、分析クエリ データに基づいています。The first section of the workbook is based on Analytic query data:

Application Insights の [ブック] セクションの編集コントロール

2 番目のセクションも分析クエリ データに基づいていますが、最初のテーブルで行を選択すると、グラフの内容が対話形式で更新されます。The second section is also based on analytic query data, but selecting a row in the first table will interactively update the contents of the chart:

Application Insights の [ブック] セクションの編集コントロール

これは、テーブルの分析クエリの詳細設定で、 [When an item is selected, export a parameter](項目が選択されているときに、パラメーターをエクスポートする) を有効にすることによって可能になります。This is possible through use of the When an item is selected, export a parameter advanced settings that are enabled in the table's Analytics query.

Application Insights の [ブック] セクションの編集コントロール

行を選択すると、2 番目の分析クエリで、エクスポートされた値が使用されます。The second analytics query then utilizes the exported values when a row is selected. 行が選択されていない場合は、全体的な値を表す行が既定で使用されます。If no row is selected, it defaults to the row representing the overall values.

let start = startofday(ago({TimeRange} + {Metric}));
union customEvents, pageViews
| where timestamp >= start
| where name in ({Activities}) or '*' in ({Activities}) or ('%' in ({Activities}) and itemType == 'pageView') or ('#' in ({Activities}) and itemType == 'customEvent')
{OtherFilters}
| where '{Filter}' == '' or '{Filter}' == '🔸 Overall' or {AnalyzeBy} == replace('🔹 ', '', '{Filter}')
| evaluate activity_engagement(user_Id, timestamp, start, now(), 1d, {Metric})
| where timestamp >= startofday(ago({TimeRange}))
| project timestamp, ["Active User"] = dcount_activities_outer
| render timechart 

メトリック セクションを追加するAdding metrics sections

メトリック セクションでは、Azure Monitor のメトリック データを対話型レポートに組み込むためのフル アクセスが提供されます。Metrics sections give you full access to incorporate Azure Monitor metrics data into your interactive reports. 作成済みのブックの多くには、分析クエリ データとメトリック データの両方が含まれるので、両方の機能の利点をすべて 1 か所で最大限に活用できます。Many of the prebuilt workbooks will contain both analytic query data and metric data allowing you to take full advantage of the best of both features all in one place. また、アクセス可能なサブスクリプションのリソースからメトリック データを取得することもできます。You also have the ability to pull in metric data from resources in any of the subscriptions you have access to.

仮想マシンのデータをブックに取り込んで、CPU のパフォーマンスをグリッドで表示している例を次に示します。Here is an example of Virtual machine data being pulled into a workbook to provide a grid visualization of CPU performance:

Application Insights の [ブック] セクションの編集コントロール

パラメーター セクションを追加するAdding parameter sections

ブックのパラメーターを使用すると、クエリ セクションやテキスト セクションを手動で編集しなくても、ブックの値を変更できます。Workbook parameters allow you to change values in the workbook without having to manually edit the query or text sections. これにより、基になる分析クエリ言語を理解する必要がなくなり、ブックベースのレポート作成の潜在的な対象ユーザーが大幅に拡大されます。This removes the requirement of needing to understand the underlying analytics query language and greatly expands the potential audience of workbook-based reporting.

パラメーターの値は、{parameterName} のようにパラメーター名を中かっこで囲むことによって、クエリ、テキスト、または他のパラメーター セクションで置き換えられます。The values of parameters are replaced in query, text or other parameter sections by putting the name of the parameter in braces, like {parameterName}. パラメーター名には、JavaScript 識別子と同様の規則が適用され、基本的に英文字またはアンダースコアの後に英数字またはアンダースコアが続きます。Parameter names are limited to similar rules as JavaScript identifiers, basically alphabetic characters or underscores, followed by alphanumeric characters or underscores. たとえば、a1 は許可されますが、1a は許可されません。For example, a1 is allowed, but 1a is not allowed.

パラメーターは線形であり、ブックの先頭から始まり、後のステップへと流れます。Parameters are linear, starting from the top of a workbook and flowing down to later steps. ブックの後の部分で宣言されたパラメーターは、前の部分で宣言されたパラメーターをオーバーライドできます。Parameters declared later in a workbook can override those that were declared further up. これにより、クエリを使用するパラメーターは、前の部分で定義されたパラメーターの値にアクセスすることもできます。This also lets parameters that use queries to access the values from parameters defined further up. パラメーターのステップ自体の中でも、パラメーターは線形 (左から右) であり、右側のパラメーターはその同じステップで以前に宣言されたパラメーターに依存することができます。Within a parameter's step itself, parameters are also linear, left to right, where parameters to the right can depend on a parameter declared earlier in that same step.

現在、次の 4 種類のパラメーターがサポートされています。There are four different types of parameters which are currently supported:

[テキスト]Text ユーザーはテキスト ボックスを編集します。必要に応じて、既定値を入力するためのクエリを提供できます。the user will edit a text box, and you can optionally supply a query to fill in the default value.
ドロップダウンDrop down ユーザーは一連の値の中から選択します。The user will choose from a set of values.
時間の範囲の選択Time range picker ユーザーは、時間の範囲の値の定義済みセットから選択するか、カスタムの時間の範囲から選択します。The user will choose from a predefined set of time range values, or pick from a custom time range.
リソースの選択Resource picker ユーザーは、そのブック用に選択されたリソースの中から選択します。The user will choose from the resources selected for the workbook.

テキスト パラメーターを使用するUsing a text parameter

ユーザーがテキスト ボックスに入力した値は、エスケープしたり、引用符で囲んだりせずに、クエリで直接置き換えられます。The value a user types in the textbox is replaced directly in the query, with no escaping or quoting. 必要な値が文字列の場合、クエリでは '{parameter}' のようにパラメーターを引用符で囲む必要があります。If the value you need is a string, the query should have quotes around the parameter (like '{parameter}').

これにより、テキスト ボックス内の値を任意の場所で使用できるようになります。This allows the value in a text box to be used anywhere. 値には、テーブル名、列名、関数名、演算子などを指定できます。It can be a table name, column name, function name, operator, etc.

テキスト パラメーターには、 [Get default value from analytics query](分析クエリから既定値を取得する) という設定があります。この設定を使用すると、ブックの作成者はクエリを使用してそのテキスト ボックスの既定値を設定できます。The text parameter type has a setting Get default value from analytics query, which allows the workbook author to use a query to populate the default value for that textbox.

分析クエリから取得した既定値を使用する場合、最初の行の最初の値 (行 0、列 0) だけが既定値として使用されます。When using the default value from an analytics query, only the first value of the first row (row 0, column 0) is used as the default value. そのため、1 行および 1 列だけを返すようにクエリを制限することをお勧めします。Therefore it is recommended to limit your query to return just one row and one column. クエリによって返されるその他のデータは無視されます。Any other data returned by the query is ignored.

クエリから返される値は、エスケープしたり引用符で囲んだりせずに直接置き換えられます。Whatever value the query returns will be replaced directly with no escaping or quoting. クエリから行が返されない場合、パラメーターの結果は空の文字列になるか (パラメーターが必須でない場合)、未定義になります (パラメーターが必須の場合)。If the query returns no rows, the result of the parameter is either an empty string (if the parameter is not required) or undefined (if the parameter is required).

ドロップダウンを使用するUsing a dropdown

ドロップダウン パラメーターを使用すると、1 つまたは複数の値を選択できるドロップダウン コントロールを作成できます。The dropdown parameter type lets you create a dropdown control, allowing the selection of one or many values.

ドロップダウンは分析クエリによって設定されます。The dropdown is populated by an analytics query. クエリから 1 つの列が返される場合、その列の値はドロップダウン コントロールのラベルの両方になります。If the query returns one column, the values in that column are both the value and the label in the dropdown control. クエリから 2 つの列が返される場合は、最初の列がになり、2 番目の列がドロップダウンに表示されるラベルになります。If the query returns two columns, the first column is the value, and the second column is the label shown in the dropdown. クエリから 3 つの列が返される場合は、3 番目の列を使用して、そのドロップダウンの既定の選択が示されます。If the query returns three columns, the 3rd column is used to indicate the default selection in that dropdown. この列には任意の型を指定できますが、最も簡単なのはブール型または数値型を使用することです。この場合、0 が false、1 が true です。This column can be any type, but the simplest is to use bool or numeric types, where 0 is false, and 1 is true.

列が文字列型の場合、null/空の文字列は false とみなされ、その他の値は true とみなされます。If the column is a string type, null/empty string is considered false, and any other value is considered true. 単一選択ドロップダウンの場合、値が true である最初の値が既定の選択として使用されます。For single selection dropdowns, the first value with a true value is used as the default selection. 複数選択ドロップダウンの場合、値が true であるすべての値が既定の選択セットとして使用されます。For multiple selection dropdowns, all values with a true value are used as the default selected set. ドロップダウンの項目は、クエリから行が返された順序で表示されます。The items in the dropdown are shown in whatever order the query returned rows.

アクティブ ユーザー レポートに表示されるパラメーターを見てみましょう。Let's look at the parameters present in the Active Users report. [時間範囲] の横の編集記号をクリックします。Click the edit symbol next to TimeRange.

Application Insights の [ブック] セクションの編集コントロール

これにより、[パラメーターの編集] メニュー項目が表示されます。This will launch the Edit Parameter menu item:

Application Insights の [ブック] セクションの編集コントロール

このクエリでは、分析クエリ言語の datatable という機能を使用しています。この機能を使用すると、何もない状態から豊富な内容の任意のテーブルを生成できます。The query uses a feature of the analytics query language called a datatable that lets you generate an arbitrary table, full of content, out of thin air! たとえば、次のような分析クエリがあるとします。For example, the following analytics query:

datatable( column1:string, column2:string )
[
 "row 1 column 1", "row 1 column 2",
"row 2 column 1", "row 2 column 2"
]

次のような結果が生成されます。Generates the result:

Application Insights の [ブック] セクションの編集コントロール

より適切な例として、ドロップダウンを使用した名前での国や地域の選択があります。A more applicable example is using a dropdown to pick from a set of countries/regions by name:

customEvents
| where timestamp >= ago(14d)
| summarize count() by client_CountryOrRegion
| top 100 by count_
| project  client_CountryOrRegion 
| order by client_CountryOrRegion asc

このクエリでは、次のような結果が表示されます。The query will display results as follows:

国ドロップダウン

ドロップダウンは、対話型レポートをカスタマイズおよび作成するための非常に強力なツールです。Dropdowns are incredibly powerful tools for customizing and creating interactive reports.

時間の範囲のパラメーターTime range parameters

ドロップダウン パラメーターを使用して独自のカスタムの時間の範囲パラメーターを作成できますが、同程度の柔軟性を必要としない場合は、すぐに使用できる時間の範囲パラメーターを使用することもできます。While you can make your own custom time range parameter via the dropdown parameter type, you can also use the out-of-box time range parameter type if you don't need the same degree of flexibility.

時間の範囲パラメーターには、5 分から過去 90 日間まで、15 個の既定の範囲があります。Time range parameter types have 15 default ranges that go from five minutes to the last 90 days. カスタムの時間の範囲を選択できるオプションもあります。このオプションでは、レポートを操作するユーザーが時間の範囲の明示的な開始値と停止値を選択できます。There is also an option to allow custom time range selection, which allows the operator of the report to choose explicit start and stop values for the time range.

リソースの選択Resource picker

リソースの選択パラメーターを使用すると、レポートの範囲を特定の種類のリソースに設定できます。The resource picker parameter type gives you the ability to scope your report to certain types of resources. リソースの選択を活用している作成済みのブックの例として、エラーの分析情報ブックがあります。An example of prebuilt workbook that leverages the resource picker type is the Failure Insights workbook.

国ドロップダウン

ブックを保存してチームと共有するSaving and sharing workbooks with your team

Workbooks は Application Insights リソース内の、ユーザー個人の [個人用レポート] セクションか、Application Insights リソースにアクセスできるユーザーであれば誰でもアクセスできる [共有レポート] セクションのいずれかに保存されます。Workbooks are saved within an Application Insights resource, either in the My Reports section that's private to you or in the Shared Reports section that's accessible to everyone with access to the Application Insights resource. リソース内のすべてのブックを表示するには、操作バーの [開く] ボタンをクリックします。To view all the workbooks in the resource, click the Open button in the action bar.

[個人用レポート] にあるブックを共有するには:To share a workbook that's currently in My Reports:

  1. 操作バーで、 [開く] をクリックします。Click Open in the action bar
  2. 共有するブックの横にある [...] ボタンをクリックします。Click the "..." button beside the workbook you want to share
  3. [Move to Shared Reports](共有レポートに移動) をクリックします。Click Move to Shared Reports.

リンクまたは電子メールでブックを共有するには、操作バーで [共有] をクリックします。To share a workbook with a link or via email, click Share in the action bar. リンクの受信者がブックを表示するには、Azure Portal でこのリソースにアクセスできる必要があります。Keep in mind that recipients of the link need access to this resource in the Azure portal to view the workbook. 受信者が編集するには、そのリソースに対する共同作成者以上のアクセス許可が必要です。To make edits, recipients need at least Contributor permissions for the resource.

ブックへのリンクを Azure Dashboard にピン留めするには:To pin a link to a workbook to an Azure Dashboard:

  1. 操作バーで、 [開く] をクリックします。Click Open in the action bar
  2. ピン留めするブックの横にある [...] ボタンをクリックします。Click the "..." button beside the workbook you want to pin
  3. [ダッシュボードにピン留め] をクリックします。Click Pin to dashboard.

ブック テンプレートを提供するContributing workbook templates

優れたブック テンプレートを作成したら、コミュニティと共有できます。Have you created an awesome workbook template and want to share it with the community? 詳細については、GitHub リポジトリを参照してください。To learn more, visit our GitHub repo.

次のステップNext steps