Ресурс log

Редактировать эту страницу в репозитории Chef

Страница всех ресурсов Infra

Синтаксис

Блок ресурса log добавляет сообщения в файл журнала на основе событий, происходящих во время выполнения Chef Infra Client:

log 'message' do
  message 'A message add to the log.'
  level :info
end

Полный синтаксис всех свойств, доступных для ресурса log, выглядит так:

log 'name' do
  level        Symbol # default value: :info
  message      String # default value: 'name' unless specified
  action       Symbol # defaults to :write if not specified
end

где:

• log — это ресурс.
• name — имя, заданное для блока ресурса.
• action определяет шаги, которые Chef Infra Client предпримет для приведения узла в нужное состояние.
• level и message — доступные для этого ресурса свойства.

Свойства

Ресурс log имеет следующие свойства:

level

Тип в Ruby: Символ | Значение по умолчанию: :info

Уровень ведения журнала для отображения этого сообщения. Доступные варианты (в порядке приоритета): :debug, :info, :warn, :error, и :fatal.

message

Тип в Ruby: Строка | Значение по умолчанию: The resource block's name

Сообщение, которое будет добавлено в файл журнала. Значение по умолчанию: name блока ресурса. См. раздел «Синтаксис» выше для получения дополнительной информации.

Записи журнала

Chef::Log будет выводить записи журнала в стандартный логгер, настроенный для машины, на которой запущен Chef Infra Client. (Чтобы создать запись журнала, встроенную в набор ресурсов, используйте ресурс log, а не Chef::Log.)

Поддерживаемые уровни ведения журнала

Следующий пример демонстрирует серию записей журнала уровня критический Chef::Log:

unless node['splunk']['upgrade_enabled']
  Chef::Log.fatal('The chef-splunk::upgrade recipe was added to the node,')
  Chef::Log.fatal('but the attribute `node["splunk"]["upgrade_enabled"]` was not set.')
  Chef::Log.fatal('I am bailing here so this node does not upgrade.')
  raise
end

service 'splunk_stop' do
  service_name 'splunk'
  supports status: true
  action :stop
end

if node['splunk']['is_server']
  splunk_package = 'splunk'
  url_type = 'server'
else
  splunk_package = 'splunkforwarder'
  url_type = 'forwarder'
end

splunk_installer splunk_package do
  url node['splunk']['upgrade']["#{url_type}_url"]
end

if node['splunk']['accept_license']
  execute 'splunk-unattended-upgrade' do
    command "#{splunk_cmd} start --accept-license --answer-yes"
  end
else
  Chef::Log.fatal('You did not accept the license (set node["splunk"]["accept_license"] to true)')
  Chef::Log.fatal('Splunk is stopped and cannot be restarted until the license is accepted!')
  raise
end

Следующий пример демонстрирует использование нескольких типов записей журнала Chef::Log:

...

begin
  aws = Chef::DataBagItem.load(:aws, :main)
  Chef::Log.info("Loaded AWS information from DataBagItem aws[#{aws['id']}]")
rescue
  Chef::Log.fatal("Could not find the 'main' item in the 'aws' data bag")
  raise
end

...

Общие возможности ресурса

Ресурсы Chef включают общие свойства, уведомления и блокирующие ресурсы.

Общие свойства

Следующие свойства являются общими для всех ресурсов:

compile_time

Тип в Ruby: true, false | Значение по умолчанию: false

Управление фазой, в которой ресурс выполняется на узле. Установите в true, чтобы запустить во время построения набора ресурсов (compile phase). Установите в false, чтобы запустить во время настройки узла Chef Infra Client (converge phase).

ignore_failure

Тип в Ruby: true, false, :quiet | Значение по умолчанию: false

Продолжить выполнение рецепта, если ресурс завершился ошибкой по любой причине. :quiet не будет отображать полную трассировку стека, и рецепт продолжит выполнение, если ресурс завершился ошибкой.

retries

Тип в Ruby: Целое число | Значение по умолчанию: 0

Количество попыток перехватить исключения и повторить ресурс.

retry_delay

Тип в Ruby: Целое число | Значение по умолчанию: 2

Задержка в секундах между попытками повтора.

sensitive

Тип в Ruby: true, false | Значение по умолчанию: false

Обеспечить, чтобы конфиденциальные данные ресурса не регистрировались Chef Infra Client.

Уведомления

notifies

Тип в Ruby: Символ, 'Chef::Resource[Строка]'

Ресурс может уведомить другой ресурс о выполнении действия при изменении его состояния. Укажите 'resource[name]', :action действия, которое должен выполнить ресурс, и :timer этого действия. Ресурс может уведомлять несколько ресурсов; используйте оператор notifies для каждого ресурса, который нужно уведомить.

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

Таймер указывает момент во время выполнения Chef Infra Client, когда выполняется уведомление. Доступны следующие таймеры:

:before

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

:delayed

По умолчанию. Указывает, что уведомление должно быть помещено в очередь и выполнено в конце выполнения Chef Infra Client.

:immediate, :immediately

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

Синтаксис для notifies:

notifies :action, 'resource[name]', :timer

subscribes

Тип в Ruby: Символ, 'Chef::Resource[Строка]'

Ресурс может следить за другим ресурсом и выполнять действие, если состояние отслеживаемого ресурса изменится. Укажите 'resource[name]', :action действия и :timer этого действия.

Обратите внимание, что subscribes не применяет указанное действие к ресурсу, за которым он следит — например:

file '/etc/nginx/ssl/example.crt' do
  mode '0600'
  owner 'root'
end

service 'nginx' do
  subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
end

В этом случае свойство subscribes перезагружает службу nginx всякий раз, когда файл сертификата, расположенный в /etc/nginx/ssl/example.crt, обновляется. subscribes не вносит никаких изменений в сам файл сертификата, он просто отслеживает изменения в файле и выполняет действие :reload для своего ресурса (в данном примере nginx) при обнаружении изменений.

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

Таймер указывает момент во время выполнения Chef Infra Client, когда выполняется уведомление. Доступны следующие таймеры:

:before

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

:delayed

По умолчанию. Указывает, что уведомление должно быть помещено в очередь и выполнено в конце выполнения Chef Infra Client.

:immediate, :immediately

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

Синтаксис для subscribes:

subscribes :action, 'resource[name]', :timer

Блокирующие ресурсы

Свойство guard можно использовать для оценки состояния узла во время фазы выполнения Chef Infra Client. На основе результатов этой оценки свойство guard сообщает Chef Infra Client, следует ли продолжить выполнение ресурса. Свойство guard принимает либо строковое значение, либо значение блока Ruby:

• Строка выполняется как командная оболочка. Если команда возвращает 0, guard применяется. Если команда возвращает любое другое значение, свойство guard не применяется. Строковые guard в powershell_script выполняют команды Windows PowerShell и могут возвращать true в дополнение к 0.
• Блок выполняется как код Ruby, который должен возвращать либо true , либо false. Если блок возвращает true, свойство guard применяется. Если блок возвращает false, свойство guard не применяется.

Свойство guard полезно для обеспечения идемпотентности ресурса, позволяя этому ресурсу проверить желаемое состояние во время его выполнения, а затем, если желаемое состояние присутствует, не выполнять никаких действий Chef Infra Client.

Следующие свойства могут быть использованы для определения guard, оцениваемого во время фазы выполнения Chef Infra Client:

not_if

Предотвратить выполнение ресурса, когда условие возвращает true.

only_if

Разрешить выполнение ресурса только в том случае, если условие возвращает true.

Примеры

Следующие примеры демонстрируют различные подходы к использованию ресурса log в рецептах:

Установить уровень ведения журнала по умолчанию

log 'a string to log'

Установить уровень ведения журнала отладки

log 'a debug string' do
  level :debug
end

Добавить сообщение в файл журнала

log 'message' do
  message 'This is the message that will be added to the log.'
  level :info
end