interface-definitions/service_monitoring_prometheus.xml.in


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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229

<?xml version="1.0"?>
<interfaceDefinition>
  <node name="service">
    <children>
      <node name="monitoring">
        <children>
          <node name="prometheus" owner="${vyos_conf_scripts_dir}/service_monitoring_prometheus.py">
            <properties>
              <help>Prometheus metric exporter</help>
              <priority>1280</priority>
            </properties>
            <children>
              <node name="node-exporter">
                <properties>
                  <help>Prometheus exporter for hardware and operating system metrics</help>
                </properties>
                <children>
                  #include <include/listen-address.xml.i>
                  #include <include/port-number.xml.i>
                  <leafNode name="port">
                    <defaultValue>9100</defaultValue>
                  </leafNode>
                  #include <include/interface/vrf.xml.i>
                  <node name="collectors">
                    <properties>
                      <help>Collectors specific configuration</help>
                    </properties>
                    <children>
                      <leafNode name="textfile">
                        <properties>
                          <help>Enables textfile collector to read from /run/node_exporter/collector</help>
                          <valueless/>
                        </properties>
                      </leafNode>
                    </children>
                  </node>
                </children>
              </node>
              <node name="frr-exporter">
                <properties>
                  <help>Prometheus exporter for FRR metrics</help>
                </properties>
                <children>
                  #include <include/listen-address.xml.i>
                  #include <include/port-number.xml.i>
                  <leafNode name="port">
                    <defaultValue>9342</defaultValue>
                  </leafNode>
                  #include <include/interface/vrf.xml.i>
                  <node name="collector">
                    <properties>
                      <help>Collector specific configuration</help>
                    </properties>
                    <children>
                      <node name="bgp">
                        <properties>
                          <help>BGP collector specific options</help>
                        </properties>
                        <children>
                          <leafNode name="accept-filtered-prefixes">
                            <properties>
                              <help>Enable retrieval of accepted and filtered BGP prefix counts</help>
                              <valueless/>
                            </properties>
                          </leafNode>
                          <leafNode name="advertised-prefixes">
                            <properties>
                              <help>Enable count of advertised prefixes to a BGP peer (for FRR versions without PfxSnt field)</help>
                              <valueless/>
                            </properties>
                          </leafNode>
                          <leafNode name="peer-description">
                            <properties>
                              <help>Add the BGP peer description as a label to peer metrics</help>
                              <completionHelp>
                                <list>json plain-text</list>
                              </completionHelp>
                              <valueHelp>
                                <format>json</format>
                                <description>Use the value of the desc key from the JSON formatted BGP peer description</description>
                              </valueHelp>
                              <valueHelp>
                                <format>plain-text</format>
                                <description>Use the full text of the BGP peer description</description>
                              </valueHelp>
                              <constraint>
                                <regex>(json|plain-text)</regex>
                              </constraint>
                            </properties>
                            <defaultValue>json</defaultValue>
                          </leafNode>
                          <leafNode name="peer-group">
                            <properties>
                              <help>Add the peer group name of the BGP peer as a label to peer metrics</help>
                              <valueless/>
                            </properties>
                          </leafNode>
                          <leafNode name="peer-hostname">
                            <properties>
                              <help>Add the hostname of the BGP peer as a label to peer metrics</help>
                              <valueless/>
                            </properties>
                          </leafNode>
                          <leafNode name="peer-type">
                            <properties>
                              <help>Enable metrics for the number of established BGP peers per type, defined by the type key in the JSON formatted peer description</help>
                              <valueless/>
                            </properties>
                          </leafNode>
                        </children>
                      </node>
                      <leafNode name="bgp-l2-vpn">
                        <properties>
                          <help>Enable BGP L2VPN collector</help>
                          <valueless/>
                        </properties>
                      </leafNode>
                      <leafNode name="ospf-instance">
                        <properties>
                          <help>OSPF instance ID when using multiple OSPF instances</help>
                          <valueHelp>
                            <format>u32:1-65535</format>
                            <description>OSPF instance ID</description>
                          </valueHelp>
                          <constraint>
                            <validator name="numeric" argument="--range 1-65535"/>
                          </constraint>
                          <multi/>
                        </properties>
                      </leafNode>
                      <leafNode name="pim">
                        <properties>
                          <help>Enable PIM collector</help>
                          <valueless/>
                        </properties>
                      </leafNode>
                      <leafNode name="detailed-routes">
                        <properties>
                          <help>Enable detailed route count of each route type</help>
                          <valueless/>
                        </properties>
                      </leafNode>
                    </children>
                  </node>
                </children>
              </node>
              <node name="blackbox-exporter">
                <properties>
                  <help>Prometheus exporter for probing endpoints</help>
                </properties>
                <children>
                  #include <include/listen-address.xml.i>
                  #include <include/port-number.xml.i>
                  <leafNode name="port">
                    <defaultValue>9115</defaultValue>
                  </leafNode>
                  #include <include/interface/vrf.xml.i>
                  <node name="modules">
                    <properties>
                      <help>Configure blackbox exporter modules</help>
                    </properties>
                    <children>
                      <node name="dns">
                        <properties>
                          <help>Configure dns module</help>
                        </properties>
                        <children>
                          <tagNode name="name">
                            <properties>
                              <help>Name of the dns module</help>
                            </properties>
                            <children>
                              <leafNode name="query-name">
                                <properties>
                                  <help>Name to be queried</help>
                                  <constraint>
                                    <validator name="fqdn"/>
                                  </constraint>
                                </properties>
                              </leafNode>
                              <leafNode name="query-type">
                                <properties>
                                  <help>DNS query type</help>
                                  <valueHelp>
                                    <format>ANY</format>
                                    <description>Query any DNS record</description>
                                  </valueHelp>
                                  <valueHelp>
                                    <format>A</format>
                                    <description>Query IPv4 address record</description>
                                  </valueHelp>
                                  <valueHelp>
                                    <format>AAAA</format>
                                    <description>Query IPv6 address record</description>
                                  </valueHelp>
                                </properties>
                                <defaultValue>ANY</defaultValue>
                              </leafNode>
                              #include <include/monitoring/blackbox-exporter-module-commons.xml.i>
                            </children>
                          </tagNode>
                        </children>
                      </node>
                      <node name="icmp">
                        <properties>
                          <help>Configure icmp module</help>
                        </properties>
                        <children>
                          <tagNode name="name">
                            <properties>
                              <help>Name of the icmp module</help>
                            </properties>
                            <children>
                              #include <include/monitoring/blackbox-exporter-module-commons.xml.i>
                            </children>
                          </tagNode>
                        </children>
                      </node>
                    </children>
                  </node>
                </children>
              </node>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>