netdata-cloud icon indicating copy to clipboard operation
netdata-cloud copied to clipboard

[Feat]: ability to add and maintain node descriptions

Open andrewm4894 opened this issue 2 years ago • 2 comments

Problem

Often I would like to have a description of some sort about the node.

So that I can easily remember or explain to other team members what "stuff" in some sense is on this node or what it represents in human language.

Description

Additional node description metadata I can store and edit from the UI and perhaps even when claiming programmatically.

Importance

nice to have

Value proposition

  1. Easier understanding of what each node is if the name is not that obvious.

Proposed implementation

No response

andrewm4894 avatar Jun 13 '23 19:06 andrewm4894

This seems to be mostly covered by host labels. Example netdata.conf:

# …
[host labels]
    description = ralphm's laptop

image

A few notes:

  • Even though netdatacli reload-labels reloads the labels on the agent, the UI doesn't pick up this change. I had to restart the Agent to invalidate the cache.
  • The description gets mangled by replacing certain characters like the apostrophe (').

ralphm avatar Jun 14 '23 08:06 ralphm

Was thinking host labels could be part of it.

Was also thinking similar to how we let users add a space description in the app.

But I guess host labels could work.

Maybe just ability to expose them in nodes view and a few things like that would help.

andrewm4894 avatar Jun 14 '23 09:06 andrewm4894