tripleo-heat-templates/environments/collectd-environment.yaml
Martin Magr b9aa60bb68 Collectd documentation refactor
This patch is adding missing documentation of two collectd write plugins
in the collectd-evnironment.yaml and fixes deprecated configuration keys
for metrics_qdr in metrics-collectd-qdr.yaml.

Change-Id: I7d41bbf1ca46114cfa5f1784baa8da03aee9fcab
2018-10-02 11:55:37 +02:00

110 lines
3.0 KiB
YAML

resource_registry:
OS::TripleO::Services::Collectd: ../docker/services/metrics/collectd.yaml
# parameter_defaults:
#
################
#### Basic Collectd configuration
################
#
## These are the default plugins used by collectd
#
# CollectdDefaultPlugins:
# - disk
# - interface
# - load
# - memory
# - processes
# - tcpconns
#
## Extra plugins can be enabled by the CollectdExtraPlugins parameter:
## All the plugins availables are:
#
# CollectdExtraPlugins:
# - disk
# - df
#
## To choose write plugin use below parameter:
#
# CollectdConnectionType: 'gnocchi' (default) / 'amqp1' / 'network'
#
################
#### Collectd with network write plugin
################
#
# CollectdServer: collectd0.example.com
# CollectdServerPort: 25826
# CollectdSecurityLevel: None
#
## If CollectdSecurityLevel is set to Encrypt or Sign the following parameters
## are also needed
#
# CollectdUsername: user
# CollectdPassword: password
#
################
#### Collectd with gnocchi write plugin
################
#
# CollectdGnocchiResourceType: collectd
# CollectdGnocchiBatchSize: 10
# CollectdGnocchiAuthMode: 'basic' / 'keystone' (default)
#
## By default collectd with gnocchi write plugin is configured to send metrics
## to gnocchi instance running on overcloud nodes. You can override this
## behaviour with below parameters.
#
## Parameters for basic authentication
# CollectdGnocchiProtocol: 'http'
# CollectdGnocchiServer: <IP>
# CollectdGnocchiPort: 8041
# CollectdGnocchiUser: admin
#
## Parameters for Keystone authentication
# CollectdGnocchiKeystoneAuthUrl
# CollectdGnocchiKeystoneUserName
# CollectdGnocchiKeystoneUserId
# CollectdGnocchiKeystonePassword
# CollectdGnocchiKeystoneProjectId
# CollectdGnocchiKeystoneProjectName
# CollectdGnocchiKeystoneUserDomainId
# CollectdGnocchiKeystoneUserDomainName
# CollectdGnocchiKeystoneProjectDomainId
# CollectdGnocchiKeystoneProjectDomainName
# CollectdGnocchiKeystoneRegionName
# CollectdGnocchiKeystoneInterface
# CollectdGnocchiKeystoneEndpoint
#
################
#### Collectd with amqp1 write plugin
################
#
## By default collectd uses local edge qdrouterd running on each overcloud node.
## You can override this behaviour with following parameters.
#
# CollectdAmqpHost: <IP>
# CollectdAmqpPort: 5666
# CollectdAmqpUser: guest
# CollectdAmqpPassword: guest
# CollectdAmqpTransportName: metrics
# CollectdAmqpAddress: collectd
# CollectdAmqpInstances: {}
# CollectdAmqpRetryDelay: 1
# CollectdAmqpInterval: 30
#
################
#### Tip
################
#
## You can use ExtraConfig (or one of the related *ExtraConfig keys)
## to additionaly configure collectd. For details see the documentation
## for puppet-collectd at https://github.com/voxpupuli/puppet-collectd .
#
# ExtraConfig:
# collectd::plugin::disk::disks:
# - "/^[vhs]d[a-f][0-9]?$/"
# collectd::plugin::df::mountpoints:
# - "/"
# collectd::plugin::df::ignoreselected: false
# collectd::plugin::cpu::valuespercentage: true