Create a small project for data aggregation

[bajiat]

Goal

• Share the available data structure to dashboard designer team.
• In dialog with the dashboard design, decide on the expected /data structure and granularity.
• Data from API Umbrella Elastic Search is aggregated on the server side before passing the data to client.
• There is a functioning dashboard based on the wireframe options from dashboard design team.

Work-in-progress

The project has been started and initial work has been committed to apinf/api-umbrella-dashboard.

API Umbrella data structure

API Umbrella analytics are based on nginx log structure, and are documented in code (also here).

We have added further details and examples in our API Umbrella analytics structure document.

See the related dicussion in API Umbrella backlog.

[bajiat]

@marla-singer Would you be interested to cooperate with @brylie on this task? We would like this to be a team effort.

@mauriciovieira and @frenchbread Could you comment and mentor?

[frenchbread]

Sure

[mauriciovieira]

yes

[brylie]

NOTE (added to task description):The project has been started and initial work has been committed to apinf/api-umbrella-dashboard.

[marla-singer]

@brylie What is the next step?

[frenchbread]

Good work so far!

[brylie]

@marla-singer the next steps are to:

1. choose the visualization library
2. build one or more charts
   • use a dedicated server method for each chart, so we can use custom aggregations
3. determine how charts can share/communicate filter state (based on known API Umbrella analytics fields
   • e.g. time range, response code, etc could be stored as URL parameters to share state between charts

[brylie]

After reading and reflecting over the past week, I believe it is important to take a step back and consolidate our thinking about the dashboard project. There are a lot of ideas, sketches, and an active discussion to draw from.

The general overview we should produce is known as a project brief. The project brief describes a project from a high level, taking into account stakeholders, viewers, goals, available resources, etc. I have started to draft an APInf Dashboard Brief document, and contributions are welcome.

[bajiat]

We are now bringing the dashboard reiteration to the main apinf project. Hence, I'm closing the side project issue.