To generate a copy of integrations.js and validate collector taxonomy 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, run the documentation generators from the Agent repo root:

• integrations/gen_integrations.py
• integrations/gen_taxonomy.py --check-only
• integrations/check_collector_taxonomy.py
• integrations/gen_docs_integrations.py
• integrations/gen_doc_collector_page.py
• integrations/gen_doc_secrets_page.py

These scripts must be run from this specific location, as they use their own path to figure out where all the files they need are.

Collector dashboard taxonomy is authored in sibling taxonomy.yaml files next to collector metadata.yaml files. Static collectors use ordered items: trees; a plain context string in items: owns that chart context and normalizes to type: owned_context. Display widgets use type: context with contexts: and chart_library, and every referenced literal context must be owned somewhere in the structural tree. Dynamic collectors use type: selector with context_prefix: or collect_plugin: and must opt in from metadata.yaml with metrics.dynamic_context_prefixes: or metrics.dynamic_collect_plugins:; a taxonomy context_prefix: may narrow a declared metadata namespace. The generated integrations/taxonomy.json artifact is gitignored like integrations/integrations.js.

To seed a static collector taxonomy from existing metadata contexts:

python3 integrations/gen_taxonomy_seed.py src/go/plugin/go.d/collector/apache/metadata.yaml --module-name apache --section-id applications.apache --placement-id apache --icon apache

Pull requests run integrations/check_collector_taxonomy.py from .github/workflows/check-markdown.yml. The gate validates committed taxonomy files and fails when a collector metadata.yaml metrics block or taxonomy.yaml changes without matching taxonomy coverage.