Spec-Zone.ru › AWS CLI v2

[ aws . журналы ]

filter-log-events

Описание

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

  • Шаблон фильтра
  • Диапазон времени
  • Имя потока журнала или префикс имени потока журнала, соответствующий нескольким потокам журналов

Для выполнения этой операции требуется разрешение logs:FilterLogEvents.

Вы можете указать группу журналов для поиска, используя либо logGroupIdentifier, либо logGroupName. Вы должны указать один из этих двух параметров, но не оба.

FilterLogEvents — это страничная операция. Каждая возвращённая страница может содержать до 1 МБ событий журнала или до 10 000 событий журнала. Возвращённая страница может быть только частично заполненной или даже пустой. Например, если результат запроса вернёт 15 000 событий журнала, первая страница не гарантированно будет содержать 10 000 событий журнала, даже если все они поместятся в 1 МБ.

Частично заполненные или пустые страницы не обязательно означают завершение постраничной обработки. Если результаты включают nextToken, могут быть доступны дополнительные события журнала. Вы можете вернуть эти дополнительные события журнала, предоставив nextToken в последующей операции FilterLogEvents. Если результаты не включают nextToken, значит, постраничная обработка завершена.

Указание параметра limit гарантирует только, что на одной странице не возвращается больше событий журнала, чем указанный лимит, но на ней может быть меньше событий, чем лимит. Это ожидаемое поведение API.

Возвращаемые события журнала отсортированы по метке времени события, времени, когда событие было обработано CloudWatch Logs, и идентификатору запроса PutLogEvents.

Если вы используете CloudWatch cross-account observability, вы можете использовать эту операцию в учётной записи мониторинга и просматривать данные из связанных учётных записей источника. Дополнительная информация приведена в разделе CloudWatch cross-account observability.

Примечание

Если вы используете преобразование журналов, операция FilterLogEvents возвращает только исходные версии событий журналов, до их преобразования. Чтобы просмотреть преобразованные версии, вы должны использовать запрос CloudWatch Logs.

См. также: Документация AWS API

filter-log-events — это страничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную обработку, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничную обработку аргумент --query должен извлекать данные из результатов следующих выражений запроса: events, searchedLogStreams

Синопсис

  filter-log-events
[--log-group-name <value>]
[--log-group-identifier <value>]
[--log-stream-names <value>]
[--log-stream-name-prefix <value>]
[--start-time <value>]
[--end-time <value>]
[--filter-pattern <value>]
[--interleaved | --no-interleaved]
[--unmask | --no-unmask]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--log-group-name (строка)

Имя группы журналов для поиска.

Примечание

Вы должны указать либо logGroupIdentifier, либо logGroupName, но не оба.

--log-group-identifier (строка)

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

Примечание

Вы должны указать либо logGroupIdentifier, либо logGroupName, но не оба.

--log-stream-names (список)

Фильтрует результаты, чтобы отобразить только журналы из этого списка потоков журналов.

Если вы укажете значение для обоих параметров logStreamNames и logStreamNamePrefix, действие вернёт ошибку InvalidParameterException.

(строка)

Синтаксис:

"string" "string" ...

--log-stream-name-prefix (строка)

Фильтрует результаты, чтобы включать только события из потоков журналов, имена которых начинаются с этого префикса.

Если вы укажете значение для обоих параметров logStreamNamePrefix и logStreamNames, действие вернёт ошибку InvalidParameterException.

--start-time (целое число)

Начало диапазона времени, выраженное в миллисекундах после Jan 1, 1970 00:00:00 UTC. События с отметкой времени до этого момента не возвращаются.

--end-time (целое число)

Конец диапазона времени, выраженный в миллисекундах после Jan 1, 1970 00:00:00 UTC. События с отметкой времени позже этого момента не возвращаются.

--filter-pattern (строка)

Шаблон фильтра. Дополнительная информация приведена в разделе Фильтр и синтаксис шаблона.

Если не указано, все события соответствуют.

--interleaved | --no-interleaved (логическое значение)

Если значение равно true, операция пытается предоставить ответы, содержащие события из нескольких потоков журналов в группе журналов, чередуя их в одном ответе. Если значение равно false, сначала ищутся все соответствующие события журнала в первом потоке журнала, затем — во втором и так далее.

Важно Начиная с 17 июня 2019 года, этот параметр игнорируется, и предполагается значение true. Ответ на эту операцию всегда чередует события из нескольких потоков журналов в группе журналов.

--unmask | --no-unmask (логическое значение)

Укажите true, чтобы отобразить поля событий журнала со всеми конфиденциальными данными, не замаскированными и видимыми. По умолчанию — false.

Для использования этой операции с этим параметром вы должны быть авторизованы в учётной записи с правом доступа logs:Unmask.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределяют значения, предоставленные через JSON. Невозможно передать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания начала постраничной обработки. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые должны быть возвращены в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Чтобы возобновить постраничную обработку, укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение по умолчанию или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, оно выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверит входные данные команды и вернёт пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладочную регистрацию.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную обработку. Если автоматическая постраничная обработка отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла аутентификации.

--region (строка)

Использовать указанный регион. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • включить
  • выключить
  • автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл с набором сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время соединения сокета в секундах. Если значение установлено в 0, соединение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить страницу cli для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы ввода CLI параметров.

Вывод

events -> (список)

Соответствующие события.

(структура)

Представляет сопоставленное событие.

logStreamName -> (строка)

Имя потока журнала, к которому принадлежит это событие.

timestamp -> (целое число)

Время наступления события, выраженное в миллисекундах после Jan 1, 1970 00:00:00 UTC .

message -> (строка)

Данные, содержащиеся в событии журнала.

ingestionTime -> (целое число)

Время поступления события, выраженное в миллисекундах после Jan 1, 1970 00:00:00 UTC .

eventId -> (строка)

Идентификатор события.

searchedLogStreams -> (список)

Важно По состоянию на 15 мая 2020 г. этот параметр больше не поддерживается. Этот параметр возвращает пустой список.

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

(структура)

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

logStreamName -> (строка)

Имя потока журнала.

searchedCompletely -> (логическое значение)

Указывает, были ли просмотрены все события в этом потоке журнала.

nextToken -> (строка)

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

Если результаты не содержат nextToken , то постраничная навигация завершена.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API