Skip to content

Commit 64cb0d3

Browse files
authored
Merge pull request #199 from puppetlabs/release-prep
Release prep v8.0.0
2 parents 8f689fa + 12302a3 commit 64cb0d3

File tree

3 files changed

+29
-103
lines changed

3 files changed

+29
-103
lines changed

CHANGELOG.md

+15
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22

33
All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
44

5+
## [v8.0.0](https://github.com/puppetlabs/puppetlabs-puppet_metrics_collector/tree/v8.0.0) (2023-06-23)
6+
7+
[Full Changelog](https://github.com/puppetlabs/puppetlabs-puppet_metrics_collector/compare/v7.2.0...v8.0.0)
8+
9+
### Changed
10+
11+
- \(SUP-3952\) Remove Puppet 6 as a supported platform [\#195](https://github.com/puppetlabs/puppetlabs-puppet_metrics_collector/pull/195) ([elainemccloskey](https://github.com/elainemccloskey))
12+
- \(SUP-3521\) Remove legacy code [\#191](https://github.com/puppetlabs/puppetlabs-puppet_metrics_collector/pull/191) ([m0dular](https://github.com/m0dular))
13+
14+
### Added
15+
16+
- \(SUP-4210\) Remove logic for EOL Postgres versions [\#197](https://github.com/puppetlabs/puppetlabs-puppet_metrics_collector/pull/197) ([Sharpie](https://github.com/Sharpie))
17+
- \(SUP-4200\) Puppet 8 compatibility [\#196](https://github.com/puppetlabs/puppetlabs-puppet_metrics_collector/pull/196) ([MartyEwings](https://github.com/MartyEwings))
18+
- \(SUP-4126\) Fix file sync additional metrics [\#192](https://github.com/puppetlabs/puppetlabs-puppet_metrics_collector/pull/192) ([m0dular](https://github.com/m0dular))
19+
520
## [v7.2.0](https://github.com/puppetlabs/puppetlabs-puppet_metrics_collector/tree/v7.2.0) (2023-02-06)
621

722
[Full Changelog](https://github.com/puppetlabs/puppetlabs-puppet_metrics_collector/compare/v7.1.1...v7.2.0)

REFERENCE.md

+13-102
Original file line numberDiff line numberDiff line change
@@ -27,30 +27,30 @@
2727
### Defined types
2828

2929
* [`puppet_metrics_collector::collect`](#puppet_metrics_collector--collect): Creates systemd units for collecting a given metric
30+
* [`puppet_metrics_collector::deprecated_parameter`](#puppet_metrics_collector--deprecated_parameter)
3031
* [`puppet_metrics_collector::pe_metric`](#puppet_metrics_collector--pe_metric): A defined type to manage the configuration of tbe different metrics collection targets
3132
* [`puppet_metrics_collector::sar_metric`](#puppet_metrics_collector--sar_metric): This class manages the collections of SAR metrics
3233

3334
### Functions
3435

35-
* [`puppet_metrics_collector::generate_metrics_server_command`](#puppet_metrics_collector--generate_metrics_server_command): Generate the metrics shipping command for the cron job including remote metrics
3636
* [`puppet_metrics_collector::hosts_with_pe_profile`](#puppet_metrics_collector--hosts_with_pe_profile): Function: hosts_with_pe_profile Queries PuppetDB for hosts with the specified Puppet Enterprise profile. Used by this module to query Puppet
3737
* [`puppet_metrics_collector::to_yaml`](#puppet_metrics_collector--to_yaml): Description: Converts the content of the passed array or hash to YAML
38-
* [`puppet_metrics_collector::version_based_excludes`](#puppet_metrics_collector--version_based_excludes): Function: version_based_excludes Description: Generates a list of services to exlude based on version of PE
38+
* [`puppet_metrics_collector::version_based_excludes`](#puppet_metrics_collector--version_based_excludes): Function: version_based_excludes Description: Generates a list of services to exlude based on the metrics type
3939

4040
## Classes
4141

4242
### <a name="puppet_metrics_collector"></a>`puppet_metrics_collector`
4343

44-
Optional Enum['influxdb','graphite','splunk_hec']: The metrics server type to send data to. Default: undef
44+
Optional Enum['splunk_hec']: The metrics server type to send data to. Default: undef
4545

4646
@ param metrics_server_hostname
4747
Optional String: The hostname of the metrics server to send data to. Default: undef
4848

4949
@ param metrics_server_port
5050
Optional Integer: The port number of the metrics server to send data to. Default: undef
5151

52-
Optional String: The database name on the metrics server to send data to.
53-
Required for metrics_server_type of influxdb. Default: undef
52+
Optional String: (Deprecated)The database name on the metrics server to send data to.
53+
Default: undef
5454

5555
Optional String: Allows you to define the command that is executed to gather metrics. Default: undef
5656

@@ -98,8 +98,6 @@ The following parameters are available in the `puppet_metrics_collector` class:
9898
* [`activemq_excludes`](#-puppet_metrics_collector--activemq_excludes)
9999
* [`metrics_server_hostname`](#-puppet_metrics_collector--metrics_server_hostname)
100100
* [`metrics_server_port`](#-puppet_metrics_collector--metrics_server_port)
101-
* [`metrics_server_db_name`](#-puppet_metrics_collector--metrics_server_db_name)
102-
* [`override_metrics_command`](#-puppet_metrics_collector--override_metrics_command)
103101

104102
##### <a name="-puppet_metrics_collector--puppetserver_metrics_ensure"></a>`puppetserver_metrics_ensure`
105103

@@ -385,20 +383,7 @@ Default value: `undef`
385383

386384
Data type: `Optional[Integer]`
387385

388-
The port number of the metrics server to send data to. Default: undef
389-
390-
Default value: `undef`
391-
392-
##### <a name="-puppet_metrics_collector--metrics_server_db_name"></a>`metrics_server_db_name`
393-
394-
The database name on the metrics server to send data to.
395-
Required for metrics_server_type of influxdb. Default: undef
396-
397-
Default value: `undef`
398-
399-
##### <a name="-puppet_metrics_collector--override_metrics_command"></a>`override_metrics_command`
400-
401-
Allows you to define the command that is executed to gather metrics. Default: undef
386+
(Deprecated) The port number of the metrics server to send data to. Default: undef
402387

403388
Default value: `undef`
404389

@@ -593,6 +578,10 @@ Data type: `String`
593578

594579
Default value: `'5'`
595580

581+
### <a name="puppet_metrics_collector--deprecated_parameter"></a>`puppet_metrics_collector::deprecated_parameter`
582+
583+
The puppet_metrics_collector::deprecated_parameter class.
584+
596585
### <a name="puppet_metrics_collector--pe_metric"></a>`puppet_metrics_collector::pe_metric`
597586

598587
A defined type to manage the configuration of tbe different metrics collection targets
@@ -611,12 +600,8 @@ The following parameters are available in the `puppet_metrics_collector::pe_metr
611600
* [`ssl`](#-puppet_metrics_collector--pe_metric--ssl)
612601
* [`excludes`](#-puppet_metrics_collector--pe_metric--excludes)
613602
* [`additional_metrics`](#-puppet_metrics_collector--pe_metric--additional_metrics)
614-
* [`remote_metrics_enabled`](#-puppet_metrics_collector--pe_metric--remote_metrics_enabled)
615603
* [`override_metrics_command`](#-puppet_metrics_collector--pe_metric--override_metrics_command)
616604
* [`metrics_server_type`](#-puppet_metrics_collector--pe_metric--metrics_server_type)
617-
* [`metrics_server_hostname`](#-puppet_metrics_collector--pe_metric--metrics_server_hostname)
618-
* [`metrics_server_port`](#-puppet_metrics_collector--pe_metric--metrics_server_port)
619-
* [`metrics_server_db_name`](#-puppet_metrics_collector--pe_metric--metrics_server_db_name)
620605
* [`env_vars`](#-puppet_metrics_collector--pe_metric--env_vars)
621606

622607
##### <a name="-puppet_metrics_collector--pe_metric--metrics_type"></a>`metrics_type`
@@ -699,14 +684,6 @@ Data type: `Array[Hash]`
699684

700685
Default value: `[]`
701686

702-
##### <a name="-puppet_metrics_collector--pe_metric--remote_metrics_enabled"></a>`remote_metrics_enabled`
703-
704-
Data type: `Optional[Boolean]`
705-
706-
707-
708-
Default value: `lookup('puppet_metrics_collector::pe_metric::remote_metrics_enabled', { 'default_value' => undef })`
709-
710687
##### <a name="-puppet_metrics_collector--pe_metric--override_metrics_command"></a>`override_metrics_command`
711688

712689
Data type: `Optional[String]`
@@ -717,31 +694,7 @@ Default value: `undef`
717694

718695
##### <a name="-puppet_metrics_collector--pe_metric--metrics_server_type"></a>`metrics_server_type`
719696

720-
Data type: `Optional[Enum['influxdb','graphite','splunk_hec']]`
721-
722-
723-
724-
Default value: `undef`
725-
726-
##### <a name="-puppet_metrics_collector--pe_metric--metrics_server_hostname"></a>`metrics_server_hostname`
727-
728-
Data type: `Optional[String]`
729-
730-
731-
732-
Default value: `undef`
733-
734-
##### <a name="-puppet_metrics_collector--pe_metric--metrics_server_port"></a>`metrics_server_port`
735-
736-
Data type: `Optional[Integer]`
737-
738-
739-
740-
Default value: `undef`
741-
742-
##### <a name="-puppet_metrics_collector--pe_metric--metrics_server_db_name"></a>`metrics_server_db_name`
743-
744-
Data type: `Optional[String]`
697+
Data type: `Optional[Enum['splunk_hec']]`
745698

746699

747700

@@ -848,48 +801,6 @@ Default value: `undef`
848801

849802
## Functions
850803

851-
### <a name="puppet_metrics_collector--generate_metrics_server_command"></a>`puppet_metrics_collector::generate_metrics_server_command`
852-
853-
Type: Puppet Language
854-
855-
Generate the metrics shipping command for the cron job including remote metrics
856-
857-
#### `puppet_metrics_collector::generate_metrics_server_command(Optional[String] $scripts_dir, Optional[Enum['influxdb','graphite','splunk_hec']] $metrics_server_type = undef, Optional[String] $metrics_server_hostname = undef, Optional[String] $metrics_server_db_name = undef, Optional[Integer] $metrics_server_port = undef)`
858-
859-
The puppet_metrics_collector::generate_metrics_server_command function.
860-
861-
Returns: `String` of the metrics command or undef
862-
863-
##### `scripts_dir`
864-
865-
Data type: `Optional[String]`
866-
867-
the path to the scripts directory
868-
869-
##### `metrics_server_type`
870-
871-
Data type: `Optional[Enum['influxdb','graphite','splunk_hec']]`
872-
873-
the metric server type
874-
875-
##### `metrics_server_hostname`
876-
877-
Data type: `Optional[String]`
878-
879-
the metric server's address
880-
881-
##### `metrics_server_db_name`
882-
883-
Data type: `Optional[String]`
884-
885-
the influxdb database name
886-
887-
##### `metrics_server_port`
888-
889-
Data type: `Optional[Integer]`
890-
891-
the port to connect to
892-
893804
### <a name="puppet_metrics_collector--hosts_with_pe_profile"></a>`puppet_metrics_collector::hosts_with_pe_profile`
894805

895806
Type: Puppet Language
@@ -956,13 +867,13 @@ Type: Puppet Language
956867

957868
Function: version_based_excludes
958869

959-
Description: Generates a list of services to exlude based on version of PE
870+
Description: Generates a list of services to exlude based on the metrics type
960871

961872
#### `puppet_metrics_collector::version_based_excludes(String[1] $metrics_type)`
962873

963874
Function: version_based_excludes
964875

965-
Description: Generates a list of services to exlude based on version of PE
876+
Description: Generates a list of services to exlude based on the metrics type
966877

967878
Returns: `Array[String]` excludes the list of services to exclude
968879

metadata.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "puppetlabs-puppet_metrics_collector",
3-
"version": "7.2.0",
3+
"version": "8.0.0",
44
"author": "puppetlabs",
55
"summary": "A Puppet module for gathering metrics from PE components",
66
"license": "Apache-2.0",

0 commit comments

Comments
 (0)