The Puppet Labs Issue Tracker has Moved: https://tickets.puppetlabs.com

« Previous - Version 12/15 (diff) - Next » - Current version
Matt Robinson, 01/06/2011 09:48 pm


Report Format 2

This is the format of reports that is output by Puppet version 2.6.5.

The Puppet::Transaction::Report contains the following attributes:

nametypedescription
hoststringthe host that generated this report.
timedatetimewhen the run completed.
logsarray0 or more Puppet::Util::Log objects.
metricshashmaps from string (metric category) to Puppet::Util::Metric.
resource_statuseshashmaps from resource name to Puppet::Resource::Status
configuration_versionstring or integerThe "configuration version" of the puppet run. This is a string if the user has specified their own versioning scheme, otherwise an integer representing seconds since the epoch.
report_formatinteger2
puppet_versionstringThe version of the Puppet agent.
kindstring"inspect" if this report came from a "puppet inspect" run, "apply" if it came from a "puppet apply" or "puppet agent" run.
statusstring"failed", "changed", or "unchanged"

A Puppet::Util::Log object contains the following attributes:

nametypedescription
filestringthe pathname of the manifest file which triggered the log message.
lineintegerthe line number in the manifest file which triggered the log message.
levelsymbolseverity of the message. Possible values for level are :debug, :info, :notice, :warning, :err, :alert, :emerg, :crit
messagestringthe message itself.
sourcestringthe origin of the log message. This could be a resource, a property of a resource, or the string "Puppet".
tagsarrayeach array element is a string.
timedatetimewhen the message was sent.

The “file” and “line” attributes are not always present.

A Puppet::Util::Metric object represents all the metrics in a single category. It contains the following attributes:

nametypedescription
namestringname of the metric category. This is the same as the key associated with this metric in the metrics hash of the Puppet::Transaction::Report.
labelstringThis is the "titleized" version of the name, which means underscores are replaced with spaces and the first word is capitalized.
valuesarrayAll the metric values within this category. Each element is of the form [name, titleized_name, value], where name is the name of the particular metric as a string, titleized_name is the "titleized" string of the name, and value is the quantity (an integer or a float).

The set of particular metrics and categories which appear in a report is a fixed set. In a successful report, the categories and metrics are:

  • In the “time” category, there is a metric for every resource type for which there is at least one resource in the catalog, plus two additional metrics, called “config_retrieval” and “total”. Each value in the “time” category is a float.
  • In the “resources” category, the metrics are “failed”, “out_of_sync”, “changed”, and “total”. Each value in the “resources” category is an integer.
  • In the “events” category, there are up to five metrics: “success”, “failure”, “audit”, “noop”, and “total”. “total” is always present; the others are only present when their values are non-zero. Each value in the “events” category is an integer.
  • In the “changes” category, there is only one metric, called “total”. Its value is an integer.

Failed reports contain no metrics.

In an inspect report, there is an additional “inspect” metric in the “time” category.

A Puppet::Resource::Status object represents the status of a single resource. It contains the following attributes:

nametypedescription
resource_typestringthe resource type, capitalized.
titletitlethe resource title.
resourcestringthe resource name, in the form Type[title]. This is always the same as the key corresponding to this Puppet::Resource::Status object in the resource_statuses hash. *deprecated*
filestringthe pathname of the manifest file which declared the resource
lineintegerthe line number in the manifest file which declared the resource
evaluation_timefloatthe amount of time, in seconds, taken to evaluate the resource. Not present in inspect reports.
change_countintegerthe number of properties which changed. Always 0 in inspect reports.
out_of_sync_countintegerthe number of properties which were out of sync. Always 0 in inspect reports.
tagsarraythe strings with which the resource is tagged
timedatetimethe time at which the resource was evaluated
eventsarraythe Puppet::Transaction::Event objects for the resource
out_of_syncbooleanTrue if out_of_sync_count > 0, otherwise false. *deprecated*
changedbooleanTrue if change_count > 0, otherwise false. *deprecated*
skippedbooleanTrue if the resource was skipped, otherwise false.

A Puppet::Transaction::Event object represents a single event for a single resource. It contains the following attributes:

nametypedescription
auditedbooleantrue if this property is being audited, otherwise false. True in inspect reports.
propertystringthe property for which the event occurred
previous_valuestring, array, or hashthe value of the property before the change (if any) was applied.
desired_valuestring, array, or hashthe value specified in the manifest. Absent in inspect reports.
historical_valuestring, array, or hashthe audited value from a previous run of Puppet, if known. Otherwise nil. Absent in inspect reports.
messagestringthe log message generated by this event
namesymbolthe name of the event. Absent in inspect reports.
statusstringone of the following strings: "success", "failure", "noop", "audit", depending on the type of the event (see below). Always "audit" in inspect reports.
timedatetimethe time at which the property was evaluated

Puppet::Transaction::Event#status has the following meanings:

  • “success”: property was out of sync, and was successfully changed to be in sync.
  • “failure”: property was out of sync, and couldn’t be changed to be in sync due to an error.
  • “noop”: property was out of sync, and wasn’t changed due to noop mode.
  • “audit”: property was in sync, and was being audited.

Differences from format 1

  • Puppet::Transaction::Report gained the properties “configuration_version”, “report_format”, “puppet_version”, “kind”, and “status”. It lost the property “external_times”.
  • In Puppet::Resource::Status, “change_count”, “changed”, and “out_of_sync” have new meanings, and “out_of_sync_count” was added. “changed” and “out_of_sync” are now always present. In addition, “resource_type” and “title” were added, and “source_description” and “version” were removed.
  • In Puppet::Transaction::Event, the “audited” and “historical_value” properties have been added. The meaning of “previous_value” and “desired_value” has changed. In addition, “file”, “line”, “resource”, “tags”, “source_description”, “version”, and “default_log_level” were removed.
  • Metric names are now always strings.
  • The metrics changes/total and events/total are now always present.
  • The metric time/total has been re-added (it was present in format 0).
  • In Puppet::Util::Log, the “version” attribute was removed.