Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(PIE-51) Ability to define a metrics server to ship to #19

Merged
merged 10 commits into from
Jul 11, 2019
Merged

(PIE-51) Ability to define a metrics server to ship to #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8e60f7d
Add the ability to ship metrics directly to influxdb
npwalker Jan 29, 2018
f96ebf8
Allow a hash of metrics server information
npwalker Feb 6, 2018
1374931
Cleanup from merge
Jun 19, 2019
2e582c5
Update documentation with metrics_server_info type
Jun 25, 2019
5f611e8
Redirect port_metrics_command stdout to /dev/null
Jun 25, 2019
477ed21
Parameter to override entire metrics command
Jun 25, 2019
1a2b5fe
Addition of splunk_hec metric server type
Jun 27, 2019
321000d
Enables use_splunk_hec bool
Jul 1, 2019
49c6efd
Merge pull request #1 from mrzarquon/PIE-51
Jul 1, 2019
3fce0ad
Dissolve metrics_server_info into params
Jul 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,38 @@ Integer: How often to collect metrics, in minutes. Defaults to `5`.

Integer: How long to retain collect metrics, in days. Defaults to `90`.

##### Metrics Server Parameters

The following set of parameters begining with `metrics_server_` allows for the specification of a server type to use to generate and in some cases send data to a specified server.
Currently both `influxdb` and `graphite` types allow for the transfer of data while `splunk_hec` only generates the data.

##### metrics_server_type

Optional Enum['influxdb','graphite','splunk_hec']: specifies the metrics server type to write data to. Currently it supports `influxdb`, `graphite` and `splunk_hec` type servers.

To Note:

Please note that for `influxdb` server types a `dbname` must be provided.

Please note that for a server type of `splunk_hec` no data can be sent to a server with the current configuration, however the command will format the json output using the `splunk_hec` module, which is a requirement for this option and can be found on the Forge [here](https://forge.puppet.com/puppetlabs/splunk_hec) or [here](https://github.com/puppetlabs/puppetlabs-splunk_hec) on github.
Further setup instructions for using the `splunk_hec` module can be found within the modules own README.md.

##### metrics_server_hostname

Optional String: Allows you to define the host name of a server to send data to. Defaults to undef.

##### metrics_server_port

Optional Integer: Allows you to define the port number of a server to send data to. Defaults to undef.

##### metrics_server_db_name

Optional String: Allows you to define the database name of a server to send data to. Required for `metrics_server_type` of `influxdb`. Defaults to undef.

##### override_metrics_command

Optional String: Allows you to override the command that is run to gather metrics. Defaults to undef.


## Usage

Expand Down
Loading