модуль google.cloud.gcp_logging_metric_info — сбор сведений о метрике GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_logging_metric_info.
Краткое описание
- Сбор сведений о метрике GCP
Требования
Следующие требования должны быть выполнены на узле, где выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Этот параметр изменяет только строку User Agent для запросов к API. |
project string | Проект Google Cloud Platform, который следует использовать. |
scopes list / элементы=string | Массив используемых областей доступа |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы — в виде словаря или строки JSON, представляющей его. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы, если выбрано machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount. |
Примечания
Примечание
- Для аутентификации можно задать service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно задать service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно задать service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно задать access_token с помощью переменной среды
GCP_ACCESS_TOKEN. - Для аутентификации можно задать auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно задать scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды используются только в том случае, если значения в плейбуке не заданы.
- Параметры service_account_email и service_account_file являются взаимоисключающими.
Примеры
- name: get info on a metric
gcp_logging_metric_info:
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
bucketOptions complex |
Параметр bucketOptions необходим, если метрика на основе журналов использует тип значения DISTRIBUTION; в нем описаны границы корзин, используемые для создания гистограммы извлеченных значений. Возвращается: при успехе |
|
explicitBuckets complex |
Задает набор корзин произвольной ширины. Возвращается: при успехе |
|
bounds list / элементы=string |
Значения должны монотонно возрастать. Возвращается: при успехе |
|
exponentialBuckets complex |
Задает экспоненциальную последовательность корзин, ширина которых пропорциональна значению нижней границы. Каждая корзина соответствует постоянной относительной неопределенности для конкретного значения в корзине. Возвращается: при успехе |
|
growthFactor string |
Должно быть больше 1. Возвращается: при успехе |
|
numFiniteBuckets integer |
Должно быть больше 0. Возвращается: при успехе |
|
scale string |
Должно быть больше 0. Возвращается: при успехе |
|
linearBuckets complex |
Задает линейную последовательность корзин одинаковой ширины (за исключением переполнения и недополнения). Каждая корзина соответствует постоянной абсолютной неопределенности для конкретного значения в корзине. Возвращается: при успехе |
|
numFiniteBuckets integer |
Должно быть больше 0. Возвращается: при успехе |
|
offset string |
Нижняя граница первой корзины. Возвращается: при успехе |
|
width integer |
Должно быть больше 0. Возвращается: при успехе |
|
description string |
Описание этой метрики, используемое в документации. Максимальная длина описания — 8000 символов. Возвращается: при успехе |
|
filter string |
Расширенный фильтр журналов (https://cloud.google.com/logging/docs/view/advanced-filters), используемый для поиска записей журнала. Возвращается: при успехе |
|
labelExtractors dictionary |
Сопоставление строкового ключа метки с выражением извлечения, которое используется для получения данных из поля записи журнала и назначения их в качестве значения метки. Для каждого ключа метки, указанного в LabelDescriptor, в этой карте должно быть задано соответствующее выражение извлечения. Синтаксис выражения извлечения такой же, как у поля valueExtractor. Возвращается: при успехе |
|
metricDescriptor complex |
Дескриптор метрики, связанный с метрикой на основе журналов. Возвращается: при успехе |
|
displayName string |
Краткое имя метрики, которое может отображаться в пользовательских интерфейсах. Используйте регистр предложений и не ставьте точку в конце, например «Количество запросов». Это поле необязательное, но рекомендуется задавать его для любых метрик, связанных с понятиями, видимыми пользователям, например квотами. Возвращается: при успехе |
|
labels complex |
Набор меток, описывающих конкретный экземпляр этого типа метрики. Например, у типа метрики appengine.googleapis.com/http/server/response_latencies есть метка кода ответа HTTP response_code, позволяющая просматривать задержки для успешных ответов или только для ответов с ошибками. Возвращается: при успехе |
|
description string |
Понятное пользователю описание метки. Возвращается: при успехе |
|
key string |
Ключ метки. Возвращается: при успехе |
|
valueType string |
Тип данных, присваиваемых метке. Возвращается: при успехе |
|
metricKind string |
Определяет, регистрирует ли метрика мгновенные значения, изменения значения и т. д. Некоторые сочетания metricKind и valueType могут не поддерживаться. Для метрик-счетчиков задайте значение DELTA. Возвращается: при успехе |
|
type string |
Тип метрики, включая префикс DNS-имени. Тип не кодируется для URL. Типы всех пользовательских метрик имеют DNS-имя `custom.googleapis.com` или `external.googleapis.com`. Возвращается: при успехе |
|
unit string |
Единица измерения, в которой указывается значение метрики. Применимо только в том случае, если valueType равен `INT64`, `DOUBLE` или `DISTRIBUTION`. Поддерживается подмножество единиц стандарта [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html). Возвращается: при успехе |
|
valueType string |
Определяет, является ли измерение целым числом, числом с плавающей точкой и т. д. Некоторые сочетания metricKind и valueType могут не поддерживаться. Для метрик-счетчиков задайте значение INT64. Возвращается: при успехе |
|
name string |
Идентификатор метрики, назначенный клиентом. Примеры: «error_count», «nginx/requests». Длина идентификатора метрики не должна превышать 100 символов; допустимы только следующие символы: A-Z, a-z, 0-9 и специальные символы _-.,+!*’,()%/. Символ косой черты (/) обозначает иерархию частей имени и не может быть первым символом имени. Возвращается: при успехе |
|
valueExtractor string |
При использовании метрики распределения на основе журналов параметр valueExtractor обязателен для извлечения значений, которые нужно записать из записи журнала. Поддерживаются две функции извлечения значений: EXTRACT(field) или REGEXP_EXTRACT(field, regex). Аргументы: 1. field — имя поля записи журнала, из которого извлекается значение. 2. regex — регулярное выражение в синтаксисе Google RE2 (https://github.com/google/re2/wiki/Syntax) с одной группой захвата для извлечения данных из указанного поля записи журнала. Перед применением регулярного выражения значение поля преобразуется в строку. Указание регулярного выражения, которое содержит не ровно одну группу захвата, считается ошибкой. Возвращается: при успехе |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_logging_metric_info_module.html