[GAP-14] Network Insights API

[johny-b]

No description provided.

[stranger80]

OK, I see the purpose of this design.

Immediate thoughts:

1. "Index" may not be the best term to describe what we are trying to design here. We are defining some "degree of excellence" in some aspect/dimension. A few potentially less confusing alternatives:

• Rate/rating ("Rating API")
• Grade ("Grading API")

2. Please define the "use cases" of the API, ie. "get available rates", "get current node rating", "get historic node ratings", "save node rating", etc.

[johny-b]

1. "Index" may not be the best term to describe what we are trying to design here. We are defining some "degree of excellence" in some aspect/dimension. A few potentially less confusing alternatives:
* Rate/rating ("Rating API")
* Grade ("Grading API")

I'm not saying "indices" is the prettiest and smoothest name, but I still prefer "index" to "rate"/"rating"/"grade".
From my POV, this could be just any value - like e.g. "average offer prices of the node" - this is not rating and not grading (and not the general "degree of excellence").

IOW, "Rating API"/"Grading API" are for me a special case of "node indices API", but there are also cases that are not rating/grading.

(I don't have a very strong opinion here, I'd be glad to discuss this)

[johny-b]

2. Please define the "use cases" of the API, ie. "get available rates", "get current node rating", "get historic node ratings", "save node rating", etc.

Few examples: https://github.com/golemfactory/golem-architecture/blob/johny-b/GAP/node-indices-api/gaps/gap-14_node_indices_api/gap-14_node_indices_api.md#examples

Also: this GAP is only about read-only access to some data, there's nothing like "save node rating" here.

[nieznanysprawiciel]

1. "Index" may not be the best term to describe what we are trying to design here. We are defining some "degree of excellence" in some aspect/dimension. A few potentially less confusing alternatives:
* Rate/rating ("Rating API")
* Grade ("Grading API")

I'm not saying "indices" is the prettiest and smoothest name, but I still prefer "index" to "rate"/"rating"/"grade". From my POV, this could be just any value - like e.g. "average offer prices of the node" - this is not rating and not grading (and not the general "degree of excellence").

IOW, "Rating API"/"Grading API" are for me a special case of "node indices API", but there are also cases that are not rating/grading.

(I don't have a very strong opinion here, I'd be glad to discuss this)

Maybe could be Metrics API?

[stranger80]

TC Session 27/01/2022:

1. can we try to find an accurate name? as "measure"/"metric" is not generic enough, "index" may be confused with eg. "database index", etc?
2. Discuss the concept in subgroup:

• Janek, MB, Radek, Witek

[johny-b]

1. can we try to find an accurate name? as "measure"/"metric" is not generic enough, "index" may be confused with eg. "database index", etc?

Node Data API?
Node Information API?

[maaktweluit]

i think golem stats is a bad example of this GAP because it uses metric data private to golem factory, making is heavily centralised.

[stranger80]

TC 10.02.2022:

• Idea: how do we discover the existing implementations of this API? We can imagine such API service to be advertised on Golem Market via Offers.
• Indicate in the GAP - this is not another "yagna API", this is a generic API which should be exposed by entities who want to make these stats/metrics available to members of golem network (eg. for the purpose of executing market strategy)
• ACTION FOR ROAD-AHEAD SQUAD:
  • Schedule the work on reference implementation - and choose the right topic for it (see below)
  • Is GAP-10 a good idea for a reference implementation? Gathering data in Golem Stats owing to the mechanisms in yagna and offering this data on the marked from a central repo - is actually a case of centralization.
  • Maybe there is a better, "decentralized" case which is a better reference implementation of GAP-14? Eg. implementation of "invoice-based reputation"?
  • eg. write an implementation which is a module or plugin in yagna suite or even distributed separately, which anyone can run to gather data and then offer them on the market?
• ...we can also imagine meta-indexing service - aggregator of stats gathered from various sources
• What flexibility is this API providing:
  • each metric has a unique name
  • the metric values are expressed as sequence of timestamped values of a specific datatype

[johny-b]

In commit fefdb09 I've mentioned following discussion points:

Idea: how do we discover the existing implementations of this API? We can imagine such API service to be advertised on Golem Market via Offers.
(...)
Indicate in the GAP - **this is not another "yagna API", this is a generic API which should be exposed by entities who want to make these stats/metrics available to members of golem network (eg. for the purpose of executing market strat
(...)
...we can also imagine meta-indexing service - aggregator of stats gathered from various sources

(I'm not sure though if I've done it the way you intended).

[stranger80]

Change the name of the API to "Network Insights API".

[tworec]

To be approved @ TC 2022-03-10