netdata / netdata-cloud

The public repository of Netdata Cloud. Contribute with bug reports and feature requests.
GNU General Public License v3.0
41 stars 16 forks source link

[Feat]: ability to deep link to specific node by hostname #404

Open bojdell opened 2 years ago

bojdell commented 2 years ago

Problem

(edit: changed title from "[Feat]: export node data (including UUIDs)" as this seemed too solution specific)

Problem: I would like to deep link from another internal application to specific nodes in netdata. However, I can't find a way to map from Netdata's node UUIDs to an internal ID or hostname.

Description

I would like to either be able to deep link to a specific node in Netdata Cloud by passing in the hostname in the URL/as a query param.

Another potential solution is to access via an API/URL or download a CSV of nodes including netdata UUIDs and other metadata such as hostname so I can sync that with internal applications for purposes of deep linking into netdata.

Importance

really want

Value proposition

  1. Enables users to better customize their netdata workflows and integrate with business context
  2. Better bulk management/understanding of cloud nodes

Proposed implementation

A v1 of this could look like:

GET https://app.netdata.cloud/spaces/<space_name>/rooms/<room_name>/nodes?hostname=<hostname>

For the node list solution I imagine an easy v1 of this is an HTTP endpoint like so that returns a list of nodes in the space. Pagination can be added for large spaces or simply short circuit for initial prototype.

GET https://app.netdata.cloud/spaces/<space_name>/rooms/<room_name>/nodes
[{
  // required for this use case
  "id": <netdata_uuid>,
  "hostname": <hostname>,

  // potential other fields
  "claimed_at": <claim_time>,
  ...
}]

Longer term this could live as a CSV export or similar from one of the node management views:

image
ivangergo3 commented 2 years ago

Let us discuss it @dionysis-netdata @amalkov what do you think about this feature?

ghost commented 2 years ago

This is something we should support, allow/create APIs for consumption, but unlikely for this Q

ivangergo3 commented 2 years ago

@bojdell We will have a look at your request in the next quarter

bojdell commented 2 years ago

Exciting! Thanks for the consideration.