Клиентская библиотека запросов Azure Monitor для JavaScript версии 1.2.0

Статья
03/27/2024

Клиентская библиотека запросов Azure Monitor используется для выполнения запросов только для чтения к двум платформам данных Azure Monitor:

Журналы — собирает и упорядочивает данные журналов и производительности из отслеживаемых ресурсов. Данные из различных источников, таких как журналы платформы из служб Azure, журналы и данные о производительности из агентов виртуальных машин, а также данные об использовании и производительности из приложений, можно объединить в одну рабочую область Azure Log Analytics. Различные типы данных можно анализировать вместе с помощью язык запросов Kusto.
Метрики — собирает числовые данные из отслеживаемых ресурсов в базу данных временных рядов. Метрики — это числовые значения, которые собираются через регулярные интервалы и описывают определенный аспект ресурса на определенный момент времени. Метрики являются упрощенными и способны поддерживать сценарии практически в реальном времени, что делает их полезными для оповещения и быстрого обнаружения проблем.

Ресурсы:

Начало работы

Поддерживаемые среды

LTS версии Node.js
Последние версии Safari, Chrome, Microsoft Edge и Firefox

Дополнительные сведения см. в нашей политике поддержки.

Предварительные требования

Подписка Azure
Реализация TokenCredential , например тип учетных данных библиотеки удостоверений Azure.
Чтобы запросить журналы, необходимо выполнить одно из следующих действий.
- Рабочая область Azure Log Analytics
- Ресурс Azure любого типа (учетная запись хранения, Key Vault, Cosmos DB и т. д.)
Для запроса метрик требуется ресурс Azure любого типа (учетная запись хранения, Key Vault, Cosmos DB и т. д.).

Установка пакета

Установите клиентскую библиотеку запросов Azure Monitor для JavaScript с помощью npm:

npm install @azure/monitor-query

Создание клиента

Для запроса журналов или метрик требуется клиент, прошедший проверку подлинности. Для проверки подлинности в следующем примере используется DefaultAzureCredential из пакета @azure/identity .

import { DefaultAzureCredential } from "@azure/identity";
import { LogsQueryClient, MetricsQueryClient, MetricsBatchQueryClient } from "@azure/monitor-query";

const credential = new DefaultAzureCredential();

const logsQueryClient: LogsQueryClient = new LogsQueryClient(credential);
// or
const metricsQueryClient: MetricsQueryClient = new MetricsQueryClient(credential);
// or
const endPoint: string = "<YOUR_METRICS_ENDPOINT>"; //for example, https://eastus.metrics.monitor.azure.com/

const metricsQueryClient: MetricsQueryClient = new MetricsQueryClient(
  endPoint,
  credential
);

Настройка клиента для национального облака Azure

По умолчанию LogsQueryClient и MetricsQueryClient настроены для использования общедоступного облака Azure. Чтобы вместо этого использовать независимое облако, укажите правильный endpoint аргумент. Пример:

import { DefaultAzureCredential } from "@azure/identity";
import { LogsQueryClient, MetricsQueryClient } from "@azure/monitor-query";

const credential = new DefaultAzureCredential();

const logsQueryClient = new LogsQueryClient(credential, {
  endpoint: "https://api.loganalytics.azure.cn/v1",
});

// or
const metricsQueryClient = new MetricsQueryClient(credential{
  endpoint: "https://management.chinacloudapi.cn",
});

Примечание. В настоящее MetricsQueryClient время использует конечную точку Azure Resource Manager (ARM) для запроса метрик. При использовании этого клиента требуется соответствующая конечная точка управления для облака. Эти сведения могут быть изменены в будущем.

Выполнение запроса

Примеры запросов журналов и метрик см. в разделе Примеры .

Основные понятия

Регистрирует ограничения скорости запросов и регулирование

Служба Log Analytics применяет регулирование, если частота запросов слишком высока. Ограничения, такие как максимальное количество возвращаемых строк, также применяются к запросам Kusto. Дополнительные сведения см. в разделе API запросов.

Структура данных метрик

Каждый набор значений метрик представляет собой временные ряды со следующими характеристиками:

время получения значения;
Ресурс, связанный со значением
пространство имен, используемое в качестве категории метрики;
имя метрики;
само значение;
Некоторые метрики имеют несколько измерений, как описано в многомерных метриках. Пользовательские метрики могут иметь до 10 измерений.

Примеры

Запрос к журналам
Запрос к журналам пакетной службы
- Обработка ответа на пакетный запрос журналов
Расширенные сценарии запросов к журналам
- Настройка времени ожидания запроса журналов
- Запрос нескольких рабочих областей
Запрос метрик

Запрос к журналам

Можно LogsQueryClient использовать для запроса рабочей области Log Analytics с помощью язык запросов Kusto. Можно timespan.duration указать как строку в формате длительности ISO 8601. Можно использовать Durations константы, предоставленные для некоторых часто используемых длительности ISO 8601.

Вы можете запрашивать журналы по идентификатору рабочей области или идентификатору ресурса. Результат возвращается в виде таблицы с коллекцией строк.

Запрос журналов, ориентированных на рабочую область

Для запроса по идентификатору LogsQueryClient.queryWorkspace рабочей области используйте метод :

import { DefaultAzureCredential } from "@azure/identity";
import { Durations, LogsQueryClient, LogsQueryResultStatus, LogsTable } from "@azure/monitor-query";

const azureLogAnalyticsWorkspaceId = "<the Workspace Id for your Azure Log Analytics resource>";
const logsQueryClient = new LogsQueryClient(new DefaultAzureCredential());

async function run() {
  const kustoQuery = "AppEvents | limit 1";
  const result = await logsQueryClient.queryWorkspace(azureLogAnalyticsWorkspaceId, kustoQuery, {
    duration: Durations.twentyFourHours,
  });

  if (result.status === LogsQueryResultStatus.Success) {
    const tablesFromResult: LogsTable[] = result.tables;

    if (tablesFromResult.length === 0) {
      console.log(`No results for query '${kustoQuery}'`);
      return;
    }
    console.log(`This query has returned table(s) - `);
    processTables(tablesFromResult);
  } else {
    console.log(`Error processing the query '${kustoQuery}' - ${result.partialError}`);
    if (result.partialTables.length > 0) {
      console.log(`This query has also returned partial data in the following table(s) - `);
      processTables(result.partialTables);
    }
  }
}

async function processTables(tablesFromResult: LogsTable[]) {
  for (const table of tablesFromResult) {
    const columnHeaderString = table.columnDescriptors
      .map((column) => `${column.name}(${column.type}) `)
      .join("| ");
    console.log("| " + columnHeaderString);

    for (const row of table.rows) {
      const columnValuesString = row.map((columnValue) => `'${columnValue}' `).join("| ");
      console.log("| " + columnValuesString);
    }
  }
}

run().catch((err) => console.log("ERROR:", err));

Запрос журналов, ориентированных на ресурсы

В следующем примере показано, как запрашивать журналы непосредственно из ресурса Azure. queryResource Здесь используется метод и передается идентификатор ресурса Azure. Например, /subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}.

Чтобы найти идентификатор ресурса, выполните следующие действия:

Перейдите на страницу ресурса в портал Azure.
В колонке Обзор выберите ссылку Представление JSON .
В результирующем коде JSON скопируйте значение id свойства .

/**
 * @summary Demonstrates how to run a query against a Log Analytics workspace, using an Azure resource ID.
 */

import { DefaultAzureCredential } from "@azure/identity";
import {
  Durations,
  LogsQueryClient,
  LogsTable,
  LogsQueryOptions,
  LogsQueryResultStatus,
} from "@azure/monitor-query";
import * as dotenv from "dotenv";
dotenv.config();

const logsResourceId = process.env.LOGS_RESOURCE_ID;

export async function main() {
  const tokenCredential = new DefaultAzureCredential();
  const logsQueryClient = new LogsQueryClient(tokenCredential);

  if (!logsResourceId) {
    throw new Error("LOGS_RESOURCE_ID must be set in the environment for this sample");
  }

  const kustoQuery = `MyTable_CL | summarize count()`

  console.log(`Running '${kustoQuery}' over the last One Hour`);
  const queryLogsOptions: LogsQueryOptions = {
    // explicitly control the amount of time the server can spend processing the query.
    serverTimeoutInSeconds: 600, // sets the timeout to 10 minutes
    // optionally enable returning additional statistics about the query's execution.
    // (by default, this is off)
    includeQueryStatistics: true,
  };

  const result = await logsQueryClient.queryResource(
    logsResourceId, 
    kustoQuery,
    { duration: Durations.sevenDays },
    queryLogsOptions);

  const executionTime =
    result.statistics && result.statistics.query && (result.statistics.query as any).executionTime;

  console.log(
    `Results for query '${kustoQuery}', execution time: ${
      executionTime == null ? "unknown" : executionTime
    }`
  );

  if (result.status === LogsQueryResultStatus.Success) {
    const tablesFromResult: LogsTable[] = result.tables;

    if (tablesFromResult.length === 0) {
      console.log(`No results for query '${kustoQuery}'`);
      return;
    }
    console.log(`This query has returned table(s) - `);
    processTables(tablesFromResult);
  } else {
    console.log(`Error processing the query '${kustoQuery}' - ${result.partialError}`);
    if (result.partialTables.length > 0) {
      console.log(`This query has also returned partial data in the following table(s) - `);
      processTables(result.partialTables);
    }
  }
}

async function processTables(tablesFromResult: LogsTable[]) {
  for (const table of tablesFromResult) {
    const columnHeaderString = table.columnDescriptors
      .map((column) => `${column.name}(${column.type}) `)
      .join("| ");
    console.log("| " + columnHeaderString);

    for (const row of table.rows) {
      const columnValuesString = row.map((columnValue) => `'${columnValue}' `).join("| ");
      console.log("| " + columnValuesString);
    }
  }
}

main().catch((err) => {
  console.error("The sample encountered an error:", err);
  process.exit(1);
});

Обработка ответа на запрос журналов

Функция queryWorkspace возвращает LogsQueryClientLogsQueryResult объект . Тип объекта может быть или LogsQuerySuccessfulResultLogsQueryPartialResult. Вот иерархия ответа:

LogsQuerySuccessfulResult
|---statistics
|---visualization
|---status ("Success")
|---tables (list of `LogsTable` objects)
    |---name
    |---rows
    |---columnDescriptors (list of `LogsColumn` objects)
        |---name
        |---type

LogsQueryPartialResult
|---statistics
|---visualization
|---status ("PartialFailure")
|---partialError
    |--name
    |--code
    |--message
    |--stack
|---partialTables (list of `LogsTable` objects)
    |---name
    |---rows
    |---columnDescriptors (list of `LogsColumn` objects)
        |---name
        |---type

Например, для обработки ответа с таблицами:

async function processTables(tablesFromResult: LogsTable[]) {
  for (const table of tablesFromResult) {
    const columnHeaderString = table.columnDescriptors
      .map((column) => `${column.name}(${column.type}) `)
      .join("| ");
    console.log("| " + columnHeaderString);

    for (const row of table.rows) {
      const columnValuesString = row.map((columnValue) => `'${columnValue}' `).join("| ");
      console.log("| " + columnValuesString);
    }
  }
}

Полный пример можно найти здесь.

Запрос к журналам пакетной службы

В следующем примере демонстрируется отправка нескольких запросов одновременно с помощью API пакетных запросов. Запросы можно представить в виде списка BatchQuery объектов .

export async function main() {
  if (!monitorWorkspaceId) {
    throw new Error("MONITOR_WORKSPACE_ID must be set in the environment for this sample");
  }

  const tokenCredential = new DefaultAzureCredential();
  const logsQueryClient = new LogsQueryClient(tokenCredential);

  const kqlQuery = "AppEvents | project TimeGenerated, Name, AppRoleInstance | limit 1";
  const queriesBatch = [
    {
      workspaceId: monitorWorkspaceId,
      query: kqlQuery,
      timespan: { duration: "P1D" },
    },
    {
      workspaceId: monitorWorkspaceId,
      query: "AzureActivity | summarize count()",
      timespan: { duration: "PT1H" },
    },
    {
      workspaceId: monitorWorkspaceId,
      query:
        "AppRequests | take 10 | summarize avgRequestDuration=avg(DurationMs) by bin(TimeGenerated, 10m), _ResourceId",
      timespan: { duration: "PT1H" },
    },
    {
      workspaceId: monitorWorkspaceId,
      query: "AppRequests | take 2",
      timespan: { duration: "PT1H" },
      includeQueryStatistics: true,
    },
  ];

  const result = await logsQueryClient.queryBatch(queriesBatch);

  if (result == null) {
    throw new Error("No response for query");
  }

  let i = 0;
  for (const response of result) {
    console.log(`Results for query with query: ${queriesBatch[i]}`);
    if (response.status === LogsQueryResultStatus.Success) {
      console.log(
        `Printing results from query '${queriesBatch[i].query}' for '${queriesBatch[i].timespan}'`
      );
      processTables(response.tables);
    } else if (response.status === LogsQueryResultStatus.PartialFailure) {
      console.log(
        `Printing partial results from query '${queriesBatch[i].query}' for '${queriesBatch[i].timespan}'`
      );
      processTables(response.partialTables);
      console.log(
        ` Query had errors:${response.partialError.message} with code ${response.partialError.code}`
      );
    } else {
      console.log(`Printing errors from query '${queriesBatch[i].query}'`);
      console.log(` Query had errors:${response.message} with code ${response.code}`);
    }
    // next query
    i++;
  }
}

async function processTables(tablesFromResult: LogsTable[]) {
  for (const table of tablesFromResult) {
    const columnHeaderString = table.columnDescriptors
      .map((column) => `${column.name}(${column.type}) `)
      .join("| ");
    console.log("| " + columnHeaderString);

    for (const row of table.rows) {
      const columnValuesString = row.map((columnValue) => `'${columnValue}' `).join("| ");
      console.log("| " + columnValuesString);
    }
  }
}

Обработка ответа на пакетный запрос журналов

Функция queryBatch возвращает LogsQueryClientLogsQueryBatchResult объект . LogsQueryBatchResult содержит список объектов со следующими возможными типами:

LogsQueryPartialResult
LogsQuerySuccessfulResult
LogsQueryError

Вот иерархия ответа:

LogsQuerySuccessfulResult
|---statistics
|---visualization
|---status ("Success")
|---tables (list of `LogsTable` objects)
    |---name
    |---rows
    |---columnDescriptors (list of `LogsColumn` objects)
        |---name
        |---type

LogsQueryPartialResult
|---statistics
|---visualization
|---status ("PartialFailure")
|---partialError
    |--name
    |--code
    |--message
    |--stack
|---partialTables (list of `LogsTable` objects)
    |---name
    |---rows
    |---columnDescriptors (list of `LogsColumn` objects)
        |---name
        |---type

LogsQueryError
|--name
|--code
|--message
|--stack
|--status ("Failure")

Например, следующий код обрабатывает ответ на запрос к пакетным журналам:

async function processBatchResult(result: LogsQueryBatchResult) {
  let i = 0;
  for (const response of result) {
    console.log(`Results for query with query: ${queriesBatch[i]}`);
    if (response.status === LogsQueryResultStatus.Success) {
      console.log(
        `Printing results from query '${queriesBatch[i].query}' for '${queriesBatch[i].timespan}'`
      );
      processTables(response.tables);
    } else if (response.status === LogsQueryResultStatus.PartialFailure) {
      console.log(
        `Printing partial results from query '${queriesBatch[i].query}' for '${queriesBatch[i].timespan}'`
      );
      processTables(response.partialTables);
      console.log(
        ` Query had errors:${response.partialError.message} with code ${response.partialError.code}`
      );
    } else {
      console.log(`Printing errors from query '${queriesBatch[i].query}'`);
      console.log(` Query had errors:${response.message} with code ${response.code}`);
    }
    // next query
    i++;
  }
}

async function processTables(tablesFromResult: LogsTable[]) {
  for (const table of tablesFromResult) {
    const columnHeaderString = table.columnDescriptors
      .map((column) => `${column.name}(${column.type}) `)
      .join("| ");
    console.log("| " + columnHeaderString);

    for (const row of table.rows) {
      const columnValuesString = row.map((columnValue) => `'${columnValue}' `).join("| ");
      console.log("| " + columnValuesString);
    }
  }
}

Полный пример можно найти здесь.

Сценарии запросов к расширенным журналам

Установка времени ожидания запроса журналов

Выполнение некоторых запросов журналов занимает более 3 минут. Время ожидания сервера по умолчанию составляет 3 минуты. Время ожидания сервера можно увеличить до 10 минут. В следующем примере LogsQueryOptions свойство объекта serverTimeoutInSeconds используется для увеличения времени ожидания сервера до 10 минут:

// setting optional parameters
const queryLogsOptions: LogsQueryOptions = {
  // explicitly control the amount of time the server can spend processing the query.
  serverTimeoutInSeconds: 600, // 600 seconds = 10 minutes
};

const result = await logsQueryClient.queryWorkspace(
  azureLogAnalyticsWorkspaceId,
  kustoQuery,
  { duration: Durations.twentyFourHours },
  queryLogsOptions
);

const tablesFromResult = result.tables;

Запрос нескольких рабочих областей

Один и тот же запрос журналов может выполняться в нескольких рабочих областях Log Analytics. Помимо запроса Kusto требуются следующие параметры:

workspaceId — первый (основной) идентификатор рабочей области.
additionalWorkspaces — список рабочих областей, за исключением рабочей области, указанной в параметре workspaceId . Элементы списка параметра могут состоять из следующих форматов идентификаторов:
- Полные имена рабочих областей
- Идентификаторы рабочих областей
- Идентификаторы ресурсов Azure

Например, следующий запрос выполняется в трех рабочих областях:

const queryLogsOptions: LogsQueryOptions = {
  additionalWorkspaces: ["<workspace2>", "<workspace3>"],
};

const kustoQuery = "AppEvents | limit 10";
const result = await logsQueryClient.queryWorkspace(
  azureLogAnalyticsWorkspaceId,
  kustoQuery,
  { duration: Durations.twentyFourHours },
  queryLogsOptions
);

Чтобы просмотреть результаты для каждой рабочей области, используйте TenantId столбец , чтобы упорядочить результаты или отфильтровать их в запросе Kusto.

Упорядочивание результатов по Идентификатору клиента

AppEvents | order by TenantId

Фильтрация результатов по Идентификатору клиента

AppEvents | filter TenantId == "<workspace2>"

Полный пример можно найти здесь.

Включить статистику

Чтобы получить статистику выполнения запросов журналов, например потребление ЦП и памяти, выполните следующие действия.

Задайте свойству LogsQueryOptions.includeQueryStatistics значение true.
Доступ к полю statistics внутри LogsQueryResult объекта .

В следующем примере выводится время выполнения запроса:

const workspaceId = "<workspace_id>";
const logsQueryClient = new LogsQueryClient(new DefaultAzureCredential());
const kustoQuery = "AzureActivity | top 10 by TimeGenerated";

const result = await logsQueryClient.queryWorkspace(
  monitorWorkspaceId,
  kustoQuery,
  { duration: Durations.oneDay },
  {
    includeQueryStatistics: true,
  }
);

const executionTime =
  result.statistics && result.statistics.query && result.statistics.query.executionTime;

console.log(
  `Results for query '${kustoQuery}', execution time: ${
    executionTime == null ? "unknown" : executionTime
  }`
);

Так как структура полезных statistics данных зависит от запроса, используется тип возвращаемого Record<string, unknown> значения. Он содержит необработанный ответ JSON. Статистика находится в свойстве query JSON. Пример:

{
  "query": {
    "executionTime": 0.0156478,
    "resourceUsage": {...},
    "inputDatasetStatistics": {...},
    "datasetStatistics": [{...}]
  }
}

Включить визуализацию

Чтобы получить данные визуализации для запросов журналов с помощью оператора render, выполните следующие действия:

Задайте свойству LogsQueryOptions.includeVisualization значение true.
Доступ к полю visualization внутри LogsQueryResult объекта .

Пример:

const workspaceId = "<workspace_id>";
const logsQueryClient = new LogsQueryClient(new DefaultAzureCredential());

const result = await logsQueryClient.queryWorkspace(
    monitorWorkspaceId,
    @"StormEvents
        | summarize event_count = count() by State
        | where event_count > 10
        | project State, event_count
        | render columnchart",
    { duration: Durations.oneDay },
    {
      includeVisualization: true
    }
  );
console.log("visualization result:", result.visualization);

Так как структура полезных visualization данных зависит от запроса, используется тип возвращаемого Record<string, unknown> значения. Он содержит необработанный ответ JSON. Пример:

{
  "visualization": "columnchart",
  "title": "the chart title",
  "accumulate": false,
  "isQuerySorted": false,
  "kind": null,
  "legend": null,
  "series": null,
  "yMin": "NaN",
  "yMax": "NaN",
  "xAxis": null,
  "xColumn": null,
  "xTitle": "x axis title",
  "yAxis": null,
  "yColumns": null,
  "ySplit": null,
  "yTitle": null,
  "anomalyColumns": null
}

Запрос метрик

В следующем примере возвращаются метрики для подписки Помощника по метрикам Azure . URI ресурса должен быть URI ресурса, для которого запрашиваются метрики. Обычно это формат /subscriptions/<id>/resourceGroups/<rg-name>/providers/<source>/topics/<resource-name>.

Чтобы найти URI ресурса, выполните следующие действия:

Перейдите на страницу ресурса в портал Azure.
В колонке Обзор выберите ссылку Представление JSON .
В результирующем коде JSON скопируйте значение id свойства .

import { DefaultAzureCredential } from "@azure/identity";
import { Durations, Metric, MetricsQueryClient } from "@azure/monitor-query";
import * as dotenv from "dotenv";

dotenv.config();

const metricsResourceId = process.env.METRICS_RESOURCE_ID;

export async function main() {
  const tokenCredential = new DefaultAzureCredential();
  const metricsQueryClient = new MetricsQueryClient(tokenCredential);

  if (!metricsResourceId) {
    throw new Error("METRICS_RESOURCE_ID must be set in the environment for this sample");
  }

  const iterator = metricsQueryClient.listMetricDefinitions(metricsResourceId);
  let result = await iterator.next();
  let metricNames: string[] = [];
  for await (const result of iterator) {
    console.log(` metricDefinitions - ${result.id}, ${result.name}`);
    if (result.name) {
      metricNames.push(result.name);
    }
  }
  const firstMetricName = metricNames[0];
  const secondMetricName = metricNames[1];
  if (firstMetricName && secondMetricName) {
    console.log(`Picking an example metric to query: ${firstMetricName} and ${secondMetricName}`);
    const metricsResponse = await metricsQueryClient.queryResource(
      metricsResourceId,
      [firstMetricName, secondMetricName],
      {
        granularity: "PT1M",
        timespan: { duration: Durations.fiveMinutes },
      }
    );

    console.log(
      `Query cost: ${metricsResponse.cost}, interval: ${metricsResponse.granularity}, time span: ${metricsResponse.timespan}`
    );

    const metrics: Metric[] = metricsResponse.metrics;
    console.log(`Metrics:`, JSON.stringify(metrics, undefined, 2));
    const metric = metricsResponse.getMetricByName(firstMetricName);
    console.log(`Selected Metric: ${firstMetricName}`, JSON.stringify(metric, undefined, 2));
  } else {
    console.error(`Metric names are not defined - ${firstMetricName} and ${secondMetricName}`);
  }
}

main().catch((err) => {
  console.error("The sample encountered an error:", err);
  process.exit(1);
});

В предыдущем примере результаты метрики упорядочены в metricsResponse соответствии с порядком, в котором пользователь указывает имена метрик в аргументе metricNames массива queryResource для функции. Если пользователь указывает [firstMetricName, secondMetricName], результат для firstMetricName будет отображаться перед результатом для secondMetricName в metricResponse.

Обработка ответа на запрос метрик

Функция метрик queryResource возвращает QueryMetricsResult объект . Объект QueryMetricsResult содержит такие свойства, как список Metricобъектов типа , intervalnamespaceи timespan. Доступ Metric к списку объектов можно получить с помощью metrics свойства . Каждый Metric объект в этом списке содержит список TimeSeriesElement объектов . Каждый содержит TimeSeriesElementdata свойства и metadataValues . В визуальной форме иерархия объектов ответа выглядит примерно так:

QueryMetricsResult
|---cost
|---timespan (of type `QueryTimeInterval`)
|---granularity
|---namespace
|---resourceRegion
|---metrics (list of `Metric` objects)
    |---id
    |---type
    |---name
    |---unit
    |---displayDescription
    |---errorCode
    |---timeseries (list of `TimeSeriesElement` objects)
        |---metadataValues
        |---data (list of data points represented by `MetricValue` objects)
            |---timeStamp
            |---average
            |---minimum
            |---maximum
            |---total
            |---count
|---getMetricByName(metricName): Metric | undefined (convenience method)

Пример обработки ответа

import { DefaultAzureCredential } from "@azure/identity";
import { Durations, Metric, MetricsQueryClient } from "@azure/monitor-query";
import * as dotenv from "dotenv";
dotenv.config();

const metricsResourceId = process.env.METRICS_RESOURCE_ID;
export async function main() {
  const tokenCredential = new DefaultAzureCredential();
  const metricsQueryClient = new MetricsQueryClient(tokenCredential);

  if (!metricsResourceId) {
    throw new Error(
      "METRICS_RESOURCE_ID for an Azure Metrics Advisor subscription must be set in the environment for this sample"
    );
  }

  console.log(`Picking an example metric to query: MatchedEventCount`);

  const metricsResponse = await metricsQueryClient.queryResource(
    metricsResourceId,
    ["MatchedEventCount"],
    {
      timespan: {
        duration: Durations.fiveMinutes,
      },
      granularity: "PT1M",
      aggregations: ["Count"],
    }
  );

  console.log(
    `Query cost: ${metricsResponse.cost}, granularity: ${metricsResponse.granularity}, time span: ${metricsResponse.timespan}`
  );

  const metrics: Metric[] = metricsResponse.metrics;
  for (const metric of metrics) {
    console.log(metric.name);
    for (const timeseriesElement of metric.timeseries) {
      for (const metricValue of timeseriesElement.data!) {
        if (metricValue.count !== 0) {
          console.log(`There are ${metricValue.count} matched events at ${metricValue.timeStamp}`);
        }
      }
    }
  }
}

main().catch((err) => {
  console.error("The sample encountered an error:", err);
  process.exit(1);
});

Полный пример можно найти здесь.

Запрос метрик для нескольких ресурсов

Чтобы запросить метрики для нескольких ресурсов Azure в одном запросе MetricsQueryClient.queryResources , используйте метод . Этот метод выполняет следующее:

Вызывает API, отличный от MetricsQueryClient методов .
При создании клиента требуется региональная конечная точка. Например, https://westus3.metrics.monitor.azure.com".

Каждый ресурс Azure должен находиться в:

Тот же регион, что и конечная точка, указанная при создании клиента.
Та же подписка Azure.

Кроме того, необходимо указать пространство имен метрик, содержащее метрики для запроса. Список пространств имен метрик см. в разделе Поддерживаемые метрики и категории журналов по типам ресурсов.

let resourceIds: string[] = [
  "/subscriptions/0000000-0000-000-0000-000000/resourceGroups/test/providers/Microsoft.OperationalInsights/workspaces/test-logs",
  "/subscriptions/0000000-0000-000-0000-000000/resourceGroups/test/providers/Microsoft.OperationalInsights/workspaces/test-logs2",
];
let metricsNamespace: string = "<YOUR_METRICS_NAMESPACE>";
let metricNames: string[] = ["requests", "count"];
const batchEndPoint: string = "<YOUR_METRICS_ENDPOINT>"; //for example, https://eastus.metrics.monitor.azure.com/

const credential = new DefaultAzureCredential();
const metricsQueryClient: MetricsQueryClient = new MetricsQueryClient(
  batchEndPoint,
  credential
);

const result: : MetricsQueryResult[] = await metricsQueryClient.queryResources(
  resourceIds,
  metricsNamespace,
  metricNames
);

Список метрик и измерений, доступных для каждого типа ресурсов Azure, см. в статье Поддерживаемые метрики в Azure Monitor.

Устранение неполадок

Сведения о диагностике различных сценариев сбоев см. в руководстве по устранению неполадок.

Дальнейшие действия

Дополнительные сведения об Azure Monitor см. в документации по службе Azure Monitor.

Участие

Если вы хотите вносить изменения в эту библиотеку, ознакомьтесь с руководством по внесению изменений, в котором содержатся сведения о создании и тестировании кода.

Тесты этого модуля представляют собой сочетание динамических и модульных тестов, для которых требуется экземпляр Azure Monitor. Чтобы выполнить тесты, необходимо выполнить следующую команду:

rush update
rush build -t @azure/monitor-query
cd into sdk/monitor/monitor-query
Скопируйте файл в sample.env папку .env
.env Откройте файл в редакторе и введите значения.
npm run test.

Дополнительные сведения см. в папке тестов .

Просмотры

Клиентская библиотека запросов Azure Monitor для JavaScript версии 1.2.0

Начало работы

Поддерживаемые среды

Предварительные требования

Установка пакета

Создание клиента

Настройка клиента для национального облака Azure

Выполнение запроса

Основные понятия

Регистрирует ограничения скорости запросов и регулирование

Структура данных метрик

Примеры

Запрос к журналам

Запрос журналов, ориентированных на рабочую область

Запрос журналов, ориентированных на ресурсы

Обработка ответа на запрос журналов

Запрос к журналам пакетной службы

Обработка ответа на пакетный запрос журналов

Сценарии запросов к расширенным журналам

Установка времени ожидания запроса журналов

Запрос нескольких рабочих областей

Включить статистику

Включить визуализацию

Запрос метрик

Обработка ответа на запрос метрик

Пример обработки ответа

Запрос метрик для нескольких ресурсов

Устранение неполадок

Дальнейшие действия

Участие

Обратная связь

Дополнительные ресурсы

Клиентская библиотека запросов Azure Monitor для JavaScript версии 1.2.0

Начало работы

Поддерживаемые среды

Предварительные требования

Установка пакета

Создание клиента

Настройка клиента для национального облака Azure

Выполнение запроса

Основные понятия

Регистрирует ограничения скорости запросов и регулирование

Структура данных метрик

Примеры

Запрос к журналам

Запрос журналов, ориентированных на рабочую область

Запрос журналов, ориентированных на ресурсы

Обработка ответа на запрос журналов

Запрос к журналам пакетной службы

Обработка ответа на пакетный запрос журналов

Сценарии запросов к расширенным журналам

Установка времени ожидания запроса журналов

Запрос нескольких рабочих областей

Включить статистику

Включить визуализацию

Запрос метрик

Обработка ответа на запрос метрик

Пример обработки ответа

Запрос метрик для нескольких ресурсов

Устранение неполадок

Дальнейшие действия

Участие

Связанные проекты

Обратная связь

Дополнительные ресурсы