Spec-Zone.ru › AWS CLI v2

[ aws . logs ]

get-log-events

Описание

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

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

Частично заполненные или пустые страницы не обязательно означают завершение постраничной выгрузки. До тех пор, пока nextBackwardToken или nextForwardToken, возвращённые API, НЕ равны значению nextToken, переданному в вызов API, могут быть доступны дополнительные события журнала. Используемый токен зависит от направления перемещения по потоку журнала. Возвращаемые токены никогда не равны null.

Примечание

Если вы задали startFromHead в true и не включили endTime в свой запрос, может возникнуть ситуация, когда постраничная выгрузка не завершится. Это может произойти, когда новые события журнала добавляются в целевые потоки журналов быстрее, чем они считываются. Эта ситуация является хорошим примером для использования функции CloudWatch Logs Live Tail.

Если вы используете кросс-аккаунтовую наблюдаемость CloudWatch, вы можете использовать эту операцию в аккаунте мониторинга и просматривать данные из связанных исходных аккаунтов. Дополнительные сведения см. в разделе Кросс-аккаунтовая наблюдаемость CloudWatch.

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

Примечание

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

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

Синтаксис

  get-log-events
[--log-group-name <value>]
[--log-group-identifier <value>]
--log-stream-name <value>
[--start-time <value>]
[--end-time <value>]
[--next-token <value>]
[--limit <value>]
[--start-from-head | --no-start-from-head]
[--unmask | --no-unmask]
[--cli-input-json | --cli-input-yaml]
[--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-name (строка)

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

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

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

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

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

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

Токен для следующего набора элементов для возврата. (Этот токен вы получили из предыдущего вызова.)

--limit (целое число)

Максимальное количество событий журнала, возвращаемых операцией. Если вы не укажете лимит, по умолчанию возвращается столько событий журнала, сколько поместится в ответ размером 1 МБ (до 10 000 событий журнала).

--start-from-head | --no-start-from-head (булево)

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

Если вы используете предыдущее значение nextForwardToken в качестве значения nextToken в этой операции, вы должны указать true для параметра startFromHead.

--unmask | --no-unmask (булево)

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

Чтобы использовать эту операцию с этим параметром, вы должны быть авторизованы в аккаунте с правом logs:Unmask.

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

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

Используйте определенный профиль из вашего файла учетных данных.

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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 V1, а двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, во всех примерах используются правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Следующая команда извлекает события журнала из потока журнала с именем 20150601 в группе журналов my-logs:

aws logs get-log-events --log-group-name my-logs --log-stream-name 20150601

Вывод:

{
    "nextForwardToken": "f/31961209122447488583055879464742346735121166569214640130",
    "events": [
        {
            "ingestionTime": 1433190494190,
            "timestamp": 1433190184356,
            "message": "Example Event 1"
        },
        {
            "ingestionTime": 1433190516679,
            "timestamp": 1433190184356,
            "message": "Example Event 1"
        },
        {
            "ingestionTime": 1433190494190,
            "timestamp": 1433190184358,
            "message": "Example Event 2"
        }
    ],
    "nextBackwardToken": "b/31961209122358285602261756944988674324553373268216709120"
}

Вывод

events -> (список)

События.

(структура)

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

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

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

message -> (строка)

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

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

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

nextForwardToken -> (строка)

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

nextBackwardToken -> (строка)

Токен для следующего набора элементов в обратном направлении. Этот токен не равен null. Если достигнут конец потока, возвращается тот же токен, что и был передан.

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

Spec-Zone.ru

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