Releases: puppetlabs/TA-puppet-report-viewer
PE Status Check Dashboards
Version 4.0.0
Breaking Changes:
- This release adds new dashboards that depend on the status indicator visualization.
New Features:
- Changes to Metrics dropdowns for better filtering.
- Changes to Metrics view to chart a number of metrics
by host
for comparison view. - New PE Metrics tab contains Metrics and Status Checks.
- Adds PE Status Check Dashboards
- Note: Requires the
puppetlabs-pe_status_check
module.
- Note: Requires the
- Adds PE Status Check Dashboards
Fixes:
- Removes conditional filtering for PostgreSQL metric dashboards preventing them from properly loading.
New dashboard panels for PostgreSQL metrics
New Features:
- New dashboard panels added to the Metrics tab which track a number of useful metrics for PostgreSQL.
- The Metrics tab now supports reviewing metrics for multiple PE installations.
Fixes:
- Reorganized the order of the navigation tabs in the app to align with the removal of the custom alert actions.
Support distributed Splunk installations
New Features:
puppet:activities_console
, andpuppet:activities_code_manager
source types added to compliment PE Event Forwarding.
Fixes:
- In a distributed Splunk installation, it was previously required to have this app installed on both the Search Heads and the Indexers to ensure that the source types were available across the installation.
- Removed the
AUTO_KV_JSON
setting to allow for the default value (true); JSON parsing now occurs at search-time.
- Removed the
Updated Metrics Tab
New Features:
- This version replaces the default dashboard panels available in the Metrics tab with all new dashboards.
- Puppet Metrics:
- Puppet Server
- PuppetDB
- Orchestrator (PE Only)
- Puppet Metrics:
- Details on the data that each dashboard panel is measuring can be found in the associated blog post.
New source types and UI fixes
New Features:
puppet:jobs
,puppet:activities_rbac
, andpuppet:activities_classifier
source types added.
Fixes:
- Some of the panels in the Overview dashboard still contained an "X" button to close the drilldown pop-up panel opened.
- Changed the drilldown to set/unset the token that shows the drilldown panel on click.
- Removed the remaining "X" buttons.
- Updated titles in drilldown.
New puppet:events_summary and puppet:activity source types
New Features:
puppet:events_summary
andpuppet:activity
source types added.
Fixes:
- The search in the Overview tab to display the resource count under the "# of Resources" panel and associated drilldown table to ensure the results display the correct number of events.
Removal of Alert Actions
Breaking Changes:
This release isolates the Report Viewer from the Alert Actions.
As such, this release does not contain any custom alert actions. The alert action configuration has since been moved to the Puppet Alert Actions add-on.
Upgrading to this version will require installing the aforementioned add-on if you wish to continue utilizing custom alert actions.
Bolt Action Tasks and Metrics Addition
Breaking Changes:
The alert action named Generate detailed report has been renamed Generate a detailed Puppet report to make it more specific. The internal name of the action has been renamed to puppet_generate_detailed_report from generate_detailed_report to prevent confusion with out alert actions and to ensure consistency with other. You will need to update existing searches using this action to use the new name, but no other changes to the searches is required.
Alert actions will fail until Puppet Username is provided instead of PE auth token.
Full URIs are now required instead of just hostnames adds more flexibility the authorization methods (http support and custom ports) but you will need to redo your app configuration before alert actions resume functioning.
Searches defaulting to main and not using the index macros will stop updating if you move the corressponding puppet data to an index but don't change the search.
New Features:
Built in support for running Bolt Tasks in Puppet Enterprise from Splunk.
Metrics tab to show PE metric data if metrics are configured.
Actions Tab in dashboard added to show logs and status of any of this applications alert actions for debugging or auditing.
Support for Puppet Username/Password instead of auth token.
All searches support per sourcetype indexes.
Fixes:
Alert actions work with custom parameters.
Before there was no way to see if your alerts were working easily, now they publish information to the puppet:action sourcetype.
Fact support and multiple indexes
1.5.1:
New Features:
- Full dashboard updates
- Support for Facts sourcetype (puppet:facts), and dashboards to use it
- Introduces "Report Builder" page to help a user build reports and then craft custom search from the iterface to use for alerts or their own uses
- Introduces Advanced Search macros to allow for customized indexs without requiring to modify the app. See Advanced Configuration section of the readme
- Add's sourcetypes of puppet:action, puppet:metrics, for future use
- Example Alert added, the search to generate a detailed report for any summary report that isn't "unchanged" has been added to the app, but set as disabled
Fixes:
- Duplicate item entry fixed, sourcetype's are now configured to extract KV from json only once
- Updated documentation
First public release
This Add-on allows for Puppet users to view the results of Puppet agent runs easily in the Splunk Enterprise console.
Includes are:
- Sourcetypes for Puppet Summary & Detailed style reports, along with Puppet Bolt reports
- Actionable Alert to generate Puppet Detailed Reports on demand
- Example dashboards to see analysis options of the content provided in a report
This requires installing the Splunk HEC Report Processor on the Puppet Servers of the systems one wishes to collect data from, for more information: https://forge.puppet.com/puppetlabs/splunk_hec