summaryrefslogtreecommitdiff
path: root/config.yaml
blob: de3b091e3cfe5cfaa0531586727fbf294f63b2f8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# Copyright 2015-2016 Canonical Ltd.
#
# This file is part of the Telegraf Charm for Juju.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3, as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranties of
# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
# PURPOSE.  See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
options:
  tags: 
    type: string
    default: ""
    description: |
        Comma separated list of global tags.
        ie, 'dc=us-east-1,rack=1a' will tag all metrics with dc=us-east-1 and rack=1a
  interval: 
    type: string
    default: "10s"
    description: "Default data collection interval for all plugins"
  round_interval: 
    type: boolean
    default: true
    description: | 
        Rounds collection interval to 'interval'
        ie, if interval="10s" then always collect on :00, :10, :20, etc.
  flush_interval: 
    type: string
    default: "10s"
    description: |
        Default data flushing interval for all outputs. You should not set this below
        interval. Maximum flush_interval will be flush_interval + flush_jitter
  flush_jitter: 
    type: string
    default: "0s"
    description: |
        Jitter the flush interval by a random amount. This is primarily to avoid
        large write spikes for users running a large number of telegraf instances.
        ie, a jitter of 5s and interval 10s means flushes will happen every 10-15s
  collection_jitter:
    type: string
    default: "0s"
    description: |
        Collection jitter is used to jitter the collection by a random amount.
        Each plugin will sleep for a random time within jitter before collecting.
        This can be used to avoid many plugins querying things like sysfs at the
        same time, which can have a measurable effect on the system.
  metric_buffer_limit:
    type: int
    default: 10000
    description: |
        Telegraf will cache metric_buffer_limit metrics for each output, and will
        flush this buffer on a successful write.
  debug: 
    type: boolean
    default: false
    description: "Run telegraf in debug mode"
  quiet: 
    type: boolean
    default: false
    description: "Run telegraf in quiet mode"
  hostname:
    type: string
    default: "{model}:{unit}"
    description: |
       Override default hostname. {model} is replaced with the Juju
       model name and {unit} is replaced with the sanitized unit name
       (eg. service_name-0). {uuid} is replaced by the model UUID, for
       sites without unique model names. {host} is replaced by the
       machine hostname
  prometheus_output_port:
    type: string
    default: "9103"
    description: |
        If set prometheus output plugin will be configured to listen on the provided port.
        If set to string "default" the charm will use default port (9103)
  inputs_config: 
    type: string
    default: ""
    description: "[inputs.xxx] sections as a string, this override default input plugins."
  outputs_config: 
    type: string
    default: ""
    description: "[outputs.xxx] sections as a string"
  install_sources:
    # description and type comes from the apt layer.
    default: |
      - ppa:telegraf-devs/ppa
  install_keys:
    # description and type comes from the apt layer.
    default: |
      - null
  extra_options:
    default: ""
    type: string 
    description: |
        YAML with extra options for out|inputs managed by relations or in the default config.
        example:
          inputs:
              cpu:
                  percpu: false
                  fielddrop: ["time_*"]
              disk:
                  mount_points: ["/"]
                  ignore_fs: ["tmpfs", "devtmpfs"]
              elasticsearch:
                  local: false 
                  cluster_health: true
              postgresql:
                  databases: ["foo", "bar"]
                  tagpass: 
                      db: ["template", "postgres"]
          outputs:
              influxdb:
                  precision: ms
  extra_plugins: 
    default: ""
    type: string 
    description: |
        Extra plugins, manually configured. This is expected to be a string 
        and will be saved "as is" in /etc/telegraf/telegraf.d/extra_plugins.conf