[gitter] Added gitter dashboard #443

imnitishng · 2020-04-11T16:14:02Z

Added some basic visualizations for gitter backend as discussed here.

Signed-off-by: Nitish Gupta [email protected]

imnitishng · 2020-04-11T16:19:15Z

Hi @valeriocos, here are the dashboards, I will write documentation and update these dashboards soon as our discussion progresses further.

There is a problem I am facing, the dashboards get uploaded successfully to Kibiter, however I get this error, the index pattern gitter I have saved in Kibiter is gitter_e*.
Can I get some help regarding this?

valeriocos · 2020-04-11T16:25:49Z

Thank you for the PR @imnitishng ! WRT the error please:

replace all occurrences of gitter-enriched with gitter (in both files)
replace "title": "gitter_e*" with "title": "gitter" (in the index pattern file)

This should fix the error. Let me know how it goes, thanks!

imnitishng · 2020-04-11T16:42:41Z

Hi @valeriocos, thank you for the quick response. I followed what you said but couldn't get the dashboard. Sorry I forgot to upload the image in the first comment.
I get this error

The indexes I have used for gitter are
gitter_raw and gitter_enriched_raw, and I already have 2 indexes patterns manually made in Kibiter gitter* and gitter_e*.

valeriocos

Thank you @imnitishng for the PR. I reviewed the PR together with chaoss/grimoirelab-sirmordred#453.

After applying the changes described in the comments (you may need to delete the .kibana and execute the task panels again), I was able to see the dashboard (see image below), which looks really nice!

I see that the visualizations use their names as titles. Note that the titles can be tuned (see gif below). This could be a nice contribution to the how to section in mordred (https://github.com/chaoss/grimoirelab-sirmordred/blob/master/Getting-Started.md#how-to-)

json/gitter-index-pattern.json

json/gitter.json

imnitishng · 2020-04-12T03:42:17Z

@valeriocos, sure I will make the changes and add documentation here and update the How-to section. Thank you.

imnitishng · 2020-04-12T06:34:56Z

Hi @valeriocos, I have edited the dashboards as you said, I wanted to do this little change but I don't seem to get it.

How do I change URLs mentioned in table from plain text to this Info+ link as used in Github pull request backlog?

valeriocos · 2020-04-12T07:11:03Z

Nice question! You need to update the format of the target attribute, see gif below.

Please consider to add your question together with the answer to the How to section of mordred.

imnitishng · 2020-04-12T07:52:52Z

Okay, thanks I will add this in the How-to section too.
And update the PR here.

valeriocos · 2020-04-17T08:24:53Z

Hi @imnitishng let me know when I can review this PR, thanks

imnitishng · 2020-04-17T10:48:13Z

@valeriocos, it is ready, I updated it. Please have a look.
I will update documentation post review.

valeriocos

Hi @imnitishng , thank you for the PR.

Overall the dashboard looks OK. Find below some suggestions/comments:

Stats visualization: please reduce the font size
Pie charts: they could be on the same line, and smaller
Daily message count and Users reading messages daily could be on the same line
In the Daily message count viz, replace count with messages in the legend
Change the label issues_is_pull to pull requests
Change the label issues_is_issue to issues
Change the label mentioned.mentioned_username to mentioned users
The 3 tables could be reduced and put on the same line
Include a markdown on the top right corner of the dashboard to summarize the purpose of each visualization and include a link to the Sigils documentation (see point below).
Please avoid empty spaces (as the one on the bottom left corner)
Document the dashboard (https://github.com/chaoss/grimoirelab-sigils/blob/master/CONTRIBUTING.md#adding-or-updating-documentation). The output should be similar to https://chaoss.github.io/grimoirelab-sigils/panels/docker-smells-and-dependencies/

Thanks for your work @imnitishng ! :)

imnitishng · 2020-04-18T19:53:12Z

Hi @valeriocos, sorry for the delay and mistakes. I have fixed them now. Please have a look.

valeriocos

Thank you @imnitishng for addressing my comments/suggestions. The dashboard looks nice, please check the last refinements and add the documentation:

The caption of the markdown can be removed.
The legend for the bar charts Weekly Active Users and Messages sent per hour could be hidden by default.
The pie charts could include just the first 10 hits, this avoids showing the scroll bar on the right.
The legend for the bar chart Daily message count could be hidden.
The legend for the bar charts Users reading messages daily could be completed with (avg) and the legend hidden.
Order the tables on count desc order
Extend the tables to remove the scroll bars on the right.

The final dashboard should look like the one below:

Note that to hide the legends, you have just click the icon > of the visualization and save the dashboard.

Thank you for your work @imnitishng !

imnitishng · 2020-04-19T11:14:40Z

Thanks for the review. I will update the PR ASAP.

imnitishng · 2020-04-20T12:53:54Z

@valeriocos, updated as you said.

valeriocos

Thank you @imnitishng for addressing the comment. The PR looks great, there are some minor comments to address.

Please double check the dashboard and the image (gitter.png), scroll bars are still visible.

Thanks!

docs/_panels/gitter.md

valeriocos · 2020-04-20T19:15:02Z

docs/_panels/gitter.md

+
+Each user in a room is uniquely identified by a username and a user-id. This
+information is used to identify the most active and mentioned users.
+Similarly the links shared are identified as github issues or pull requests


Missing comma? -> Similarly, the links shared are identified as GitHub

Sure. Will fix.

valeriocos · 2020-04-21T06:08:52Z

docs/_panels/gitter.md

+Each user in a room is uniquely identified by a username and a user-id. This
+information is used to identify the most active and mentioned users.
+Similarly the links shared are identified as github issues or pull requests
+or categorized into URL hostnames if they belong to external sources.


external or other sources?

Other sources, other websites apart from gitlab or github. (stackoverflow, twitter etc)

ok, thanks for the clarification. I would write it in this way:

.. if they belong to other sources (e.g., StackOverflow, Twitter).

valeriocos · 2020-04-21T06:11:13Z

docs/_panels/gitter.md

+
+Weekly, hourly and daily activity of the room is put into perspective by
+widgets displaying the number of messages sent or unique users active in
+the for selected time frame. 


in the for selected time frame -> in the selected time range (to be consistent with the description below)

Okay thanks, will fix.

imnitishng · 2020-04-21T08:50:05Z

@valeriocos, I have implemented the changes. Please have a look. We should be good to go now.

valeriocos · 2020-04-21T10:41:26Z

I still the scroll in the markdown:

Can you get an output like the one below?

imnitishng · 2020-04-21T11:24:37Z

Sorry for the mistake @valeriocos.
But I think this depends on user's screen size. Because when I created the edits, I made sure there were no scroll bars visible (screenshot added in documentation), IDK how they come up on your screen.
Anyway, I am fixing it. Thanks for pointing out.

valeriocos · 2020-04-21T13:18:05Z

No worries @imnitishng ! It is still not fixed, can you try with the following files below?
gitter.zip

Please check also the commit message, since everything appears on the same line

Thanks

This commit adds gitter panels visualizations with documentation Signed-off-by: Nitish Gupta <[email protected]>

imnitishng · 2020-04-21T13:31:03Z

Fixed it. I hope it's all good now. This PR took longer than expected 😅

valeriocos

LGTM, thanks @imnitishng

imnitishng changed the title ~~added gitter dashboard~~ [gitter] added gitter dashboard Apr 11, 2020

imnitishng changed the title ~~[gitter] added gitter dashboard~~ [gitter] Added gitter dashboard Apr 11, 2020

valeriocos reviewed Apr 11, 2020

View reviewed changes

json/gitter-index-pattern.json Outdated Show resolved Hide resolved

json/gitter.json Show resolved Hide resolved

valeriocos reviewed Apr 17, 2020

View reviewed changes

imnitishng force-pushed the gitter_dash branch from 3b396ec to 469c7a4 Compare April 18, 2020 19:52

valeriocos self-requested a review April 19, 2020 10:33

valeriocos reviewed Apr 19, 2020

View reviewed changes

imnitishng force-pushed the gitter_dash branch from 469c7a4 to 9a419ce Compare April 20, 2020 12:49

valeriocos reviewed Apr 21, 2020

View reviewed changes

imnitishng force-pushed the gitter_dash branch 2 times, most recently from 7f6b473 to d889a43 Compare April 21, 2020 08:48

[gitter] Add gitter panels.

311753c

This commit adds gitter panels visualizations with documentation Signed-off-by: Nitish Gupta <[email protected]>

imnitishng force-pushed the gitter_dash branch from d889a43 to 311753c Compare April 21, 2020 13:30

valeriocos self-requested a review April 21, 2020 14:49

valeriocos approved these changes Apr 21, 2020

View reviewed changes

valeriocos closed this in b0d0bde Apr 21, 2020

valeriocos merged commit b0d0bde into chaoss:master Apr 21, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[gitter] Added gitter dashboard #443

[gitter] Added gitter dashboard #443

imnitishng commented Apr 11, 2020

imnitishng commented Apr 11, 2020

valeriocos commented Apr 11, 2020

imnitishng commented Apr 11, 2020

valeriocos left a comment

imnitishng commented Apr 12, 2020

imnitishng commented Apr 12, 2020

valeriocos commented Apr 12, 2020

imnitishng commented Apr 12, 2020 •

edited

Loading

valeriocos commented Apr 17, 2020

imnitishng commented Apr 17, 2020

valeriocos left a comment

imnitishng commented Apr 18, 2020

valeriocos left a comment

imnitishng commented Apr 19, 2020

imnitishng commented Apr 20, 2020

valeriocos left a comment

valeriocos Apr 20, 2020

imnitishng Apr 21, 2020

valeriocos Apr 21, 2020

valeriocos Apr 21, 2020

imnitishng Apr 21, 2020

valeriocos Apr 21, 2020

valeriocos Apr 21, 2020

imnitishng Apr 21, 2020

valeriocos Apr 21, 2020

imnitishng commented Apr 21, 2020

valeriocos commented Apr 21, 2020

imnitishng commented Apr 21, 2020 •

edited

Loading

valeriocos commented Apr 21, 2020 •

edited

Loading

imnitishng commented Apr 21, 2020 •

edited

Loading

valeriocos left a comment

[gitter] Added gitter dashboard #443

[gitter] Added gitter dashboard #443

Conversation

imnitishng commented Apr 11, 2020

imnitishng commented Apr 11, 2020

valeriocos commented Apr 11, 2020

imnitishng commented Apr 11, 2020

valeriocos left a comment

Choose a reason for hiding this comment

imnitishng commented Apr 12, 2020

imnitishng commented Apr 12, 2020

valeriocos commented Apr 12, 2020

imnitishng commented Apr 12, 2020 • edited Loading

valeriocos commented Apr 17, 2020

imnitishng commented Apr 17, 2020

valeriocos left a comment

Choose a reason for hiding this comment

imnitishng commented Apr 18, 2020

valeriocos left a comment

Choose a reason for hiding this comment

imnitishng commented Apr 19, 2020

imnitishng commented Apr 20, 2020

valeriocos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

imnitishng commented Apr 21, 2020

valeriocos commented Apr 21, 2020

imnitishng commented Apr 21, 2020 • edited Loading

valeriocos commented Apr 21, 2020 • edited Loading

imnitishng commented Apr 21, 2020 • edited Loading

valeriocos left a comment

Choose a reason for hiding this comment

imnitishng commented Apr 12, 2020 •

edited

Loading

imnitishng commented Apr 21, 2020 •

edited

Loading

valeriocos commented Apr 21, 2020 •

edited

Loading

imnitishng commented Apr 21, 2020 •

edited

Loading