27
27
### Defined types
28
28
29
29
* [ ` 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 )
30
31
* [ ` puppet_metrics_collector::pe_metric ` ] ( #puppet_metrics_collector--pe_metric ) : A defined type to manage the configuration of tbe different metrics collection targets
31
32
* [ ` puppet_metrics_collector::sar_metric ` ] ( #puppet_metrics_collector--sar_metric ) : This class manages the collections of SAR metrics
32
33
33
34
### Functions
34
35
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
36
36
* [ ` 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
37
37
* [ ` 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
39
39
40
40
## Classes
41
41
42
42
### <a name =" puppet_metrics_collector " ></a >` puppet_metrics_collector `
43
43
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
45
45
46
46
@ param metrics_server_hostname
47
47
Optional String: The hostname of the metrics server to send data to. Default: undef
48
48
49
49
@ param metrics_server_port
50
50
Optional Integer: The port number of the metrics server to send data to. Default: undef
51
51
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
54
54
55
55
Optional String: Allows you to define the command that is executed to gather metrics. Default: undef
56
56
@@ -98,8 +98,6 @@ The following parameters are available in the `puppet_metrics_collector` class:
98
98
* [ ` activemq_excludes ` ] ( #-puppet_metrics_collector--activemq_excludes )
99
99
* [ ` metrics_server_hostname ` ] ( #-puppet_metrics_collector--metrics_server_hostname )
100
100
* [ ` 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 )
103
101
104
102
##### <a name =" -puppet_metrics_collector--puppetserver_metrics_ensure " ></a >` puppetserver_metrics_ensure `
105
103
@@ -385,20 +383,7 @@ Default value: `undef`
385
383
386
384
Data type: ` Optional[Integer] `
387
385
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
402
387
403
388
Default value: ` undef `
404
389
@@ -593,6 +578,10 @@ Data type: `String`
593
578
594
579
Default value: ` '5' `
595
580
581
+ ### <a name =" puppet_metrics_collector--deprecated_parameter " ></a >` puppet_metrics_collector::deprecated_parameter `
582
+
583
+ The puppet_metrics_collector::deprecated_parameter class.
584
+
596
585
### <a name =" puppet_metrics_collector--pe_metric " ></a >` puppet_metrics_collector::pe_metric `
597
586
598
587
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
611
600
* [ ` ssl ` ] ( #-puppet_metrics_collector--pe_metric--ssl )
612
601
* [ ` excludes ` ] ( #-puppet_metrics_collector--pe_metric--excludes )
613
602
* [ ` additional_metrics ` ] ( #-puppet_metrics_collector--pe_metric--additional_metrics )
614
- * [ ` remote_metrics_enabled ` ] ( #-puppet_metrics_collector--pe_metric--remote_metrics_enabled )
615
603
* [ ` override_metrics_command ` ] ( #-puppet_metrics_collector--pe_metric--override_metrics_command )
616
604
* [ ` 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 )
620
605
* [ ` env_vars ` ] ( #-puppet_metrics_collector--pe_metric--env_vars )
621
606
622
607
##### <a name =" -puppet_metrics_collector--pe_metric--metrics_type " ></a >` metrics_type `
@@ -699,14 +684,6 @@ Data type: `Array[Hash]`
699
684
700
685
Default value: ` [] `
701
686
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
-
710
687
##### <a name =" -puppet_metrics_collector--pe_metric--override_metrics_command " ></a >` override_metrics_command `
711
688
712
689
Data type: ` Optional[String] `
@@ -717,31 +694,7 @@ Default value: `undef`
717
694
718
695
##### <a name =" -puppet_metrics_collector--pe_metric--metrics_server_type " ></a >` metrics_server_type `
719
696
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']] `
745
698
746
699
747
700
@@ -848,48 +801,6 @@ Default value: `undef`
848
801
849
802
## Functions
850
803
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
-
893
804
### <a name =" puppet_metrics_collector--hosts_with_pe_profile " ></a >` puppet_metrics_collector::hosts_with_pe_profile `
894
805
895
806
Type: Puppet Language
@@ -956,13 +867,13 @@ Type: Puppet Language
956
867
957
868
Function: version_based_excludes
958
869
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
960
871
961
872
#### ` puppet_metrics_collector::version_based_excludes(String[1] $metrics_type) `
962
873
963
874
Function: version_based_excludes
964
875
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
966
877
967
878
Returns: ` Array[String] ` excludes the list of services to exclude
968
879
0 commit comments