Начало работы с Key Visualizer

На этой странице описано, как использовать Key Visualizer для проверки проблем производительности, связанных с вашими шаблонами использования Cloud Firestore.

Подготовка

Чтобы использовать Key Visualizer для Cloud Firestore, необходимо включить Firestore Key Visualizer API.

Роли, необходимые для включения API

Чтобы включить API, вам потребуется разрешение serviceusage.services.enable. Если вы создали проект, то, скорее всего, у вас уже есть это разрешение, поскольку вам назначена роль владельца (roles/owner). В противном случае вы можете получить это разрешение, если вам будет назначена роль администратора Service Usage (roles/serviceusage.serviceUsageAdmin). Подробнее о том, как назначать роли…

Включите API

Необходимые роли

Убедитесь, что вашему аккаунту назначена одна из следующих ролей IAM:

  • Владелец Cloud Datastore
  • Cloud Datastore Key Visualizer Viewer
  • Редактор
  • Владелец

Эти роли включают следующие разрешения IAM, необходимые для доступа к Key Visualizer:

  • datastore.keyVisualizerScans.get
  • datastore.keyVisualizerScans.list
  • datastore.databases.getMetadata
  • resourcemanager.projects.get

Вы также можете создать специальную роль с нужными разрешениями.

Просмотр сканирования за определенный период времени

Каждое сканирование Key Visualizer охватывает двухчасовой период. Сканирование за определенный период доступно для баз данных, в которых трафик превышает 3000 операций с документами в любую минуту этого периода.

Чтобы запустить Key Visualizer, выполните следующие действия:

  1. В консоли Google Cloud перейдите на страницу Databases (Базы данных).

    Перейти к базам данных

  2. Выберите нужную базу данных из списка.

  3. В меню навигации выберите Key Visualizer.

  4. Выберите период времени и показатель из доступных сканирований Key Visualizer:

    1. Нажмите на значок карандаша в правом верхнем углу. Выберите дату и период времени.

      Сканирование доступно, если соблюдены требования. Вы не можете выбрать периоды времени, которые не соответствуют требованиям для сканирования или все ещё обрабатываются. Для обработки двух последних сканирований за день потребуется некоторое время.

    2. В качестве источника выберите Все данные документа или Все данные индекса.

    3. Нажмите Обновить.

  5. Выберите показатель для анализа:

    Нажмите на раскрывающийся список показателей в левом верхнем углу и выберите нужный показатель. По умолчанию в Key Visualizer открывается показатель Операций в секунду для ключей документов и показатель Операций записи в секунду для ключей индексов.

Чтобы сравнить показатели или найти корреляции данных, вы можете отобразить несколько показателей Key Visualizer вместе. Подробнее о том, как находить связи между разными показателями…

Просмотр обзора активности

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

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

  • Диапазоны, показанные темными цветами, имеют низкую активность или не имеют ее вообще.
  • Диапазоны, выделенные яркими цветами, имеют значительно большую активность.
  • Светящаяся белая область в центре – это зона очень высокой активности.

Пример сканирования Key Visualizer

Сканирование ключей документов

Показатель Операций/с отражает количество запросов в секунду для каждого диапазона ключей. Этот показатель представляет собой сумму запросов на запись, поиск и запросов. Key Visualizer показывает этот показатель по умолчанию, когда вы открываете тепловую карту.

Получив представление об общей активности в базе данных, вы можете продолжить исследование, изучив другие показатели и сосредоточившись на ключевых диапазонах, которые могут вызывать проблемы. Подробнее…

Сканирование ключей индекса

Показатель Операции записи в индекс/с в определенной ячейке измеряет среднее количество записей в индекс в секунду в пределах соответствующего 10-секундного интервала времени и диапазона ключей.

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