LoadTestRunClient.GetMetrics メソッド

定義

名前空間:

Azure.Developer.LoadTesting

アセンブリ:

Azure.Developer.LoadTesting.dll

パッケージ:

Azure.Developer.LoadTesting v1.0.1

ソース:

LoadTestRunClient.cs

ロード テスト実行のメトリック値を一覧表示します。

public virtual Azure.Pageable<BinaryData> GetMetrics (string testRunId, string metricName, string metricNamespace, string timespan, Azure.Core.RequestContent content = default, string aggregation = default, string interval = default, Azure.RequestContext context = default);

abstract member GetMetrics : string * string * string * string * Azure.Core.RequestContent * string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetMetrics : string * string * string * string * Azure.Core.RequestContent * string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>

Public Overridable Function GetMetrics (testRunId As String, metricName As String, metricNamespace As String, timespan As String, Optional content As RequestContent = Nothing, Optional aggregation As String = Nothing, Optional interval As String = Nothing, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)

パラメーター

testRunId

String

ロード テストの実行の一意の名前。小文字のアルファベット、数字、アンダースコア、またはハイフン文字のみを含める必要があります。

metricName

String

メトリックの名前です。

metricNamespace

String

メトリック定義のクエリを実行するメトリック名前空間。

timespan

String

クエリの期間。 "startDateTime_ISO/endDateTime_ISO" という形式の文字列です。

content

RequestContent

要求の本文として送信するコンテンツ。 要求本文スキーマの詳細については、以下の「解説」セクションを参照してください。

aggregation

String

集計。

interval

String

クエリの間隔 (つまり、タイムグレイン)。 使用できる値: "PT5S" |"PT10S" |"PT1M" |"PT5M" |"PT1H"

context

RequestContext

要求コンテキスト。これは、呼び出しごとにクライアント パイプラインの既定の動作をオーバーライドできます。

戻り値

Pageable<BinaryData>

Pageable<T>オブジェクトの一覧を含むサービスの BinaryData 。 コレクション内の各項目の本文スキーマの詳細については、以下の「解説」セクションを参照してください。

例外

ArgumentNullException

testRunId、metricName、metricNamespace、または timespan が null です。

ArgumentException

testRunId は空の文字列であり、空でないと想定されていました。

RequestFailedException

サービスから成功以外の状態コードが返されました。

例

このサンプルでは、必要なパラメーターを使用して GetMetrics を呼び出し、結果を解析する方法を示します。

var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new LoadTestRunClient(endpoint, credential);

var data = new {};

foreach (var data in client.GetMetrics("<testRunId>", "<metricname>", "<metricNamespace>", "<timespan>", RequestContent.Create(data)))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.ToString());
}

このサンプルでは、すべてのパラメーターと要求コンテンツを使用して GetMetrics を呼び出す方法と、結果を解析する方法を示します。

var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new LoadTestRunClient(endpoint, credential);

var data = new {
    filters = new[] {
        new {
            name = "<name>",
            values = new[] {
                "<String>"
            },
        }
    },
};

foreach (var data in client.GetMetrics("<testRunId>", "<metricname>", "<metricNamespace>", "<timespan>", RequestContent.Create(data), "<aggregation>", "<interval>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("data")[0].GetProperty("timestamp").ToString());
    Console.WriteLine(result.GetProperty("data")[0].GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("dimensionValues")[0].GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("dimensionValues")[0].GetProperty("value").ToString());
}

注釈

要求ペイロードの JSON スキーマと、ページング可能な応答の 1 つの項目を次に示します。

要求本文:

の MetricRequestPayloadスキーマ:

{
  filters: [
    {
      name: string, # Optional. The dimension name
      values: [string], # Optional. The dimension values. Maximum values can be 20.
    }
  ], # Optional. Get metrics for specific dimension values. Example: Metric contains dimension like SamplerName, Error. To retrieve all the time series data where SamplerName is equals to HTTPRequest1 or HTTPRequest2, the DimensionFilter value will be {"SamplerName", ["HTTPRequest1", "HTTPRequest2"}
}

応答本文:

の MetricsValueスキーマ:

{
  data: [
    {
      timestamp: string, # Optional. The timestamp for the metric value in ISO 8601 format.
      value: number, # Optional. The metric value.
    }
  ], # Optional. An array of data points representing the metric values.
  dimensionValues: [
    {
      name: string, # Optional. The name of the dimension.
      value: string, # Optional. The value of the dimension.
    }
  ], # Optional. The dimension values 
}