google.cloud.gcp_logging_metric_info – Сбор информации для метрики GCP

Примечание

Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).

Для его установки используйте: 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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов к API.
project строка		Проект Google Cloud Platform, который необходимо использовать.
scopes список / элементы=строка		Массив используемых областей доступа.
service_account_contents jsonarg		Содержимое файла JSON учетной записи сервиса, либо в виде словаря, либо в виде JSON-строки, представляющей его.
service_account_email строка		Дополнительный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи сервиса, если в качестве типа выбран serviceaccount.

Примечания

Примечание

для аутентификации можно установить service_account_file с помощью переменной среды gcp_service_account_file.
для аутентификации можно установить service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно установить 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			успех	Параметры ведер требуются, когда метрика на основе логов использует тип значения DISTRIBUTION, и описывают границы ведер, используемые для создания гистограммы извлеченных значений.
		explicitBuckets complex		успех	Указывает набор ведер с произвольными ширинами.
			bounds list / elements=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`. Поддерживаемые единицы являются подмножеством стандарта [Единицы измерения](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) с одной группой захвата для извлечения данных из указанного поля записи лога. Значение поля преобразуется в строку перед применением регулярного выражения. Ошибка возникает при указании регулярного выражения, которое не содержит ровно одной группы захвата.

Авторы

Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_logging_metric_info_module.html