0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-05-13 05:02:03 +00:00
netdata_netdata/integrations/templates/setup/sample-apps-config.md
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

41 lines
1.8 KiB
Markdown

A custom format is used.
Each configuration line has a form like:
```
group_name: app1 app2 app3
```
Where `group_name` defines an application group, and `app1`, `app2`, and `app3` are process names to match for
that application group.
Each group can be given multiple times, to add more processes to it.
The process names are the ones returned by:
- `ps -e` or `/proc/PID/stat`
- in case of substring mode (see below): `/proc/PID/cmdline`
To add process names with spaces, enclose them in quotes (single or double):
`'Plex Media Serv' "my other process"`
Note that spaces are not supported for process groups. Use a dash "-" instead.
You can add an asterisk (\*) at the beginning and/or the end of a process to do wildcard matching:
- `*name` suffix mode: will search for processes ending with 'name' (/proc/PID/stat)
- `name*` prefix mode: will search for processes beginning with 'name' (/proc/PID/stat)
- `*name*` substring mode: will search for 'name' in the whole command line (/proc/PID/cmdline)
If you enter even just one `*name*` (substring), apps.plugin will process /proc/PID/cmdline for all processes,
just once (when they are first seen).
To add processes with single quotes, enclose them in double quotes: "process with this ' single quote"
To add processes with double quotes, enclose them in single quotes: 'process with this " double quote'
The order of the entries in this list is important, the first that matches a process is used, so put important
ones at the top. Processes not matched by any row, will inherit it from their parents or children.
The order also controls the order of the dimensions on the generated charts (although applications started after
apps.plugin is started, will be appended to the existing list of dimensions the netdata daemon maintains).