Open source Puppet documentation

Puppet versions 5.5.3 and later generate report format 10. This format is backward compatible with report format 9, which is used in Puppet versions 5.5.0 to 5.5.2.

Puppet::Transaction::Report

PropertyTypeDescription
hoststringThe host that generated this report.
timedatetimeWhen the Puppet run began.
logsarrayZero 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 for user-specified versioning schemes. Otherwise it is an integer representing seconds since the Unix epoch.
transaction_uuidstringA UUID covering the transaction. The query parameters for the catalog retrieval include the same UUID.
code_idstringThe ID of the code input to the compiler.
job_idstring, or nullThe ID of the job in which this transaction occurred.
catalog_uuidstringA master generated catalog UUID, useful for connecting a single catalog to multiple reports.
master_usedstringThe name of the master used to compile the catalog. If failover occurred, this holds the first master successfully contacted. If this run had no master (for example, a puppet apply run), this field is blank.
report_formatstring or integer"10" or 10
puppet_versionstringThe version of the Puppet agent.
statusstringThe transaction status: failed, changed, or unchanged.
transaction_completedBooleanWhether the transaction completed. For instance, if the transaction had an unrescued exception, transaction_completed = false.
noopBooleanWhether the Puppet run was in no-operation mode when it ran.
noop_pendingBoolean Whether there are changes that were not applied because of no-operation mode.
environmentstringThe environment that was used for the Puppet run.
corrective_changeBooleanTrue if a change or no-operation event in this report was caused by an unexpected change to the system between Puppet runs.
cached_catalog_statusstringThe status of the cached catalog used in the run: not_used, explicitly_requested, or on_failure.

Puppet::Util::Log

PropertyTypeDescription
filestringThe path and filename of the manifest file that triggered the log message. This property is not always present.
lineintegerThe manifest file's line number that triggered the log message. This property is not always present.
levelsymbolThe severity level of the message :debug, :info, :notice, :warning, :err, :alert, :emerg, :crit.
messagestringThe text of the message.
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.
timedatetimeThe time at which the message was sent.

Puppet::Util::Metric

A Puppet::Util::Metric object represents all the metrics in a single category.

PropertyTypeDescription
namestringSpecifies the name of the metric category. This is the same as the key associated with this metric in the metrics hash of the Puppet::Transaction::Report.
labelstringThe name of the metric formatted as a title. Underscores are replaced with spaces and the first word is capitalized.
valuesarrayAll the metric values within this category. Each value is in the form [name, label, value], where name is the particular metric as a string, label is the metric name formatted as a title, and value is the metric quantity as an integer or a float.
The metrics that appear in a report are part of a fixed set and arranged in the following categories:
time
Includes a metric for every resource type for which there is at least one resource in the catalog, plus two additional metrics: config_retrieval and total. Each value in the time category is a float.

In an inspect report, there is an additional inspect metric.

resources
Includes the metrics failed, out_of_sync, changed, and total. Each value in the resources category is an integer.
events
Includes up to five metrics: success, failure, audit, noop, and total. total is always present; the others are present when their values are non-zero. Each value in the events category is an integer.
changes
Includes one metric, total. Its value is an integer.
Note: Failed reports contain no metrics.

Puppet::Resource::Status

A Puppet::Resource::Status object represents the status of a single resource.

PropertyTypeDescription
resource_typestringThe resource type, capitalized.
titletitleThe resource title.
resourcestringThe resource name, in the form Type[title]. This is always the same as the key that corresponds to this Puppet::Resource::Status object in the resource_statuses hash. Deprecated.
provider_usedstringThe name of the provider used by the resource.
filestringThe path and filename of the manifest file that declared the resource.
lineintegerThe line number in the manifest file that 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 that changed. Always 0 in inspect reports.
out_of_sync_countintegerThe number of properties that 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 when out_of_sync_count > 0, otherwise false. Deprecated.
changedBooleanTrue when change_count > 0, otherwise false. Deprecated.
skippedBooleanTrue when the resource was skipped, otherwise false.
failedBooleanTrue when Puppet experienced an error while evaluating this resource, otherwise false. Deprecated.
failed_to_restartBooleanTrue when Puppet experienced an error while trying to restart this resource, for example, when a Service resource has been notified from another resource.
containment_patharrayAn array of strings; each element represents a container (type or class) that, together, make up the path of the resource in the catalog.

Puppet::Transaction::Event

A Puppet::Transaction::Event object represents a single event for a single resource.

PropertyTypeDescription
auditedBooleanTrue when this property is being audited, otherwise false. True in inspect reports.
propertystringThe property for which the event occurred. This value is missing if the provider errored out before it could be determined.
previous_valuestring, array, or hashThe value of the property before the change (if any) was applied. This value is missing if the provider errored out before it could be determined.
desired_valuestring, array, or hashThe value specified in the manifest. Absent in inspect reports. This value is missing if the provider errored out before it could be determined.
historical_valuestring, array, or hashThe audited value from a previous run of Puppet, if known. Otherwise nil. Absent in inspect reports. This value is missing if the provider errored out before it could be determined.
messagestringThe log message generated by this event.
namesymbolThe name of the event. Absent in inspect reports.
statusstringThe event status:
  • 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 but wasn’t changed because the run was in no-operation mode.
  • audit: Property was in sync and was being audited. Inspect reports are always in audit status.
redactedBooleanWhether this event has been redacted.
timedatetimeThe time at which the property was evaluated.
corrective_changeBooleanTrue if this event was caused by an unexpected change to the system between Puppet runs.

Differences from report format 9

  • failed_to_restart was added to Puppet::Resource::Status
Back to top
The page rank or the 1 our of 5 rating a user has given the page.
The email address of the user submitting feedback.
The URL of the page being ranked/rated.