440a7636f355d2165712f315e16b7acf5c52428f
[platform-oam.git] / metricbeat / config / metricbeat.yml
1 # ===============LICENSE_START=======================================================
2 # Acumos Apache-2.0
3 # ===================================================================================
4 # Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved.
5 # ===================================================================================
6 # This Acumos software file is distributed by AT&T and Tech Mahindra
7 # under the Apache License, Version 2.0 (the "License");
8 # you may not use this file except in compliance with the License.
9 # You may obtain a copy of the License at
10 #
11 # http://www.apache.org/licenses/LICENSE-2.0
12 #
13 # This file is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
17 # ===============LICENSE_END=========================================================
18
19 ###################### Metricbeat Configuration Example #######################
20
21 # This file is an example configuration file highlighting only the most common
22 # options. The metricbeat.full.yml file from the same directory contains all the
23 # supported options with more comments. You can use it as a reference.
24 #
25 # You can find the full configuration reference here:
26 # https://www.elastic.co/guide/en/beats/metricbeat/index.html
27
28 #==========================  Modules configuration ============================
29 metricbeat.config.modules:
30 #Modules are enabled by reading the .modules.d sub directory. Changes to these will automatically be detected and reflected.
31   path: ${path.config}/modules.d/*.yml
32   reload.period: 50s
33   reload.enabled: true
34
35 metricbeat.modules:
36
37 #================================ General =====================================
38
39 # The name of the shipper that publishes the network data. It can be used to group
40 # all the transactions sent by a single shipper in the web interface.
41   name: ${SHIPPER_NAME:docker}
42
43 # The tags of the shipper are included in their own field with each
44 # transaction published.
45 #tags: [${SHIPPER_TAGS}]
46
47 # Optional fields that you can specify to add additional information to the
48 # output.
49 #fields:
50 #  env: staging
51
52 #================================ Outputs =====================================
53
54 # Configure what outputs to use when sending the data collected by the beat.
55 # Multiple outputs may be used.
56
57 #================================= Paths ======================================
58 # The home path for the metricbeat installation. This is the default base path
59 # for all other path settings and for miscellaneous files that come with the
60 # distribution (for example, the sample dashboards).
61 # If not set by a CLI flag or in the configuration file, the default for the
62 # home path is the location of the binary.
63 #path.home: /usr/share/metricbeat/kibana/5/dashboard
64 #setup.dashboards.enabled: true
65 #setup.dashboards.directory: ${path.home}/kibana
66 # The configuration path for the metricbeat installation. This is the default
67 # base path for configuration files, including the main YAML configuration file
68 # and the Elasticsearch template file. If not set by a CLI flag or in the
69 # configuration file, the default for the configuration path is the home path.
70 #path.config: ${path.home}
71
72 # The data path for the metricbeat installation. This is the default base path
73 # for all the files in which metricbeat needs to store its data. If not set by a
74 # CLI flag or in the configuration file, the default for the data path is a data
75 # subdirectory inside the home path.
76 #path.data: ${path.home}/data
77
78 # The logs path for a metricbeat installation. This is the default location for
79 # the Beat's log files. If not set by a CLI flag or in the configuration file,
80 # the default for the logs path is a logs subdirectory inside the home path.
81 #path.logs: ${path.home}/logs
82
83 #============================== Dashboards =====================================
84 # These settings control loading the sample dashboards to the Kibana index. Loading
85 # the dashboards are disabled by default and can be enabled either by setting the
86 # options here, or by using the `-setup` CLI flag or the `setup` command.
87 setup.dashboards.enabled: true
88
89 # The directory from where to read the dashboards. The default is the `kibana`
90 # folder in the home path.
91 setup.dashboards.directory: ${path.home}/kibana
92 # The URL from where to download the dashboards archive. It is used instead of
93 # the directory if it has a value.
94 #setup.dashboards.url:
95
96 # The file archive (zip file) from where to read the dashboards. It is used instead
97 # of the directory when it has a value.
98 #setup.dashboards.file:
99
100 # In case the archive contains the dashboards from multiple Beats, this lets you
101 # select which one to load. You can load all the dashboards in the archive by
102 # setting this to the empty string.
103 #setup.dashboards.beat: metricbeat
104
105 # The name of the Kibana index to use for setting the configuration. Default is ".kibana"
106 #setup.dashboards.kibana_index: .kibana
107
108 # The Elasticsearch index name. This overwrites the index name defined in the
109 # dashboards and index pattern. Example: testbeat-*
110 #setup.dashboards.index:
111
112 # Always use the Kibana API for loading the dashboards instead of autodetecting
113 # how to install the dashboards by first querying Elasticsearch.
114 #setup.dashboards.always_kibana: false
115
116 #=== Template ===
117 setup.template.enabled: true
118 setup.template.fields: "${path.config}/fields.yml"
119 setup.template.name: "metricbeat-%{[beat.version]}"
120 setup.template.pattern: "metricbeat-%{[beat.version]}-*"
121 index: "metricbeat-%{[beat.version]}-%{+yyyy.MM.dd}"
122
123 #============================== Kibana =====================================
124 # Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.
125 # This requires a Kibana endpoint configuration.
126 setup.kibana.host: "${ELASTICSEARCH_HOST}:5601"
127
128
129 #-------------------------- Elasticsearch output ------------------------------
130 output.elasticsearch:
131
132   enabled: true
133
134   # Array of hosts to connect to.
135   #hosts: ["${HOST:elasticsearch}:${PORT:9200}"]
136   hosts: ["${ELASTICSEARCH_HOST}:${ELASTICSEARCH_PORT}"]
137
138   # Optional protocol and basic auth credentials.
139   #protocol: "https"
140   #username: "elastic"
141   #password: "changeme"
142
143 #================================ Logging =====================================
144
145 # Sets log level. The default log level is error.
146 # Available log levels are: critical, error, warning, info, debug
147 #logging.level: debug
148
149 # At debug level, you can selectively enable logging only for some components.
150 # To enable all selectors use ["*"]. Examples of other selectors are "beat",
151 # "publish", "service".
152 #logging.selectors: ["*"]