netbox-plugin-prometheus-http-sd 0.1.0__tar.gz

netbox_plugin_prometheus_http_sd-0.1.0/.dockerignore

@@ -0,0 +1,8 @@
+# VCS
+.git/
+.gitignore
+.gitattributes
+
+# Docker
+.dockerignore
+docker-compose.yml

netbox_plugin_prometheus_http_sd-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: Publish on PyPi
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  publish:
+    name: Publish on PyPi
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine setuptools_scm
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

netbox_plugin_prometheus_http_sd-0.1.0/.gitignore

@@ -0,0 +1,19 @@
+# Python
+.venv
+__pycache__/
+*.py[cod]
+*.egg-info/
+*.egg
+dist/
+build/
+*.whl
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# setuptools
+netbox_prometheus_sd/_version.py

netbox_plugin_prometheus_http_sd-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

netbox_plugin_prometheus_http_sd-0.1.0/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: netbox-plugin-prometheus-http-sd
+Version: 0.1.0
+Summary: A Netbox plugin to export targets for Prometheus HTTP service discovery
+Author-email: Artem Tuchinsky <tuchinsky@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/tuchinsky/netbox-plugin-prometheus-http-sd
+Keywords: netbox,prometheus
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# netbox-plugin-prometheus-http-sd
+
+## Demo
+
+```bash
+docker-compose up -d
+
+docker exec netbox-plugin-prometheus-http-sd-netbox-1 /opt/netbox/netbox/manage.py load_initializer_data --path /etc/netbox/initializer-data
+```
+
+Login into Netbox (http://localhost:8080) and create **Config Context** named `prometheus_role_map` with the following JSON structure:
+```json
+{
+    "prometheus_exporters": {
+        "default": [
+            {
+                "job": "node-exporter",
+                "port": 9100
+            }
+        ],
+        "etcd": [
+            {
+                "job": "node-exporter",
+                "port": 9100
+            },
+            {
+                "job": "etcd-exporter",
+                "port": 2379
+            }
+        ],
+        "postgresql": [
+            {
+                "job": "node-exporter",
+                "port": 9100
+            },
+            {
+                "job": "postgresql-exporter",
+                "port": 9187
+            }
+        ],
+        "vault": [
+            {
+                "job": "vault-exporter",
+                "scheme": "https",
+                "metrics_path": "/v1/sys/metrics",
+                "params": {
+                    "format": [
+                        "prometheus"
+                    ]
+                },
+                "port": 8200
+            }
+        ]
+    }
+}
+```
+Each role can have multiple jobs (one target per job is generated)
+
+If role is not found, the `default` entry is used
+
+## Usage
+
+The plugin exposes a single API endpoint (no web UI):
+```
+GET /api/plugins/prometheus-sd/targets/
+```
+
+Device or Virtual Machine is included only if all of the following are true:
+1. It has status `active`
+2. The custom field `role` is present and non‑empty
+
+## Metrics labels
+
+Labels:
+* `job` – Prometheus job name defined in the mapping
+* `__meta_netbox_name` – object name
+* `__meta_netbox_type` – `device` or `vm`
+* `__meta_netbox_cf_<custom_field>` – every custom field prefixed with `__meta_netbox_cf_`

netbox_plugin_prometheus_http_sd-0.1.0/README.md

@@ -0,0 +1,78 @@
+# netbox-plugin-prometheus-http-sd
+
+## Demo
+
+```bash
+docker-compose up -d
+
+docker exec netbox-plugin-prometheus-http-sd-netbox-1 /opt/netbox/netbox/manage.py load_initializer_data --path /etc/netbox/initializer-data
+```
+
+Login into Netbox (http://localhost:8080) and create **Config Context** named `prometheus_role_map` with the following JSON structure:
+```json
+{
+    "prometheus_exporters": {
+        "default": [
+            {
+                "job": "node-exporter",
+                "port": 9100
+            }
+        ],
+        "etcd": [
+            {
+                "job": "node-exporter",
+                "port": 9100
+            },
+            {
+                "job": "etcd-exporter",
+                "port": 2379
+            }
+        ],
+        "postgresql": [
+            {
+                "job": "node-exporter",
+                "port": 9100
+            },
+            {
+                "job": "postgresql-exporter",
+                "port": 9187
+            }
+        ],
+        "vault": [
+            {
+                "job": "vault-exporter",
+                "scheme": "https",
+                "metrics_path": "/v1/sys/metrics",
+                "params": {
+                    "format": [
+                        "prometheus"
+                    ]
+                },
+                "port": 8200
+            }
+        ]
+    }
+}
+```
+Each role can have multiple jobs (one target per job is generated)
+
+If role is not found, the `default` entry is used
+
+## Usage
+
+The plugin exposes a single API endpoint (no web UI):
+```
+GET /api/plugins/prometheus-sd/targets/
+```
+
+Device or Virtual Machine is included only if all of the following are true:
+1. It has status `active`
+2. The custom field `role` is present and non‑empty
+
+## Metrics labels
+
+Labels:
+* `job` – Prometheus job name defined in the mapping
+* `__meta_netbox_name` – object name
+* `__meta_netbox_type` – `device` or `vm`
+* `__meta_netbox_cf_<custom_field>` – every custom field prefixed with `__meta_netbox_cf_`

netbox_plugin_prometheus_http_sd-0.1.0/docker-compose.yml

@@ -0,0 +1,84 @@
+services:
+  netbox:
+    image: netboxcommunity/netbox:${VERSION-v4.5-4.0.2}
+    user: "root:root" # only for pip
+    environment:
+      CORS_ORIGIN_ALLOW_ALL: True
+      DB_HOST: postgres
+      DB_NAME: netbox
+      DB_PASSWORD: netbox
+      DB_USER: netbox
+      DEBUG: 1
+      DB_WAIT_DEBUG: 1
+      HOUSEKEEPING_INTERVAL: 86400
+      MEDIA_ROOT: /opt/netbox/netbox/media
+      METRICS_ENABLED: true
+      WEBHOOKS_ENABLED: true
+      REDIS_CACHE_DATABASE: 1
+      REDIS_CACHE_HOST: redis
+      REDIS_CACHE_SSL: false
+      REDIS_DATABASE: 0
+      REDIS_HOST: redis
+      REDIS_SSL: false
+      RELEASE_CHECK_URL: https://api.github.com/repos/netbox-community/netbox/releases
+      SECRET_KEY: 'r(m)9nLGnz$(_q3N4z1k(EFsMCjjjzx08x9VhNVcfd%6RF#r!6DE@+V5Zk2X'
+      SKIP_STARTUP_SCRIPTS: false
+      SKIP_SUPERUSER: false
+      SUPERUSER_API_TOKEN: 0123456789abcdef0123456789abcdef01234567
+      SUPERUSER_EMAIL: admin@example.com
+      SUPERUSER_NAME: admin
+      SUPERUSER_PASSWORD: admin
+    command: >
+      sh -c "/usr/local/bin/uv pip install netbox-initializers==4.5.1 &&
+             uv pip install -e /opt/netbox/netbox/netbox_prometheus_sd &&
+             /opt/netbox/docker-entrypoint.sh /opt/netbox/launch-netbox.sh"
+    volumes:
+      - ./example/configuration/plugins.py:/etc/netbox/config/plugins.py:z,ro
+      - ./example/initializers:/etc/netbox/initializer-data:z,ro
+      - ./netbox_prometheus_sd:/opt/netbox/netbox/netbox_prometheus_sd
+    ports:
+      - "8080:8080"
+    healthcheck:
+      test: curl -f http://localhost:8080/login/ || exit 1
+      start_period: 20s
+      timeout: 5s
+      interval: 10s
+      retries: 5
+    depends_on:
+      postgres:
+        condition: service_healthy
+      redis:
+        condition: service_started
+
+  postgres:
+    image: postgres:15-alpine
+    environment:
+      POSTGRES_DB: netbox
+      POSTGRES_PASSWORD: netbox
+      POSTGRES_USER: netbox
+    volumes:
+      - netbox-postgres-data:/var/lib/postgresql/data
+    healthcheck:
+      test: pg_isready -q -t 2 -d $$POSTGRES_DB -U $$POSTGRES_USER
+      start_period: 20s
+      timeout: 30s
+      interval: 10s
+      retries: 5
+
+  redis:
+    image: redis:7-alpine
+
+  prometheus:
+    image: prom/prometheus:v3.11.3
+    volumes:
+      - ./example/prometheus.yml:/etc/prometheus/prometheus.yml:ro,z
+    command:
+      - "--config.file=/etc/prometheus/prometheus.yml"
+    ports:
+      - 9090:9090
+    depends_on:
+      netbox:
+        condition: service_started
+
+volumes:
+  netbox-postgres-data:

netbox_plugin_prometheus_http_sd-0.1.0/example/configuration/plugins.py

@@ -0,0 +1 @@
+PLUGINS = ["netbox_initializers", "netbox_prometheus_sd"]

netbox_plugin_prometheus_http_sd-0.1.0/example/initializers/cluster_types.yml

@@ -0,0 +1,2 @@
+- name: Proxmox
+  slug: proxmox

netbox_plugin_prometheus_http_sd-0.1.0/example/initializers/clusters.yml

@@ -0,0 +1,2 @@
+- name: Default
+  type: Proxmox

netbox_plugin_prometheus_http_sd-0.1.0/example/initializers/custom_fields.yml

@@ -0,0 +1,8 @@
+service:
+  type: string
+  weight: 100
+  on_objects: ["dcim.models.Device", "virtualization.models.VirtualMachine"]
+role:
+  type: string
+  weight: 101
+  on_objects: ["dcim.models.Device", "virtualization.models.VirtualMachine"]

netbox_plugin_prometheus_http_sd-0.1.0/example/initializers/device_roles.yml

@@ -0,0 +1,3 @@
+- name: Server
+  slug: server
+  color: Grey

netbox_plugin_prometheus_http_sd-0.1.0/example/initializers/device_types.yml

@@ -0,0 +1,3 @@
+- model: Default
+  manufacturer: No Name
+  slug: default

netbox_plugin_prometheus_http_sd-0.1.0/example/initializers/devices.yml

@@ -0,0 +1,27 @@
+- name: Server01
+  role: Server
+  device_type: Default
+  site: Default
+  primary_ip4: 192.168.1.1/24
+  status: active
+  custom_field_data:
+    service: proxmox
+    role: pve
+- name: Server02
+  role: Server
+  device_type: Default
+  site: Default
+  primary_ip4: 192.168.1.2/24
+  status: staged
+  custom_field_data:
+    service: proxmox
+    role: pve
+- name: Server03
+  role: Server
+  device_type: Default
+  site: Default
+  primary_ip4: 192.168.1.3/24
+  status: offline
+  custom_field_data:
+    service: proxmox
+    role: pve

netbox_plugin_prometheus_http_sd-0.1.0/example/initializers/interfaces.yml

@@ -0,0 +1,12 @@
+- device: Server01
+  enabled: true
+  type: 1000base-t
+  name: eth0
+- device: Server02
+  enabled: true
+  type: 1000base-t
+  name: eth0
+- device: Server03
+  enabled: true
+  type: 1000base-t
+  name: eth0

netbox_plugin_prometheus_http_sd-0.1.0/example/initializers/ip_addresses.yml

@@ -0,0 +1,24 @@
+- address: 192.168.1.1/24
+  device: Server01
+  interface: eth0
+  status: active
+- address: 192.168.1.2/24
+  device: Server02
+  interface: eth0
+  status: active
+- address: 192.168.1.3/24
+  device: Server03
+  interface: eth0
+  status: active
+- address: 192.168.1.4/24
+  virtual_machine: VM01
+  interface: eth0
+  status: active
+- address: 192.168.1.5/24
+  virtual_machine: VM02
+  interface: eth0
+  status: active
+- address: 192.168.1.6/24
+  virtual_machine: VM02
+  interface: eth0
+  status: active

netbox_plugin_prometheus_http_sd-0.1.0/example/initializers/manufacturers.yml

@@ -0,0 +1,2 @@
+- name: No Name
+  slug: no-name

netbox_plugin_prometheus_http_sd-0.1.0/example/initializers/sites.yml

@@ -0,0 +1,4 @@
+- name: Default
+  slug: default
+  status: active
+  tenant: Default

netbox_plugin_prometheus_http_sd-0.1.0/example/initializers/tenants.yml

@@ -0,0 +1,2 @@
+- name: Default
+  slug: default

netbox_plugin_prometheus_http_sd-0.1.0/example/initializers/virtual_machines.yml

@@ -0,0 +1,33 @@
+- name: VM01
+  cluster: Default
+  vcpus: 2
+  memory: 4096
+  disk: 100
+  primary_ip4: 192.168.1.4/24
+  status: active
+  tenant: Default
+  custom_field_data:
+    service: billing-postgresql
+    role: postgresql
+- name: VM02
+  cluster: Default
+  vcpus: 4
+  memory: 8192
+  disk: 200
+  primary_ip4: 192.168.1.5/24
+  status: active
+  tenant: Default
+  custom_field_data:
+    service: billing-postgresql
+    role: etcd
+- name: VM03
+  cluster: Default
+  vcpus: 8
+  memory: 16384
+  disk: 300
+  primary_ip4: 192.168.1.6/24
+  status: active
+  tenant: Default
+  custom_field_data:
+    service: vault
+    role: vault

netbox_plugin_prometheus_http_sd-0.1.0/example/initializers/virtualization_interfaces.yml

@@ -0,0 +1,9 @@
+- virtual_machine: VM01
+  name: eth0
+  enabled: true
+- virtual_machine: VM02
+  name: eth0
+  enabled: true
+- virtual_machine: VM03
+  name: eth0
+  enabled: true

netbox_plugin_prometheus_http_sd-0.1.0/example/prometheus.yml

@@ -0,0 +1,17 @@
+global:
+  scrape_interval: 15s
+  evaluation_interval: 15s
+
+scrape_configs:
+  - job_name: "prometheus"
+    scrape_interval: 5s
+    static_configs:
+      - targets: ["localhost:9090"]
+
+  - job_name: "netbox-sd"
+    http_sd_configs:
+      - url: http://netbox:8080/api/plugins/prometheus-sd/targets/
+        refresh_interval: 15s
+    relabel_configs:
+      - source_labels: [__meta_netbox_name]
+        target_label: instance

netbox_plugin_prometheus_http_sd-0.1.0/netbox_plugin_prometheus_http_sd.egg-info/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: netbox-plugin-prometheus-http-sd
+Version: 0.1.0
+Summary: A Netbox plugin to export targets for Prometheus HTTP service discovery
+Author-email: Artem Tuchinsky <tuchinsky@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/tuchinsky/netbox-plugin-prometheus-http-sd
+Keywords: netbox,prometheus
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# netbox-plugin-prometheus-http-sd
+
+## Demo
+
+```bash
+docker-compose up -d
+
+docker exec netbox-plugin-prometheus-http-sd-netbox-1 /opt/netbox/netbox/manage.py load_initializer_data --path /etc/netbox/initializer-data
+```
+
+Login into Netbox (http://localhost:8080) and create **Config Context** named `prometheus_role_map` with the following JSON structure:
+```json
+{
+    "prometheus_exporters": {
+        "default": [
+            {
+                "job": "node-exporter",
+                "port": 9100
+            }
+        ],
+        "etcd": [
+            {
+                "job": "node-exporter",
+                "port": 9100
+            },
+            {
+                "job": "etcd-exporter",
+                "port": 2379
+            }
+        ],
+        "postgresql": [
+            {
+                "job": "node-exporter",
+                "port": 9100
+            },
+            {
+                "job": "postgresql-exporter",
+                "port": 9187
+            }
+        ],
+        "vault": [
+            {
+                "job": "vault-exporter",
+                "scheme": "https",
+                "metrics_path": "/v1/sys/metrics",
+                "params": {
+                    "format": [
+                        "prometheus"
+                    ]
+                },
+                "port": 8200
+            }
+        ]
+    }
+}
+```
+Each role can have multiple jobs (one target per job is generated)
+
+If role is not found, the `default` entry is used
+
+## Usage
+
+The plugin exposes a single API endpoint (no web UI):
+```
+GET /api/plugins/prometheus-sd/targets/
+```
+
+Device or Virtual Machine is included only if all of the following are true:
+1. It has status `active`
+2. The custom field `role` is present and non‑empty
+
+## Metrics labels
+
+Labels:
+* `job` – Prometheus job name defined in the mapping
+* `__meta_netbox_name` – object name
+* `__meta_netbox_type` – `device` or `vm`
+* `__meta_netbox_cf_<custom_field>` – every custom field prefixed with `__meta_netbox_cf_`

netbox_plugin_prometheus_http_sd-0.1.0/netbox_plugin_prometheus_http_sd.egg-info/SOURCES.txt

@@ -0,0 +1,32 @@
+.dockerignore
+.gitignore
+LICENSE
+README.md
+docker-compose.yml
+pyproject.toml
+.github/workflows/publish.yml
+example/prometheus.yml
+example/configuration/plugins.py
+example/initializers/cluster_types.yml
+example/initializers/clusters.yml
+example/initializers/custom_fields.yml
+example/initializers/device_roles.yml
+example/initializers/device_types.yml
+example/initializers/devices.yml
+example/initializers/interfaces.yml
+example/initializers/ip_addresses.yml
+example/initializers/manufacturers.yml
+example/initializers/sites.yml
+example/initializers/tenants.yml
+example/initializers/virtual_machines.yml
+example/initializers/virtualization_interfaces.yml
+netbox_plugin_prometheus_http_sd.egg-info/PKG-INFO
+netbox_plugin_prometheus_http_sd.egg-info/SOURCES.txt
+netbox_plugin_prometheus_http_sd.egg-info/dependency_links.txt
+netbox_plugin_prometheus_http_sd.egg-info/top_level.txt
+netbox_prometheus_sd/__init__.py
+netbox_prometheus_sd/_version.py
+netbox_prometheus_sd/urls.py
+netbox_prometheus_sd/api/__init__.py
+netbox_prometheus_sd/api/urls.py
+netbox_prometheus_sd/api/views.py

netbox_plugin_prometheus_http_sd-0.1.0/netbox_plugin_prometheus_http_sd.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

netbox_plugin_prometheus_http_sd-0.1.0/netbox_plugin_prometheus_http_sd.egg-info/top_level.txt

@@ -0,0 +1 @@
+netbox_prometheus_sd

netbox_plugin_prometheus_http_sd-0.1.0/netbox_prometheus_sd/__init__.py

@@ -0,0 +1,15 @@
+from netbox.plugins import PluginConfig
+
+try:
+    from ._version import version as __version__
+except ImportError:
+    __version__ = "0.0.0.dev0"
+
+class NetBoxPrometheusSDConfig(PluginConfig):
+    name = 'netbox_prometheus_sd'
+    verbose_name = 'NetBox Prometheus SD'
+    description = 'A Netbox plugin to export targets for Prometheus HTTP service discovery'
+    version = __version__
+    base_url = 'prometheus-sd'
+
+config = NetBoxPrometheusSDConfig

netbox_plugin_prometheus_http_sd-0.1.0/netbox_prometheus_sd/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)
+
+__commit_id__ = commit_id = 'gffa0468d8'

netbox_plugin_prometheus_http_sd-0.1.0/netbox_prometheus_sd/api/urls.py

@@ -0,0 +1,6 @@
+from django.urls import path
+from . import views
+
+urlpatterns = [
+    path('targets/', views.PrometheusTargetsView.as_view(), name='prometheus-target-list'),
+]

netbox_plugin_prometheus_http_sd-0.1.0/netbox_prometheus_sd/api/views.py

@@ -0,0 +1,101 @@
+from rest_framework.views import APIView
+from rest_framework.response import Response
+from dcim.models import Device
+from virtualization.models import VirtualMachine
+from extras.models import ConfigContext
+
+# 'ip' or 'dns'
+TARGET_SOURCE = 'ip'
+
+class PrometheusTargetsView(APIView):
+    permission_classes = []
+
+    def get(self, request, format=None):
+        mapping = self._get_prometheus_mapping()
+        targets = []
+
+        for device in Device.objects.filter(status='active'):
+            if not device.custom_field_data or 'role' not in device.custom_field_data:
+                continue
+
+            ip = device.primary_ip4 or device.primary_ip6
+            if TARGET_SOURCE == 'ip' and not ip:
+                continue
+
+            self._add_targets(
+                targets, ip, device.name, 'device', mapping,
+                device.custom_field_data
+            )
+
+        for vm in VirtualMachine.objects.filter(status='active'):
+            if not vm.custom_field_data or 'role' not in vm.custom_field_data:
+                continue
+
+            ip = vm.primary_ip4 or vm.primary_ip6
+            if TARGET_SOURCE == 'ip' and not ip:
+                continue
+
+            self._add_targets(
+                targets, ip, vm.name, 'vm', mapping,
+                vm.custom_field_data
+            )
+
+        return Response(targets)
+
+    def _get_prometheus_mapping(self):
+        context = ConfigContext.objects.filter(name='prometheus_role_map').first()
+        if context and context.data:
+            return context.data.get('prometheus_exporters', {})
+        return {
+            'default': [{'job': 'node-exporter', 'port': 9100}]
+        }
+
+    def _add_targets(self, targets, ip, name, obj_type, mapping, cf_data):
+        role = cf_data['role']
+        exporters = mapping.get(role, mapping.get('default', []))
+
+        for exporter in exporters:
+            job = exporter['job']
+            port = exporter['port']
+            scheme = exporter.get('scheme', 'http')
+            metrics_path = exporter.get('metrics_path', '/metrics')
+            params = exporter.get('params', {})
+
+            if TARGET_SOURCE == 'dns':
+                address = name
+            elif TARGET_SOURCE == 'ip':
+                address = str(ip.address.ip)
+            else:
+                raise ValueError(
+                    f"Incorrect value TARGET_SOURCE: '{TARGET_SOURCE}'. "
+                    "Acceptable values: 'ip', 'dns'."
+                )
+
+            # default labels
+            labels = {
+                "job": job,
+                "__meta_netbox_name": name,
+                "__meta_netbox_type": obj_type,
+            }
+
+            # change scheme if it not default (http)
+            if scheme != 'http':
+                labels['__scheme__'] = scheme
+
+            # change metrics path if it not default (/metrics)
+            if metrics_path != '/metrics':
+                labels['__metrics_path__'] = metrics_path
+
+            # params to scrape request
+            for param_name, param_values in params.items():
+                if param_values:
+                    labels[f'__param_{param_name}'] = param_values[0]
+
+            # add all custom fields as labels with prefix '__meta_netbox_cf_'
+            for cf_key, cf_value in cf_data.items():
+                labels[f"__meta_netbox_cf_{cf_key}"] = str(cf_value)
+
+            targets.append({
+                "targets": [f"{address}:{port}"],
+                "labels": labels
+            })

netbox_plugin_prometheus_http_sd-0.1.0/netbox_prometheus_sd/urls.py

@@ -0,0 +1 @@
+urlpatterns = []

netbox_plugin_prometheus_http_sd-0.1.0/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "netbox-plugin-prometheus-http-sd"
+dynamic = ["version"]
+description = "A Netbox plugin to export targets for Prometheus HTTP service discovery"
+readme = "README.md"
+license = "Apache-2.0"
+authors = [{ name = "Artem Tuchinsky", email = "tuchinsky@gmail.com" }]
+keywords = ["netbox", "prometheus"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+]
+requires-python = ">=3.8"
+dependencies = []
+
+[project.urls]
+Repository = "https://github.com/tuchinsky/netbox-plugin-prometheus-http-sd"
+
+[build-system]
+requires = ["setuptools>=61", "wheel", "setuptools-scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+version_file = "netbox_prometheus_sd/_version.py"
+local_scheme = "no-local-version"

netbox_plugin_prometheus_http_sd-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+