Orb UI Entities Data Examples
Most entities share a common set of attributes. Some of them are better diggested when examples are readily available. This page aims to provide some examples of entities, in either their RAW or JSON formats, or any other format that proves convenient over time.
It should also serve as aid for designing and improving Orb user interfaces and how data can best transmitted.
Sinks are dump-like entities over the internet.
The object below is a sink example.
{
"id": "urn:uuid:f5b2d342-211d-a9ab-1233-63199a3fc16f",
"name": "my-prom-sink",
"description": "An example prometheus sink",
"tags": {
"cloud": "aws",
"region": "eu"
},
"status": "active",
"error": "et dolore",
"backend": "prometheus",
"config": {
"remote_host": "my.prometheus-host.com",
"username": "dbuser",
"password": "secrets"
},
"ts_created": "1975-11-20T18:49:06.857Z"
}(editable: these properties can be edited)
/**
* Name
* must match the regex [a-zA-Z_:][a-zA-Z0-9_]*
*/
name = 'prom_sink_03' | ':region_name' | 'a'
// !invalid ['::12', ':.asd', '.asd', 'as_d#2', 'asd-01']
/**
* Description
*/
description = '' | 'any description text'
/**
* A timestamp of creation
*/
ts_created = '1975-11-20T18:49:06.857Z'
/**
* Status
*/
status = 'active' | 'error'
/**
* Sink Config
*/
config = {} // more on this below(readonly: these properties are likely to be exhibited in the UI, but never manipulated by the user)
/**
* id - UUIDv4 label
* typical uuid string length
* we could probably show the first 8 characters and append '...'
**/
id = 'cdb63720-9628-5ef6-bbca-2e5ce6094f3c'
/**
* Match a backend from /features/sinks.
* Cannot change once created (read only)
*/
backend = 'prometheus' | 'grafana' | '...'Depending on the type of backend selected, different form fields of different types will be available for the user to fill in. Once selected and saved, this field is no longer editable.
The ID field on the other hand is generated on the backend upon creation, and therefore always readonly.
For more information:
