Spec-Zone.ru › AWS CLI v2

[ aws . logs ]

test-трансформер

Описание

Используйте эту операцию для проверки лог-трансформера. Вы вводите конфигурацию трансформера и набор событий логов для проверки. Операция отвечает массивом, который включает исходные события логов и преобразованные версии.

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

Синтаксис

  test-transformer
--transformer-config <value>
--log-event-messages <value>
[--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]

Параметры

--transformer-config (список)

Эта структура содержит конфигурацию данного лог-трансформера, которую вы хотите проверить. Лог-трансформер — это массив процессоров, где каждый процессор применяет один тип преобразования к событиям логов, которые поступают на вход.

(структура)

Эта структура содержит информацию об одном процессоре в преобразователе логов.

addKeys -> (структура)

Используйте этот параметр, чтобы включить процессор addKeys в ваш преобразователь.

entries -> (список)

Массив объектов, где каждый объект содержит информацию об одном ключе, который нужно добавить в событие лога.

(структура)

Этот объект определяет один ключ, который будет добавлен процессором addKeys.

key -> (строка)

Ключ новой записи, которая будет добавлена в событие лога

value -> (строка)

Значение новой записи, которая будет добавлена в событие лога

overwriteIfExists -> (булево)

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

copyValue -> (структура)

Используйте этот параметр, чтобы включить процессор copyValue в ваш преобразователь.

entries -> (список)

Массив CopyValueEntry объектов, где каждый объект содержит информацию об одном значении поля для копирования.

(структура)

Этот объект определяет одно значение, которое будет скопировано процессором copyValue.

source -> (строка)

Ключ для копирования.

target -> (строка)

Ключ поля, в которое будет скопировано значение.

overwriteIfExists -> (булево)

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

csv -> (структура)

Используйте этот параметр, чтобы включить процессор CSV в ваш преобразователь.

quoteCharacter -> (строка)

Символ, используемый в качестве квалификатора текста для отдельного столбца данных. Если вы опустите этот параметр, будет использоваться двойная кавычка ".

delimiter -> (строка)

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

columns -> (список)

Массив имён для использования в столбцах преобразованного события лога.

Если вы опустите этот параметр, будут использоваться значения по умолчанию [column_1, column_2 ...].

(строка)

source -> (строка)

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

dateTimeConverter -> (структура)

Используйте этот параметр, чтобы включить процессор datetimeConverter в ваш преобразователь.

source -> (строка)

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

target -> (строка)

Поле JSON для хранения результата.

targetFormat -> (строка)

Формат даты и времени для преобразованных данных в целевом поле.

Если вы опустите этот параметр, будет использоваться значение по умолчанию yyyy-MM-dd'T'HH:mm:ss.SSS'Z.

matchPatterns -> (список)

Список шаблонов для сопоставления с source полем.

(строка)

sourceTimezone -> (строка)

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

targetTimezone -> (строка)

Временная зона целевого поля. Если вы опустите этот параметр, по умолчанию будет использоваться зона UTC.

locale -> (строка)

Локаль исходного поля. Если вы опустите этот параметр, будет использоваться значение по умолчанию locale.ROOT.

deleteKeys -> (структура)

Используйте этот параметр, чтобы включить процессор deleteKeys в ваш преобразователь.

withKeys -> (список)

Список ключей для удаления.

(строка)

grok -> (структура)

Используйте этот параметр, чтобы включить процессор grok в ваш преобразователь.

source -> (строка)

Путь к полю в событии лога, которое нужно разобрать. Если вы опустите это значение, будет разобранно всё сообщение лога.

match -> (строка)

Шаблон grok для сопоставления с событием лога. Список поддерживаемых шаблонов grok см. в разделе Поддерживаемые шаблоны grok.

listToMap -> (структура)

Используйте этот параметр, чтобы включить процессор listToMap в ваш преобразователь.

source -> (строка)

Ключ в событии лога, содержащий список объектов, которые будут преобразованы в карту.

key -> (строка)

Ключ поля, который будет извлечён как ключи в сгенерированной карте

valueKey -> (строка)

Если это указано, значения, указанные в этом параметре, будут извлечены из source объектов и помещены в значения сгенерированной карты. В противном случае исходные объекты в списке source будут помещены в значения сгенерированной карты.

target -> (строка)

Ключ поля, которое будет содержать сгенерированную карту

flatten -> (булево)

Булево значение, указывающее, будет ли список сжат в отдельные элементы. Укажите true для сжатия списка. По умолчанию false

flattenedElement -> (строка)

Если вы установите flatten в true, используйте flattenedElement для указания элемента, first или last, который нужно сохранить.

Вы должны указать этот параметр, если flatten равно true

lowerCaseString -> (структура)

Используйте этот параметр, чтобы включить процессор lowerCaseString в ваш преобразователь.

withKeys -> (список)

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

(строка)

moveKeys -> (структура)

Используйте этот параметр, чтобы включить процессор moveKeys в ваш преобразователь.

entries -> (список)

Массив объектов, где каждый объект содержит информацию об одном ключе для перемещения.

(структура)

Этот объект определяет один ключ, который будет перемещен процессором moveKey.

source -> (строка)

Ключ для перемещения.

target -> (строка)

Ключ для перемещения к.

overwriteIfExists -> (булево)

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

parseCloudfront -> (структура)

Используйте этот параметр, чтобы включить процессор parseCloudfront в ваш преобразователь.

Если вы используете этот процессор, он должен быть первым процессором в вашем преобразователе.

source -> (строка)

Оставьте этот параметр пустым, и всё сообщение лога будет обработано этим процессором. Другие значения, кроме @message, для source недопустимы.

parseJSON -> (структура)

Используйте этот параметр, чтобы включить процессор parseJSON в ваш преобразователь.

source -> (строка)

Путь к полю в событии лога, которое будет обработано. Используйте нотацию с точками для доступа к дочерним полям. Например, store.book

destination -> (строка)

Место для размещения пар ключ-значение, полученных после разбора. Если вы опустите этот параметр, они будут размещены в корневом узле.

parseKeyValue -> (структура)

Используйте этот параметр, чтобы включить процессор parseKeyValue в ваш преобразователь.

source -> (строка)

Путь к полю в событии лога, которое будет обработано. Используйте нотацию с точками для доступа к дочерним полям. Например, store.book

destination -> (строка)

Целевое поле для размещения извлечённых пар ключ-значение

fieldDelimiter -> (строка)

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

keyValueDelimiter -> (строка)

Строка разделитель для ключа и значения в каждой паре преобразованного события лога.

Если вы опустите этот параметр, будет использоваться знак равенства =.

keyPrefix -> (строка)

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

nonMatchValue -> (строка)

Значение, которое нужно вставить в поле значения результата, когда пара ключ-значение не была успешно разделена.

overwriteIfExists -> (булево)

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

parseRoute53 -> (структура)

Используйте этот параметр, чтобы включить процессор parseRoute53 в ваш преобразователь.

Если вы используете этот процессор, он должен быть первым процессором в вашем преобразователе.

source -> (строка)

Оставьте этот параметр пустым, и всё сообщение лога будет обработано этим процессором. Другие значения, кроме @message, для source недопустимы.

parsePostgres -> (структура)

Используйте этот параметр, чтобы включить процессор parsePostGres в ваш преобразователь.

Если вы используете этот процессор, он должен быть первым процессором в вашем преобразователе.

source -> (строка)

Оставьте этот параметр пустым, и всё сообщение лога будет обработано этим процессором. Другие значения, кроме @message, для source недопустимы.

parseVPC -> (структура)

Используйте этот параметр, чтобы включить процессор parseVPC в ваш преобразователь.

Если вы используете этот процессор, он должен быть первым процессором в вашем преобразователе.

source -> (строка)

Оставьте этот параметр пустым, и всё сообщение лога будет обработано этим процессором. Другие значения, кроме @message, для source недопустимы.

parseWAF -> (структура)

Используйте этот параметр, чтобы включить процессор parseWAF в ваш преобразователь.

Если вы используете этот процессор, он должен быть первым процессором в вашем преобразователе.

source -> (строка)

Оставьте этот параметр пустым, и всё сообщение лога будет обработано этим процессором. Другие значения, кроме @message, для source недопустимы.

renameKeys -> (структура)

Используйте этот параметр, чтобы включить процессор renameKeys в ваш преобразователь.

entries -> (список)

Массив RenameKeyEntry объектов, где каждый объект содержит информацию об одном ключе для переименования.

(структура)

Этот объект определяет один ключ, который будет переименован процессором renameKey.

key -> (строка)

Ключ для переименования

renameTo -> (строка)

Строка для нового имени ключа

overwriteIfExists -> (булево)

Указывает, нужно ли перезаписывать существующее значение, если целевой ключ уже существует. По умолчанию false

splitString -> (структура)

Используйте этот параметр, чтобы включить процессор splitString в ваш преобразователь.

entries -> (список)

Массив SplitStringEntry объектов, где каждый объект содержит информацию об одном поле для разделения.

(структура)

Этот объект определяет одно поле лога, которое будет разделено процессором splitString.

source -> (строка)

Ключ поля для разделения.

delimiter -> (строка)

Символы разделителя для разделения строки записи.

substituteString -> (структура)

Используйте этот параметр для включения процессора substituteString в ваш трансформер.

entries -> (список)

Массив объектов, где каждый объект содержит информацию об одном ключе для сопоставления и замены.

(структура)

Этот объект определяет один ключ поля лога, который будет заменён с помощью процессора substituteString.

source -> (строка)

Ключ для изменения

from -> (строка)

Строка регулярного выражения, подлежащая замене. Специальные символы регулярных выражений, такие как [ и ], необходимо экранировать с помощью \ при использовании двойных кавычек и с помощью \ при использовании одинарных кавычек. Для получения дополнительной информации см. раздел Class Pattern на веб-сайте Oracle.

to -> (строка)

Строка, которая будет заменена на каждую совпавшую подстроку.

trimString -> (структура)

Используйте этот параметр для включения процессора trimString в ваш трансформер.

withKeys -> (список)

Массив, содержащий ключи полей для обрезки.

(строка)

typeConverter -> (структура)

Используйте этот параметр для включения процессора typeConverter в ваш трансформер.

entries -> (список)

Массив объектов, где каждый объект содержит информацию об одном поле, тип которого необходимо изменить.

(структура)

Этот объект определяет один тип значения, который будет преобразован с помощью процессора typeConverter.

key -> (строка)

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

type -> (строка)

Тип, в который нужно преобразовать значение поля. Допустимые значения: integer , double , string и boolean .

upperCaseString -> (структура)

Используйте этот параметр для включения процессора upperCaseString в ваш трансформер.

withKeys -> (список)

Массив, содержащий ключи поля, которое нужно преобразовать в верхний регистр.

(строка)

Синтаксис JSON:

[
  {
    "addKeys": {
      "entries": [
        {
          "key": "string",
          "value": "string",
          "overwriteIfExists": true|false
        }
        ...
      ]
    },
    "copyValue": {
      "entries": [
        {
          "source": "string",
          "target": "string",
          "overwriteIfExists": true|false
        }
        ...
      ]
    },
    "csv": {
      "quoteCharacter": "string",
      "delimiter": "string",
      "columns": ["string", ...],
      "source": "string"
    },
    "dateTimeConverter": {
      "source": "string",
      "target": "string",
      "targetFormat": "string",
      "matchPatterns": ["string", ...],
      "sourceTimezone": "string",
      "targetTimezone": "string",
      "locale": "string"
    },
    "deleteKeys": {
      "withKeys": ["string", ...]
    },
    "grok": {
      "source": "string",
      "match": "string"
    },
    "listToMap": {
      "source": "string",
      "key": "string",
      "valueKey": "string",
      "target": "string",
      "flatten": true|false,
      "flattenedElement": "first"|"last"
    },
    "lowerCaseString": {
      "withKeys": ["string", ...]
    },
    "moveKeys": {
      "entries": [
        {
          "source": "string",
          "target": "string",
          "overwriteIfExists": true|false
        }
        ...
      ]
    },
    "parseCloudfront": {
      "source": "string"
    },
    "parseJSON": {
      "source": "string",
      "destination": "string"
    },
    "parseKeyValue": {
      "source": "string",
      "destination": "string",
      "fieldDelimiter": "string",
      "keyValueDelimiter": "string",
      "keyPrefix": "string",
      "nonMatchValue": "string",
      "overwriteIfExists": true|false
    },
    "parseRoute53": {
      "source": "string"
    },
    "parsePostgres": {
      "source": "string"
    },
    "parseVPC": {
      "source": "string"
    },
    "parseWAF": {
      "source": "string"
    },
    "renameKeys": {
      "entries": [
        {
          "key": "string",
          "renameTo": "string",
          "overwriteIfExists": true|false
        }
        ...
      ]
    },
    "splitString": {
      "entries": [
        {
          "source": "string",
          "delimiter": "string"
        }
        ...
      ]
    },
    "substituteString": {
      "entries": [
        {
          "source": "string",
          "from": "string",
          "to": "string"
        }
        ...
      ]
    },
    "trimString": {
      "withKeys": ["string", ...]
    },
    "typeConverter": {
      "entries": [
        {
          "key": "string",
          "type": "boolean"|"integer"|"double"|"string"
        }
        ...
      ]
    },
    "upperCaseString": {
      "withKeys": ["string", ...]
    }
  }
  ...
]

--log-event-messages (список)

Массив исходных событий лога, которые вы хотите использовать для тестирования этого трансформера.

(строка)

Синтаксис:

"string" "string" ...

--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
  • текст
  • таблица
  • 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-auto-prompt (логическое значение)

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

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

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

Вывод

transformedLogs -> (список)

Массив, где каждый элемент массива включает как исходную версию, так и преобразованную версию одного из событий лога, которые вы ввели.

(структура)

Эта структура содержит информацию об одном событии лога, которое было обработано трансформером лога.

eventNumber -> (длинное целое число)

Номер события.

eventMessage -> (строка)

Сообщение исходного события лога до преобразования.

transformedEventMessage -> (строка)

Сообщение события лога после преобразования.

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

Spec-Zone.ru

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