archive/netdata_netdata
0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-04-10 16:17:36 +00:00
Code Issues Projects Releases Wiki Activity
netdata_netdata/integrations
History
Austin S. Hemmelgarn 8934a18ce4
Add integrations JSON file for website usage. () 
* Add generation of JSON integrations data.

* Clean up generated data for JSON file.

* Properly clean up deploy entry info.

* Fix argument order for regex substitutions.
2023-10-18 11:30:30 -04:00
..
cloud-notifications Regenerate integrations.js () 2023-10-13 13:08:16 +03:00
schemas Add integrations JSON file for website usage. () 2023-10-18 11:30:30 -04:00
templates Add integrations JSON file for website usage. () 2023-10-18 11:30:30 -04:00
categories.yaml Update categories.yaml () 2023-10-03 13:13:48 +03:00
check_collector_metadata.py Add initial tooling for generating integrations.js file. () 2023-08-01 17:23:16 -04:00
deploy.yaml Add integrations JSON file for website usage. () 2023-10-18 11:30:30 -04:00
gen_doc_collector_page.py Make collectors/COLLECTORS.md have its list autogenerated from integrations.js () 2023-09-28 10:33:40 +03:00
gen_docs_integrations.py Add icons to integrations markdown files () 2023-10-13 10:07:55 +03:00
gen_integrations.py Add integrations JSON file for website usage. () 2023-10-18 11:30:30 -04:00
integrations.js Regenerate integrations.js () 2023-10-15 16:25:13 +03:00
README.md Add initial tooling for generating integrations.js file. () 2023-08-01 17:23:16 -04:00

README.md

To generate a copy of integrations.js locally, you will need:

  • Python 3.6 or newer (only tested on Python 3.10 currently, should work on any version of Python newer than 3.6).
  • The following third-party Python modules:
    • jsonschema
    • referencing
    • jinja2
    • ruamel.yaml
  • A local checkout of https://github.com/netdata/netdata
  • A local checkout of https://github.com/netdata/go.d.plugin. The script expects this to be checked out in a directory called go.d.plugin in the root directory of the agent repo, though a symlink with that name pointing at the actual location of the repo will work as well.

The first two parts can be easily covered in a Linux environment, such as a VM or Docker container:

  • On Debian or Ubuntu: apt-get install python3-jsonschema python3-referencing python3-jinja2 python3-ruamel.yaml
  • On Alpine: apk add py3-jsonschema py3-referencing py3-jinja2 py3-ruamel.yaml
  • On Fedora or RHEL (EPEL is required on RHEL systems): dnf install python3-jsonschema python3-referencing python3-jinja2 python3-ruamel-yaml

Once the environment is set up, simply run integrations/gen_integrations.py from the agent repo. Note that the script must be run from this specific location, as it uses it’s own path to figure out where all the files it needs are.