0
0
mirror of https://github.com/netdata/netdata.git synced 2024-12-04 12:57:29 +00:00
netdata_netdata/integrations/schemas/categories.json
Austin S. Hemmelgarn 183bb1db19
Add initial tooling for generating integrations.js file. (#15406)
* Fix link tags in deploy.

* Add initial tooling for generating integrations.js file.

* Skip integrations directory for eslint.

* Add README to explain how to generate integrations.js locally.

* Fix ID/name for top-level categories.

* Deduplicate categories entries.

* Properly render related resources information.

* Warn on and skip bad references for related resources.

* Add CI workflow to rebuild integrations as-needed.

* Add integrations.js to build artifacts.

* Fix actionlint complaints.

* Assorted template fixes.

* Add script to check collector metadata.

* Add default categories for collectors when they have no categories.

* Fix template formatting issues.

* Link related resources properly.

* Skip more sections in rendered output if they are not present in source data.

* Temporarily skip config syntax section.

It needs further work and is not critical at the moment.

* Fix metrics table rendering.

* Hide most overview content if method_description is empty.

* Fix metrics table rendering (again).

* Add detailed description to setup options section.

* Fix detailed description handling for config options.

* Fix config example folding logic.

* Fix multi-instance selection.

* Properly fix multi-instance selection.

* Add titles for labels and metrics charts.

* Include monitored instance name in integration ID.

This is required to disambiguate some ‘virtual’ integrations.

* Indicate if there are no alerts defined for an integration.

* Fix multi-instance in template.

* Improve warning handling in script and fix category handling.

* Hide debug messages by default.

* Fix invalid category name in cgroups plugin.

* Completely fix invalid categories in cgroups plugin.

* Warn about and ignore duplicate integration ids.

* Flag integration type in integrations list.

* Add configuration syntax samples.

* Fix issues in gen_integrations.py

* Validate categories.yaml on load.

* Add support for handling deployment information.

* Fix bugs in gen_integrations.py

* Add code to handle exporters.

* Add link to integrations pointing to their source files.

* Fix table justification.

* Add notification handling to script.

Also tidy up a few other things.

* Fix numerous bugs in gen_integrations.py

* remove trailing space from deploy.yaml command

* make availability one column

* Switch back to multiple columns for availability.

And also switch form +/- to a dot for positive and empty cell for
negative.

* Render setup description.

* Fix platform info rendering in deploy integrations.

* Fix sourcing of cloud-notifications metadata.

* Fix rendering of empty metrics.

* Fix alerts template.

* Add per-instance templating for templated keys.

* Fix go plugin links.

* Fix overview template.

* Fix handling of exporters.

* Fix loading of cloud notification integrations.

* Always show full collector overview.

* Add static troubleshooting content when appropriate.

* Assorted deploy integration updates.

* Add initial copy of integrations.js.

---------

Co-authored-by: Fotis Voutsas <fotis@netdata.cloud>
2023-08-01 17:23:16 -04:00

56 lines
1.5 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "array",
"title": "Category information for integrations.",
"items": {
"$ref": "#/$defs/category"
},
"$defs": {
"category": {
"type": "object",
"description": "An entry for a single category.",
"properties": {
"id": {
"$ref": "./shared.json#/$defs/id"
},
"name": {
"type": "string",
"minLength": 1,
"description": "The display name for the category."
},
"description": {
"type": "string",
"description": "A description of the category."
},
"most_popular": {
"type": "boolean",
"description": "Indicates if the category should show up in the initial list of categories, or only in the full expanded list."
},
"priority": {
"type": "integer",
"description": "Indicates sort order for categories that are marked as most popular."
},
"collector_default": {
"type": "boolean",
"description": "Indicates that the category should be added to collector integrations that list no categories."
},
"children": {
"type": "array",
"description": "A list of categories that are children of this category.",
"items": {
"$ref": "#/$defs/category"
}
}
},
"required": [
"id",
"name",
"description",
"most_popular",
"priority",
"children"
]
}
}
}