{"id":675,"date":"2017-07-26T12:22:56","date_gmt":"2017-07-26T12:22:56","guid":{"rendered":"http:\/\/www.scmgalaxy.com\/tutorials\/2017\/07\/26\/logging-in-chef-explained\/"},"modified":"2022-11-27T20:26:59","modified_gmt":"2022-11-27T20:26:59","slug":"logging-in-chef-explained","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/logging-in-chef-explained\/","title":{"rendered":"Chef Tutorials: Logging in Chef Explained"},"content":{"rendered":"

Chef Server<\/strong>
\nAll logs generated by the Chef server can be found in \/var\/log\/opscode. Each service enabled on the system also has a sub-directory in which service-specific logs are located, typically found in \/var\/log\/opscode\/service_name.<\/p>\n

The Chef server has built-in support for easily tailing the logs that are generated. To view all the logs being generated on the Chef server, enter the following command:
\n> chef-server-ctl tail<\/p>\n

To view logs for a specific service:<\/strong>
\n> chef-server-ctl tail SERVICENAME
\nwhere SERVICENAME should be replaced with name of the service for which log files will be viewed. SERVICENAME represents the name of any service that is listed after running the “> chef-server-ctl service-list” subcommand.<\/p>\n

Another way to view log files is to use the system utility tail:<\/strong>
\n> tail -50f \/var\/log\/chef-server\/opscode-chef\/current
\n> tail -50f \/var\/log\/opscode\/opscode-chef\/current<\/p>\n

Supervisor Logs<\/strong>
\nSupervisor logs are created and managed directly by the service supervisor, and are automatically rotated when a the current log file reaches 1,000,000 bytes. 10 log files are kept. The latest supervisor log is always located in \/var\/log\/chef-server\/service_name\/current and rotated logs have a filename starting with @ followed by a precise tai64n timestamp based on when the file was rotated.<\/p>\n

Supervisor logs are available for the following services:<\/p>\n

    \n
  1. bifrost<\/li>\n
  2. bookshelf<\/li>\n
  3. nginx<\/li>\n
  4. opscode-erchef<\/li>\n
  5. opscode-expander<\/li>\n
  6. opscode-expander-reindexer<\/li>\n
  7. opscode-solr4<\/li>\n
  8. postgresql<\/li>\n
  9. rabbitmq<\/li>\n
  10. redis<\/li>\n<\/ol>\n

    nginx<\/h3>\n

    The nginx service creates both supervisor and administrator logs. The administrator logs contain both access and error logs for each virtual host utilized by the Chef server. Each of the following logs require external log rotation.<\/p>\n\n\n\n<\/colgroup>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Logs<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    \/var\/log\/opscode\/nginx\/access.log<\/td>\nThe Web UI and API HTTP access logs.<\/td>\n<\/tr>\n
    \/var\/log\/opscode\/nginx\/error.log<\/td>\nThe Web UI and API HTTP error logs.<\/td>\n<\/tr>\n
    \/var\/log\/opscode\/nginx\/internal-account.access.log<\/td>\nThe opscode-account internal load-balancer access logs.<\/td>\n<\/tr>\n
    \/var\/log\/opscode\/nginx\/internal-account.error.log<\/td>\nThe opscode-account internal load-balancer error logs.<\/td>\n<\/tr>\n
    \/var\/log\/opscode\/nginx\/internal-authz.access.log<\/td>\nThe opscode-authz internal load-balancer access logs.<\/td>\n<\/tr>\n
    \/var\/log\/opscode\/nginx\/internal-authz.error.log<\/td>\nThe opscode-authz internal load-balancer error logs.<\/td>\n<\/tr>\n
    \/var\/log\/opscode\/nginx\/internal-chef.access.log<\/td>\nThe opscode-chef and opscode-erchef internal load-balancer access logs.<\/td>\n<\/tr>\n
    \/var\/log\/opscode\/nginx\/internal-chef.error.log<\/td>\nThe opscode-chef and opscode-erchef internal load-balancer error logs.<\/td>\n<\/tr>\n
    \/var\/log\/opscode\/nginx\/nagios.access.log<\/td>\nThe nagios access logs.<\/td>\n<\/tr>\n
    \/var\/log\/opscode\/nginx\/nagios.error.log<\/td>\nThe nagios error logs.<\/td>\n<\/tr>\n
    \/var\/log\/opscode\/nginx\/rewrite-port-80.log<\/td>\nThe rewrite logs for traffic that uses HTTP instead of HTTPS.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    To follow the logs for the service:<\/p>\n

    \n
    \n
     $ chef-server-ctl tail nginx<\/pre>\n<\/div>\n<\/div>\n
    Chef Client<\/strong><\/p>\n
    Client.rb3 file might help you. Default value of log_location is STDOUT. You can give \/path\/to\/log_location in place of this. You can locate this client.rb file in C:\\chef\\client.rb or \/etc\/chef\/client.rb directories.<\/p>\n
    Use the verbose logging that is built into the chef-client:
    \n-l LEVEL, –log_level LEVEL
    \nThe level of logging to be stored in a log file.
    \n-L LOGLOCATION, –logfile c
    \nThe location of the log file. This is recommended when starting any executable as a daemon. Default value: STDOUT.<\/p>\n
    Knife<\/strong>
    \nUse the verbose logging that is built into knife:
    \n-V, –verbose
    \nSet for more verbose outputs. Use -VV for maximum verbosity.<\/p>\n
    chef-solo<\/strong>
    \n-l LEVEL, –log_level LEVEL
    \nThe level of logging to be stored in a log file.<\/p>\n
    The Chef file and folder locations are different on Linux and Windows machines. This article explains the purpose of each file and the location.<\/p>\n
    Summary<\/h4>\n\n\n\n\n\n\n\n\n\n\n
    <\/th>\nLinux<\/th>\nWindows<\/th>\n<\/tr>\n
    Cookbook location<\/td>\n\/var\/chef\/cache\/cookbooks<\/td>\n C:\\chef\\cache\\cookbooks<\/td>\n<\/tr>\n
    Chef Client run log<\/td>\n\/var\/log\/chef.log<\/td>\nFirst run only
    \nC:\\chef\\chef-client.log<\/td>\n<\/tr>\n
    <\/td>\n<\/td>\nSubsequent Chef client runs
    \nC:\\chef\\log\\client.log<\/td>\n<\/tr>\n
    Error log<\/td>\n\/var\/chef\/cache\/chef-stacktrace.out<\/td>\nC:\\chef\\cache\\chef-stacktrace.out<\/td>\n<\/tr>\n
    Ohai output<\/td>\n\/var\/chef\/cache\/failed-run-data.json<\/td>\nC:\\chef\\cache\\failed-run-data.json<\/td>\n<\/tr>\n
    Recommended location for custom log files<\/td>\n\/tmp\/cheflog.log<\/td>\nC:\\Logs\\Chef\\cheflog.log<\/td>\n<\/tr>\n
    Chef Client configuration<\/td>\n\/etc\/chef\/client.rb<\/td>\nC:\\chef\\client.rb<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    When you test your cookbook in Test Kitchen<\/h4>\n
    The .kitchen.yml file contains the username to execute the Chef cookbook. It is specified under platforms<\/strong>:, transport<\/strong>:, username<\/strong>:<\/p>\n
    Use that value in place of USER-NAME-FROM-KITCHEN-YML<\/strong> below.<\/p>\n\n\n\n\n\n\n\n
    <\/th>\nLinux<\/th>\nWindows<\/th>\n<\/tr>\n
    Cookbook location<\/td>\n\/tmp\/kitchen\/cookbooks
    \n\/tmp\/kitchen\/cache\/cookbooks<\/td>\n    		 C:\\Users\\USER-NAME-FROM-KITCHEN-YML\\AppData\\Local\\Temp\\kitchen\\cookbooks<\/td>\n<\/tr>\n
    Error log<\/td>\n\/tmp\/kitchen\/cache\/chef-stacktrace.out<\/td>\nC:\\Users\\USER-NAME-FROM-KITCHEN-YML\\AppData\\Local\\Temp\\kitchen\\cache\\chef-stacktrace.out<\/td>\n<\/tr>\n
    Ohai output<\/td>\n\/tmp\/kitchen\/cache\/failed-run-data.json<\/td>\nC:\\Users\\USER-NAME-FROM-KITCHEN-YML\\AppData\\Local\\Temp\\kitchen\\cache\\failed-run-data.json<\/td>\n<\/tr>\n
    Data bags<\/td>\n\/tmp\/kitchen\/data_bags<\/td>\nC:\\Users\\USER-NAME-FROM-KITCHEN-YML\\AppData\\Local\\Temp\\kitchen\\data_bags<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Cookbook location <\/strong><\/p>\n
    When the Chef recipes are executed, all cookbooks are stored on the node. You can examine the code to make sure your latest changes are reflected on the machine.<\/p>\n
    The log of the Chef client run<\/strong><\/p>\n
    The output of the Chef cookbook execution is in the chef.log or chef-client.log file<\/p>\n
    On Windows<\/strong><\/p>\n
    The log of the first Chef Client run and subsequent runs are stored in different log files.<\/strong> After the initial Chef Client run, the rest of the log entries are collected in the second file.<\/p>\n
    Stacktrace<\/strong><\/p>\n
    Chef saves information on the hard drive when scripts are executed. If there is a failure, the stack trace of the last error is saved in the chef-stacktrace.out<\/strong> file.<\/p>\n
    Ohai output<\/strong><\/p>\n
    All the information that Ohai collects on the instance, is saved in the failed-run-data.json<\/strong>file, even if there is no error. It is a great resource to get the server specific values.<\/p>\n
    Reference<\/strong><\/p>\n
    https:\/\/docs.chef.io\/server_logs.html<\/a>
    \n    https:\/\/docs.chef.io\/debug.html<\/a><\/p>\n\n