|
1 | 1 | Table of Contents
|
2 | 2 | =================
|
3 | 3 |
|
4 |
| -* [Overview](#overview) |
5 |
| -* [Setup](#setup) |
6 |
| - * [Installation](#installation) |
7 |
| - * [Configuration](#configuration) |
8 |
| -* [Usage](#usage) |
9 |
| - * [Grepping Metrics](#grepping-metrics) |
10 |
| - * [Sharing Metrics Data](#sharing-metrics-data) |
11 |
| -* [Reference](#reference) |
12 |
| - * [Directory Layout](#directory-layout) |
13 |
| - * [Systemd Timers](#systemd-timers) |
14 |
| -* [Alternate Setup](#alternate-setup) |
15 |
| - * [Temporary Installation](#temporary-installation) |
16 |
| - * [Manual Configuration of Hosts](#manual-configuration-of-hosts) |
17 |
| - * [Configuration for Distributed Metrics Collection](#Configuration-for-distributed-metrics-collection) |
18 |
| -* [How to Report an issue or contribute to the module](#How-to-Report-an-issue-or-contribute-to-the-module) |
| 4 | +- [Table of Contents](#table-of-contents) |
| 5 | + - [Overview](#overview) |
| 6 | + - [Setup](#setup) |
| 7 | + - [Installation](#installation) |
| 8 | + - [Configuration](#configuration) |
| 9 | + - [Parameters](#parameters) |
| 10 | + - [output_dir](#output_dir) |
| 11 | + - [collection_frequency](#collection_frequency) |
| 12 | + - [retention_days](#retention_days) |
| 13 | + - [Metrics Server Parameters](#metrics-server-parameters) |
| 14 | + - [metrics_server_type](#metrics_server_type) |
| 15 | + - [metrics_server_hostname](#metrics_server_hostname) |
| 16 | + - [metrics_server_port](#metrics_server_port) |
| 17 | + - [metrics_server_db_name](#metrics_server_db_name) |
| 18 | + - [override_metrics_command](#override_metrics_command) |
| 19 | + - [Usage](#usage) |
| 20 | + - [Searching Metrics](#searching-metrics) |
| 21 | + - [Searching Puppetserver Metrics](#searching-puppetserver-metrics) |
| 22 | + - [Searching PuppetDB Metrics](#searching-puppetdb-metrics) |
| 23 | + - [Sharing Metrics Data](#sharing-metrics-data) |
| 24 | + - [Reference](#reference) |
| 25 | + - [Directory Layout](#directory-layout) |
| 26 | + - [Systemd Timers](#systemd-timers) |
| 27 | + - [Alternate Setup](#alternate-setup) |
| 28 | + - [Temporary Installation](#temporary-installation) |
| 29 | + - [Manual Configuration of Hosts](#manual-configuration-of-hosts) |
| 30 | + - [Monolithic Infrastructure with Compilers](#monolithic-infrastructure-with-compilers) |
| 31 | + - [Hiera Data Example](#hiera-data-example) |
| 32 | + - [Class Declaration Example](#class-declaration-example) |
| 33 | + - [Configuration for Distributed Metrics Collection](#configuration-for-distributed-metrics-collection) |
| 34 | + - [How to Report an issue or contribute to the module](#how-to-report-an-issue-or-contribute-to-the-module) |
| 35 | +- [Supporting Content](#supporting-content) |
| 36 | + - [Articles](#articles) |
| 37 | + - [Videos](#videos) |
19 | 38 |
|
20 | 39 | ## Overview
|
21 | 40 |
|
@@ -346,3 +365,33 @@ class { 'puppet_metrics_collector':
|
346 | 365 |
|
347 | 366 | If you are a PE user and need support using this module or are encountering issues, our Support team would be happy to help you resolve your issue and help reproduce any bugs. Just raise a ticket on the [support portal](https://support.puppet.com/hc/en-us/requests/new).
|
348 | 367 | If you have a reproducible bug or are a community user you can raise it directly on the Github issues page of the module [here](https://github.com/puppetlabs/puppetlabs-puppet_metrics_collector/issues). We also welcome PR contributions to improve the module. Please see further details about contributing [here](https://puppet.com/docs/puppet/7.5/contributing.html#contributing_changes_to_module_repositories).
|
| 368 | + |
| 369 | + |
| 370 | +--- |
| 371 | + |
| 372 | +# Supporting Content |
| 373 | + |
| 374 | +### Articles |
| 375 | + |
| 376 | +The [Support Knowledge base](https://support.puppet.com/hc/en-us) is a searchable repository for technical information and how-to guides for all Puppet products. |
| 377 | + |
| 378 | +This Module has the following specific Article(s) available: |
| 379 | + |
| 380 | +1. [Troubleshoot and fix performance issues with the puppetlabs-puppet_metrics_collector module in Puppet Enterprise ](https://support.puppet.com/hc/en-us/articles/231751308) |
| 381 | +2. [Manage the installation and configuration of metrics dashboards using the puppetlabs-puppet_metrics_dashboard module for Puppet Enterprise 2016.4 to 2019.1](https://support.puppet.com/hc/en-us/articles/360006641414) |
| 382 | +3. [Troubleshooting potential issues in Puppet Enterprise: How to learn more](https://support.puppet.com/hc/en-us/articles/360004106074) |
| 383 | + |
| 384 | +### Videos |
| 385 | + |
| 386 | +The [Support Video Playlist](https://youtube.com/playlist?list=PLV86BgbREluWKzzvVulR74HZzMl6SCh3S) is a resource of content generated by the support team |
| 387 | + |
| 388 | +This Module has the following specific video content available: |
| 389 | + |
| 390 | + |
| 391 | +1. [Puppet Metrics Overview ](https://youtu.be/LiCDoOUS4hg) |
| 392 | +2. [Collecting and Displaying Puppet Metrics](https://youtu.be/13sBMQGDqsA) |
| 393 | +3. [Interpreting Puppet Metrics](https://youtu.be/09iDO3DlKMQ) |
| 394 | + |
| 395 | + |
| 396 | + --- |
| 397 | + |
0 commit comments