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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
|
%global _empty_manifest_terminate_build 0
Name: python-netbox-plugin-prometheus-sd
Version: 0.6.3
Release: 1
Summary: A Netbox plugin to provide Netbox entires to Prometheus HTTP service discovery
License: MIT
URL: https://pypi.org/project/netbox-plugin-prometheus-sd/
Source0: https://mirrors.aliyun.com/pypi/web/packages/62/56/3fef3480177f1e5a92dc93281ce000ff6ea8024eebc9382b81da73fcc2f1/netbox_plugin_prometheus_sd-0.6.3.tar.gz
BuildArch: noarch
%description
# netbox-plugin-prometheus-sd
[](https://opensource.org/licenses/MIT)
[](https://github.com/FlxPeters/netbox-plugin-prometheus-sd/actions?query=workflow%3ACI)
[](https://pypi.org/project/netbox-plugin-prometheus-sd/)
Provide Prometheus http_sd compatible API Endpoint with data from Netbox.
HTTP SD is a new feature in Prometheus 2.28.0 that allows hosts to be found via a URL instead of just files.
This plugin implements API endpoints in Netbox to make devices, IPs and virtual machines available to Prometheus.
## Compatibility
We aim to support the latest major versions of Netbox. For now we Support Netbox `2.11`, `3.0`, `3.1`, `3.2` and `3.3` including bugfix versions.
All relevant target versions are tested in CI. Have a look at the Github Actions definition for the current build targets.
## Installation
The plugin is available as a Python package in pypi and can be installed with pip
pip install netbox-plugin-prometheus-sd
Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:
PLUGINS = ['netbox_prometheus_sd']
The plugin has not further plugin configuration at the moment.
## Usage
The plugin only provides a new API endpoint on the Netbox API. There is no further action required after installation.
### API
The plugin reuses Netbox API view sets with new serializers for Prometheus.
This means that all filters that can be used on the Netbox api can also be used to filter Prometheus targets.
Paging is disabled because Prometheus does not support paged results.
The plugin also reuses the Netbox authentication and permission model.
Depending on the Netbox configuration, a token with valid object permissions must be passed to Netbox.
```
GET /api/plugins/prometheus-sd/devices/ Get a list of devices in a prometheus compatible format
GET /api/plugins/prometheus-sd/virtual-machines/ Get a list of vms in a prometheus compatible format
GET /api/plugins/prometheus-sd/ip-addresses/ Get a list of ip in a prometheus compatible format
```
### Example
A working example on how to use this plugin with Prometheus is located at the `example` folder. Netbox content is created by using Netbox docker initializers.
The demo data doesn't make sense, but they are good enough for demonstrating how to configure Prometheus and get demo data to Prometheus service discovery.
Go to the `example` folder and run `docker-compose up`. Prometheus should get available on `http://localhost:9090`.
Push some example devices and objects to Netbox using the initializers:
```
docker-compose exec netbox /opt/netbox/netbox/manage.py load_initializer_data --path /opt/netbox/initializers
```
Netbox content should then be available in the service discovery tab.
## Development
We use Poetry for dependency management and invoke as task runner.
As Netbox plugins cannot be tested standalone, we need invoke to start all code embedded in Netbox Docker containers.
All code to run in docker is located under `development`.
To start a virtual env managed by poetry run `poetry shell`.
All following commands are started inside this environment.
In order to run tests invoke the test steps
``` bash
# Execute all tests
invoke tests
# Execute unit tests only
invoke unittest
```
Features should be covered by a unit test, but some times it's easier to develop on an running system.
``` bash
# Start a local Netbox with docker
invoke start
# Create an user named `admin`
invoke create-user
```
Visit http://localhost:8000 and log in with the new user.
You can now define Netbox entities and test around.
API endpoints for testing can be found at http://localhost:8000/api/plugins/prometheus-sd/
%package -n python3-netbox-plugin-prometheus-sd
Summary: A Netbox plugin to provide Netbox entires to Prometheus HTTP service discovery
Provides: python-netbox-plugin-prometheus-sd
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-netbox-plugin-prometheus-sd
# netbox-plugin-prometheus-sd
[](https://opensource.org/licenses/MIT)
[](https://github.com/FlxPeters/netbox-plugin-prometheus-sd/actions?query=workflow%3ACI)
[](https://pypi.org/project/netbox-plugin-prometheus-sd/)
Provide Prometheus http_sd compatible API Endpoint with data from Netbox.
HTTP SD is a new feature in Prometheus 2.28.0 that allows hosts to be found via a URL instead of just files.
This plugin implements API endpoints in Netbox to make devices, IPs and virtual machines available to Prometheus.
## Compatibility
We aim to support the latest major versions of Netbox. For now we Support Netbox `2.11`, `3.0`, `3.1`, `3.2` and `3.3` including bugfix versions.
All relevant target versions are tested in CI. Have a look at the Github Actions definition for the current build targets.
## Installation
The plugin is available as a Python package in pypi and can be installed with pip
pip install netbox-plugin-prometheus-sd
Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:
PLUGINS = ['netbox_prometheus_sd']
The plugin has not further plugin configuration at the moment.
## Usage
The plugin only provides a new API endpoint on the Netbox API. There is no further action required after installation.
### API
The plugin reuses Netbox API view sets with new serializers for Prometheus.
This means that all filters that can be used on the Netbox api can also be used to filter Prometheus targets.
Paging is disabled because Prometheus does not support paged results.
The plugin also reuses the Netbox authentication and permission model.
Depending on the Netbox configuration, a token with valid object permissions must be passed to Netbox.
```
GET /api/plugins/prometheus-sd/devices/ Get a list of devices in a prometheus compatible format
GET /api/plugins/prometheus-sd/virtual-machines/ Get a list of vms in a prometheus compatible format
GET /api/plugins/prometheus-sd/ip-addresses/ Get a list of ip in a prometheus compatible format
```
### Example
A working example on how to use this plugin with Prometheus is located at the `example` folder. Netbox content is created by using Netbox docker initializers.
The demo data doesn't make sense, but they are good enough for demonstrating how to configure Prometheus and get demo data to Prometheus service discovery.
Go to the `example` folder and run `docker-compose up`. Prometheus should get available on `http://localhost:9090`.
Push some example devices and objects to Netbox using the initializers:
```
docker-compose exec netbox /opt/netbox/netbox/manage.py load_initializer_data --path /opt/netbox/initializers
```
Netbox content should then be available in the service discovery tab.
## Development
We use Poetry for dependency management and invoke as task runner.
As Netbox plugins cannot be tested standalone, we need invoke to start all code embedded in Netbox Docker containers.
All code to run in docker is located under `development`.
To start a virtual env managed by poetry run `poetry shell`.
All following commands are started inside this environment.
In order to run tests invoke the test steps
``` bash
# Execute all tests
invoke tests
# Execute unit tests only
invoke unittest
```
Features should be covered by a unit test, but some times it's easier to develop on an running system.
``` bash
# Start a local Netbox with docker
invoke start
# Create an user named `admin`
invoke create-user
```
Visit http://localhost:8000 and log in with the new user.
You can now define Netbox entities and test around.
API endpoints for testing can be found at http://localhost:8000/api/plugins/prometheus-sd/
%package help
Summary: Development documents and examples for netbox-plugin-prometheus-sd
Provides: python3-netbox-plugin-prometheus-sd-doc
%description help
# netbox-plugin-prometheus-sd
[](https://opensource.org/licenses/MIT)
[](https://github.com/FlxPeters/netbox-plugin-prometheus-sd/actions?query=workflow%3ACI)
[](https://pypi.org/project/netbox-plugin-prometheus-sd/)
Provide Prometheus http_sd compatible API Endpoint with data from Netbox.
HTTP SD is a new feature in Prometheus 2.28.0 that allows hosts to be found via a URL instead of just files.
This plugin implements API endpoints in Netbox to make devices, IPs and virtual machines available to Prometheus.
## Compatibility
We aim to support the latest major versions of Netbox. For now we Support Netbox `2.11`, `3.0`, `3.1`, `3.2` and `3.3` including bugfix versions.
All relevant target versions are tested in CI. Have a look at the Github Actions definition for the current build targets.
## Installation
The plugin is available as a Python package in pypi and can be installed with pip
pip install netbox-plugin-prometheus-sd
Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:
PLUGINS = ['netbox_prometheus_sd']
The plugin has not further plugin configuration at the moment.
## Usage
The plugin only provides a new API endpoint on the Netbox API. There is no further action required after installation.
### API
The plugin reuses Netbox API view sets with new serializers for Prometheus.
This means that all filters that can be used on the Netbox api can also be used to filter Prometheus targets.
Paging is disabled because Prometheus does not support paged results.
The plugin also reuses the Netbox authentication and permission model.
Depending on the Netbox configuration, a token with valid object permissions must be passed to Netbox.
```
GET /api/plugins/prometheus-sd/devices/ Get a list of devices in a prometheus compatible format
GET /api/plugins/prometheus-sd/virtual-machines/ Get a list of vms in a prometheus compatible format
GET /api/plugins/prometheus-sd/ip-addresses/ Get a list of ip in a prometheus compatible format
```
### Example
A working example on how to use this plugin with Prometheus is located at the `example` folder. Netbox content is created by using Netbox docker initializers.
The demo data doesn't make sense, but they are good enough for demonstrating how to configure Prometheus and get demo data to Prometheus service discovery.
Go to the `example` folder and run `docker-compose up`. Prometheus should get available on `http://localhost:9090`.
Push some example devices and objects to Netbox using the initializers:
```
docker-compose exec netbox /opt/netbox/netbox/manage.py load_initializer_data --path /opt/netbox/initializers
```
Netbox content should then be available in the service discovery tab.
## Development
We use Poetry for dependency management and invoke as task runner.
As Netbox plugins cannot be tested standalone, we need invoke to start all code embedded in Netbox Docker containers.
All code to run in docker is located under `development`.
To start a virtual env managed by poetry run `poetry shell`.
All following commands are started inside this environment.
In order to run tests invoke the test steps
``` bash
# Execute all tests
invoke tests
# Execute unit tests only
invoke unittest
```
Features should be covered by a unit test, but some times it's easier to develop on an running system.
``` bash
# Start a local Netbox with docker
invoke start
# Create an user named `admin`
invoke create-user
```
Visit http://localhost:8000 and log in with the new user.
You can now define Netbox entities and test around.
API endpoints for testing can be found at http://localhost:8000/api/plugins/prometheus-sd/
%prep
%autosetup -n netbox_plugin_prometheus_sd-0.6.3
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-netbox-plugin-prometheus-sd -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 0.6.3-1
- Package Spec generated
|
