Модуль google.cloud.gcp_logging_metric_info – Сбор информации о метриках GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.4.1).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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 строка | Токен доступа OAuth2, если тип аутентификации — accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Изменяет только строку имени пользователя для всех запросов к API. |
project строка | Проект Google Cloud Platform для использования. |
scopes список / элементы=строка | Массив используемых областей видимости |
| ... | ... |
Примечания
Примечание
- для аутентификации можно установить 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 |
Параметры ведер необходимы, когда метрика на основе журналов использует тип значения DISTRIBUTION, и описывает границы ведер, используемые для создания гистограммы извлеченных значений. Возвращается: успешно |
|
explicitBuckets complex |
Определяет набор ведер с произвольными ширинами. Возвращается: успешно |
|
bounds список / элементы=строка |
Значения должны быть монотонно возрастающими. Возвращается: успешно |
|
exponentialBuckets complex |
Определяет экспоненциальную последовательность ведер, которые имеют ширину, пропорциональную значению нижней границы. Каждое ведро представляет собой постоянную относительную неопределенность определенного значения в ведре. Возвращается: успешно |
|
growthFactor строка |
Должно быть больше 1. Возвращается: успешно |
|
numFiniteBuckets целое число |
Должно быть больше 0. Возвращается: успешно |
|
scale строка |
Должно быть больше 0. Возвращается: успешно |
|
linearBuckets complex |
Определяет линейную последовательность ведер, у которых все имеют одинаковую ширину (за исключением переполнения и недолива). Каждое ведро представляет собой постоянную абсолютную неопределенность определенного значения в ведре. Возвращается: успешно |
|
numFiniteBuckets целое число |
Должно быть больше 0. Возвращается: успешно |
|
offset строка |
Нижняя граница первого ведра. Возвращается: успешно |
|
width целое число |
Должно быть больше 0. Возвращается: успешно |
|
description строка |
Описание этой метрики, используемое в документации. Максимальная длина описания составляет 8000 символов. Возвращается: успешно |
|
filter строка |
Расширенный фильтр журналов (https://cloud.google.com/logging/docs/view/advanced-filters), используемый для сопоставления записей журналов. Возвращается: успешно |
|
labelExtractors словарь |
Отображение из строки ключа метки до выражения извлекателя, которое используется для извлечения данных из поля записи журнала и назначения в качестве значения метки. Каждый ключ метки, указанный в LabelDescriptor, должен иметь связанное выражение извлекателя в этом отображении. Синтаксис выражения извлекателя такой же, как и для поля valueExtractor. Возвращается: успешно |
|
metricDescriptor complex |
Описание метрики, связанной с метрикой на основе журналов. Возвращается: успешно |
|
displayName строка |
Краткое имя метрики, которое можно отобразить в пользовательских интерфейсах. Используйте строчные буквы с большой первой буквой без точки в конце, например, «Количество запросов». Это поле необязательно, но рекомендуется для всех метрик, связанных с видимыми пользователю концепциями, такими как квота. Возвращается: успешно |
|
labels complex |
Набор меток, которые можно использовать для описания конкретного экземпляра этого типа метрики. Например, метка appengine.googleapis.com/http/server/response_latencies имеет метку HTTP-кода ответа response_code, поэтому можно просматривать задержки успешных ответов или только тех, которые завершились ошибкой. Возвращается: успешно |
|
описание строка |
Описание метки в читаемой для человека форме. Возвращено: успех |
|
ключ строка |
Ключ метки. Возвращено: успех |
|
типЗначения строка |
Тип данных, которые можно назначить метке. Возвращено: успех |
|
типМетрики строка |
Указывает, записываются ли в метрике мгновенные значения, изменения значения и т. д. Некоторые комбинации типМетрики и типЗначения могут быть не поддерживаемы. Для счётчиков установите значение DELTA. Возвращено: успех |
|
тип строка |
Тип метрики, включая её префикс имени DNS. Тип не кодируется в URL. Все пользовательские типы метрик имеют имя DNS `custom.googleapis.com` или `external.googleapis.com`. Возвращено: успех |
|
единица строка |
Единица измерения значения метрики. Применима только если типЗначения равен `INT64`, `DOUBLE` или `DISTRIBUTION`. Поддерживаемые единицы — подмножество стандарта [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html). Возвращено: успех |
|
типЗначения строка |
Тип измерения (целое число, число с плавающей запятой и т.д.). Некоторые комбинации типМетрики и типЗначения могут быть не поддерживаемы. Для счётчиков установите значение INT64. Возвращено: успех |
|
имя строка |
Присвоенный клиентом идентификатор метрики. Например, “error_count”, “nginx/requests”. Идентификаторы метрик ограничены 100 символами и могут содержать только следующие символы A-Z, a-z, 0-9 и специальные символы _-.,+!*’,()%/. Символ слэша (/) обозначает иерархию элементов имени, и он не может быть первым символом имени. Возвращено: успех |
|
извлечениеЗначения строка |
valueExtractor необходим при использовании метрики на основе логов распределения для извлечения записываемых значений из записи лога. Поддерживаются две функции для извлечения значений — EXTRACT(поле) или REGEXP_EXTRACT(поле, регулярное выражение). Аргументы: 1. поле — имя поля записи лога, из которого необходимо извлечь значение. 2. регулярное выражение — регулярное выражение с использованием синтаксиса Google RE2 (https://github.com/google/re2/wiki/Syntax) с одной группой захвата для извлечения данных из указанного поля записи лога. Значение поля преобразуется в строку перед применением регулярного выражения. Ошибка возникает при указании регулярного выражения, которое не включает ровно одну группу захвата. Возвращено: успех |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_logging_metric_info_module.html
