CHAOSS CHAOSScon EU 2019, 9 Mar 2019

Previous Meeting

Next Meeting

⏯

youtube image

►

From YouTube: Creating a Collection of Panels | Alberto Pérez | CHAOSSconEU19

Description

Slides: https://chaoss.github.io/website/CHAOSScon/2019EU/slides/Creating-a-Collection-of-Panels.pdf

During the last months, we have been dealing with dozens of panels and its number keeps increasing. It is expected to have many more, and it is becoming hard to deal with this amount of information. We need to scale!

The concept of collections of panels aims at bringing some order into the existing repository. A panel collection is just a set of Kibana dashboards. In this case, each panel is a Kibana dashboard consisting of a set of widgets.

GrimoireLab CHAOSS GMD code development metrics is an example where this concept can be applied. What about having a collection of GMD panels? This would be based on publicly available and could be built on top of GrimoreLab, so anyone can deploy the panels and get them working for their own purposes.

We will show the collection built on top real data, retrieved and processed by means of GrimoireLab projects. From that point, we will take a walk on the panels offering a closer look at the metrics. Looking at real numbers ease to get a deeper understanding of the metrics, as we can see them in action.

A

Talk is about creating a coalition of manners. I think. Currently, you know that be more lab is visit on panels. Each panel has a set of metrics or a set of visualization Iran even metric, but we have some problems even before the matrix I mean in this talk. We are talking about them.

A

First, let me say my name is Alberto I work in the Durga and I work, as I say, did something and fight fighter and I basically do establish with data metrics and panels and something else this is my twitter handle and my personal webpage. So what we will punish? This is Monte calcio, so we are hoping you are going to help us to build new panels from today, at least- and this is our daily work- we just collect visualization and put those visualizations into panels so well.

A

First, we need to know that we are talking about panels, but panels are just a small part within which urges be more lab. Architecture panels are located just here in signals, project remodel of seagulls and is right after elastic search indexes and right before the eruption, where you visualize the dependence.

A

Okay, so well, what do we need to prove? First, we have panels panels everywhere. So basically, this is me, and this is the user. When I say we have a lot of panels here, so you can look the panels we have and you can select the panels you need, for you know, you've got, but the users usually are scared, because we have really a lot of panels, but this was in the past the last year, because now we have collections to nice things. So this is not a problem anymore.

A

This is the repository right now we have many panels. We have really too many panels. This is a screenshot of the whole scroll of the webpage, so you need to find a particular panel. You have to go there and try to find the panel you need only by its name, which is not easy. Well, so what suppose? The problem is. This is not only overwhelming for users, but also it hides contributions, because you can contribute your panel.

A

You can put your one under, but it's a very difficult to let others find your panel, so it's a scarce user, but not on the user, also contributors, because users are not able to find panels. So contributors don't want to put the panels inside because it's difficult for users find a path. So we need to find a way to solve this problem. We have also another problem which is related with when we create a new task work with a set of panels, reduce early, didn't touch a panel, but the panel.

A

It's really fine and we don't know what the answer is, because right now we are sharing widget between panels among panels. The width is the same. The panel is different, but we are stirring the panel in a self-contained fashion, so the panel contains all the visualization. That means that during port a panel, do you import everything inside the panel? If later, do you import another panel with the same stuff? You are importing the same underwriting. The things do important before so. Basically, the staff do import later is the stuff we are going to see.

A

So you are overwriting once and again the same isolation, if you're done, if you are not able to keep all your panels in sync, you have a problem because some panels are going to show visualizations that are not expected to be shown there so well. The third problem is documentation. When I talk about documentation, the problem is that all the people run away so I know it's a difficult problem, but well we are trying to solve it. What this is the documentation we'll have right now is yield a lot of to be done things.

A

This is the documentation for a good panel, three paragraphs saying something about leave some visualization there, there's no screens out there, there's no even asked in a sentence telling us about what the use case you can look for in the panel, but it's a complete disaster, so we need to change this angle. This obviously reduce usability, and this case is behind the panels, are totally unknown. So, if you work with the more lab that source protein, probably you have faced Abdi's problem.

A

What like toca talked about collections collections should be the solution for at least some of these problems. First of all, we collections. The idea is separating panels into smaller sets. This set can be whatever I mean. If you have some use cases, you can just build a set of panels and put those panels together and you have a collection and you can even use your own wrap up. You want, you don't need to put the panels in civil courses.

A

It will be great if you contribute your repo to be more love to chaos or, if you just send us all the to do collection of panels, and we can so the link from our get with peut or whatever, but it is you can do whatever you want with your panels. You don't need to contribute to our project. You just need to get some remote lab data and then build your panels on top of that.

A

Well about the panels how we can deal with the same Association across different panels. We cannot do anything among collections, but within the same collection we can separate the widgets in different files. So if you stole a panel like a file referencing older files, you can control that each widget is stored only once per collection, so this should solve the problem of having widgets that are changing when important part. This is working progress because it depends on a new tool like now in in ramallah.

A

We are using Kiedis as tool for importing and supporting panels, and we are moving to new tool data log to export and import things as a pipe fashion angle about documentation. We are using now jq4 documentation because you can be supported in.

A

You can build a documentation and it's easy to constitute to build the web page from a markdown file. So if you want all the people to contribute, you can build a web page and just ask for DeMarre down for the path, maybe with some guidelines, but it should be easy, or at least easier than will the whole documentation for the collection. So the only requirement could be to have a markdown page for each panel in the code. So anyway, you have to write it. So this is true.

A

I cannot be there who helped you write in your documentation, but Daniel is watching you so take care if you're planning no contributing with documentation, because he is simultaneous signals.

A

And summarizing the idea here is putting some order into seals, because we need to organize things to allow users to find the things they are really interested in so well how to contribute. But the first way is just contributing a panel. Do you just need to get some ramallah data follow some guidelines? I broke the guidelines, so this documentation is almost complete. You can follow the guideline son.

A

If you find some bad or do you need more help, you can just drop me an e-mail or open an issue because I'm really interested in updating this documentation for having more and more people contributing with panels.

A

The second way is creating your own collection. This is good because you can control everything inside your collection. You can create your collection and your repository. You could add tests cái for everything or whatever you need. In fact, we are doing it in in Batavia to have some tests and also to have the Jekyll part testing in good luck with good luck. Cdi is great because you can control that all contributions follow these some guidelines and well.

A

You can always ask to include it in ramallah as a project or as a part of be more like seals, and you can always share it from your own repo, but please send us a link because it will be great to have a list of all repos with panels working on top of Ramona theta I know there are some people that have their own panels in and some of those panels are based on Kaos matrix. So it will be great to transform those repositories into these kind of collections.

A

So on the collection structure is really easy. It's just a directory for the JSON files exported now with Jesus in the future, with another tool and a dog's directory in this territory. We store all the stability with the good page, but here you just need to put the markdown files inside the directive diattou it prefixed by underscore and with the same name as your panel collection. So it should be easy to contribute documentation to well.

A

Regarding export and import. Archimedes is a new tool. We are working on to a sportin importance and the idea is having separate the panel's, the visualizations and the rest of the stop using you should buy pivoter.

A

This tool is built on top of given API, so all the JSON files should be compatible with give an API, but you need the tool to put all the files together because, given our requires to have all the stuff in the import, so if you want to put the panel, you need to do all the visualizations and so on. That's why we need to store it separately to control that we have unique things and about Jekyll.

A

The only things we require in Jekyll is a front batter with some meta information, which is also the date in which you greet the panel diversion of remodel, updated. You are using and the title description screens and layout ecosystem formation. We are using to build the panel in Jekyll, so just with this and a markdown file, you will see your documentation in the webpage.

A

So what this is the webpage Monica, so it won't page before so. It's not something new. That is new in the sense that we will. We didn't have these before and now we have a front page with a list of collections.

A

The list includes a Koz and the collection under be more laughs, let's say legacy panels or standard panels, and each panel have documentation plates like this one with a screenshot and some text text that should contain at least elimination of the matrix and one or two lines telling us what the creator of the pant the panel expect from us to find in the panel. Let's see an example, for instance, I created a panel to compare the time to first attention with time to close what what I expect from the user to look for.

A

There is the difference between both, because the time to first attention is important, but but the relation that time, I'm trying to close, is even more important because things should not remain open too much time. Even if you ask me and well, we have right now one collection available online, which is a chaos collection, daniel on Anna's, so and so the collection before, and we are preparing also new vitória panels. They are out of jiggles right now, because we, this is working progress, so at some point I expect we are going to contribute these panels.

A

Also to to Ramallah, but it will be soon but not today, not yet the chaos E&V is a belonging that URL, so you can go there and look the recommendation about the new panels and you can go to the repository and get the panels if you want. You can also import the panels to your dashboard or you can just go to the dashboard, which is a chaos, dot, beater, dot, IO and look at the panels and the new panel suit bateria looks quite similar because the web page is build on top of vehicle.

A

So it is easy to replicate the structure we have in Seville. So if you are planning to have your own collection, you can go to serials and get the destructor if you are planning using it lab instead of github.

A

Just ask me, because we have this built on top of Hitler, so it's pretty similar, but you need to change some things, but the idea is that it's easy building new collections are in your new panels, document that panels and serve the panels with the community and the idea on top of everything, is having the small pieces of information that may be more useful than a set of panels that you are not going to understand because you are not to be able to find the panel. You are interested in angle, final remarks.

A

As I said, building collections doesn't mean out of seals doesn't mean you are not going to contribute those collections to be more because you can do it as we are going to do with a new collection from materia collections are here twists access to the matrix behind the panel, so the idea is finding a better way to organize things.

A

And finally, if you already have the panels, please, sir, your panels with the community and if you need help to build your own repository collection, just ask me or another people in Vitoria to help you doing because I think the important part here is having more visible and a final note about Brian talk. I would like to say that, when I think about data, I, don't think about data is going to give me answers.

A

I think that data is going to give me more information about the questions I'm really interested in and then I need to drill down to find the answers, and maybe I don't have to take that, but that data to help me have it. This is an interesting discussion, though maybe we can have later thanks for your talk, because it was great and I re with you in most of the things you say and well.

A

Thank you very much and what questions do you have.