https://github.com/chaoss/grimoirelab-sigils
Panels from GrimoireLab dashboards
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.4%) to scientific vocabulary
Keywords from Contributors
Repository
Panels from GrimoireLab dashboards
Basic Info
- Host: GitHub
- Owner: chaoss
- License: gpl-3.0
- Language: Python
- Default Branch: main
- Homepage: https://chaoss.github.io/grimoirelab-sigils/
- Size: 32.6 MB
Statistics
- Stars: 36
- Watchers: 17
- Forks: 87
- Open Issues: 21
- Releases: 20
Metadata Files
README.md
Generic Dashboards for GrimoireLab
Each of the files found in this directory are a JSON file that contains all of the information related to a Kibana dashboard. This usually has information about the following artifacts: * Original indexes where the information come from. * Searches on those indexes that provide a sub-set of the information. * Widgets either built on top of the original indexes or on top of the searches. * Final panels that are an aggregation of several widgets.
There are Dashboards for Kibana 6 right now stored in panels/json
Panels
A panel is composed by the several widgets this contains. So far the panels proposed as generic are a mix of the several data sources available in a project. Those could be only focused on Git, but there are others such as review systems like Gerrit, IRC channels, mailing lists, etc.
The structure for naming files should be:
* For data sources:
```
Examples:
git<panelname>.json
gerrit<panelname>.json
* For other panels not focused on particular data sources we just use the name of the panel:
Examples: about.json overview.json git.json gitpairprogramming.json gerrit.json gerrit_timing.json ``` To give some examples, below there is a list of some panels that can be found in this directory: * git.json: provides aggregated information about all of the gits in the analysis. * gerrit.json: provides aggregated information from all of the gerrit projects. * gerrit-backlog.json: provides specific widgets to track the backlog of the project. * mailinglists.json: provides information about the discussions that take place in the several mailing lists. * about.json: provides some widgets detailing this information and how to interact with the panels. * overview.json: provides a generic view of the dataset with some widgets that help to drill down the information from the whole list of data sources.
All panels will provide widgets for filtering information by project, domain, organization, etc. depending on the availability of that information in the corresponding index.
Widgets Naming
```
Example: gittopauthors Example: git_authors ```
Where data source could be git, gerrit, mbox, etc.
Widgets Title Naming
In general, titles should follow the same naming scheme as the widget itself, substituting underscore characters by single spaces and adding capital letters. Nevertheless, widgets title depends on the name of the panel in which the widgets are located:
If the panel shows information for several data sources, then the name of the data source must be included. For example, it's the case of Data Status Panel, because it contains the same information per data source, so using data source name in title is mandatory.
If the name of the data source is included in the title of the panel, then the name of the data source shouldn't be included in widgets' title, except in cases where it could help understand what the widget contains.
```
Example: Same visualization for top authors would be named:
- 'Top Authors' in 'Git' panel, as the panel is giving us context.
- 'Git Top Authors' in 'Overview' panel where we could have similar visualizations for other data sources. ```
Of course this is a general rule, just have context into account with naming widgets to know if data source is clear or not.
Searches Naming
```
Search:_
Example: Search:pullrequest:true ```
Indexes Naming
Notice that optional date is included to allow keeping several copies of the same data source when needed.
Raw indexes should use suffix -raw:
```
Example: git-raw
Example: gerrit-raw
Example: stackoverflow-raw
Example: jira-raw
Example: bugzilla-raw
Enriched indexes:
Example: gitenriched Example: gerritenriched Example: stackoverflowenriched Example: jiraenriched Example: bugzilla_enriched ```
Aliases Naming
Finally, an alias should be created pointing to the enriched index. This allows to easily modify the data used under the hood in a transparent way from the point of view of panels. Its name should be just the name of the data source, but sometimes we need different indexes for the same data source. In that case we would add a suffix to indicate the functionality of that alias.
```
Example: git Example: gerrit Example: stackoverflow Example: jira Example: bugzilla ```
For each index there could be as many aliases as needed. The most usual use case is using aliases for building panels or visualizations based on different time series. E.g.:
```
Example for git index and metadatatimestamp: git_metadatatimestamp
Example for git index and metadataupdatedon: gitmetadataupdated_on
Example for jenkins and createdat field: jenkinscreated_at ```
Index Pattern Naming
Index patterns in Kibana should follow the same naming scheme as aliases in ES (see Aliases Naming section). This way, is easy to know what alias is being used by a given index pattern. Besides, it makes easier to select index patterns from kibana, because their names include the field configured for time series in that index pattern.
Common Index Fields
Following fields that should be included in any index pattern:
- id
- url
- metadata__timestamp
- metadata_updatedon
- author_bot
- author_name
- authororgname
- author_uuid
- author_domain
- authorusername
- origin
- grimoirecreationdate
Data model
Each of the indexes are based on a previous definition. This is declared in CSV format with two columns: name and type.
More information at the Schema directory.
How this info was retrieved
These json files were retrieved using Kidash.
Example of how to run this:
```
$ kidash -g -e
example: $ kidash -g -e https://admin:admin@localhost:9200 --dashboard overview --export overview.json --split-index-patterns ```
More information: Kidash - Usage.
Owner
- Name: CHAOSS
- Login: chaoss
- Kind: organization
- Website: https://chaoss.community/
- Twitter: chaossproj
- Repositories: 64
- Profile: https://github.com/chaoss
GitHub Events
Total
- Release event: 2
- Watch event: 1
- Delete event: 2
- Push event: 4
- Pull request review event: 1
- Pull request event: 4
- Fork event: 4
- Create event: 4
Last Year
- Release event: 2
- Watch event: 1
- Delete event: 2
- Push event: 4
- Pull request review event: 1
- Pull request event: 4
- Fork event: 4
- Create event: 4
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Alberto Pérez García-Plaza | a****a@b****m | 228 |
| Daniel Izquierdo | d****o@b****m | 149 |
| alpgarcia | a****a@g****m | 109 |
| Valerio Cosentino | v****s@b****m | 105 |
| Santiago Dueñas | s****s@b****m | 68 |
| Miguel Ángel Fernández | m****n@b****m | 36 |
| Alvaro del Castillo | a****s@b****m | 26 |
| Quan Zhou | q****n@b****m | 25 |
| Jose Javier Merchante | j****e@b****m | 13 |
| David Moreno | d****b@g****m | 11 |
| Manrique Lopez | j****e@g****m | 9 |
| Luis Cañas Díaz | l****s@b****m | 8 |
| inishchith | i****h@g****m | 4 |
| J. Manrique Lopez de la Fuente | j****e@b****m | 4 |
| Ana Jiménez | a****s@b****m | 4 |
| Jesus M. Gonzalez-Barahona | j****b@g****s | 3 |
| Andre Klapper | a****9@g****e | 3 |
| Georg J.P. Link | l****g@g****m | 1 |
| Nitish Gupta | i****g@g****m | 1 |
| Ruth Cheesley | r****y@a****m | 1 |
| Venu Vardhan Reddy Tekula | v****8@g****m | 1 |
| abhiandthetruth | a****h@g****m | 1 |
| benny Vasquez | b****z@c****o | 1 |
| Ben Lloyd Pearson | b****p@o****m | 1 |
| dpose | d****e@b****m | 1 |
| sevagenv | s****v@g****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 29
- Total pull requests: 80
- Average time to close issues: 6 months
- Average time to close pull requests: 20 days
- Total issue authors: 14
- Total pull request authors: 16
- Average comments per issue: 2.34
- Average comments per pull request: 0.86
- Merged pull requests: 62
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 5
- Average time to close issues: N/A
- Average time to close pull requests: 1 day
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- alpgarcia (7)
- valeriocos (3)
- mafesan (3)
- canasdiaz (3)
- jsmanrique (2)
- dicortazar (2)
- shikha0208 (2)
- rwood-97 (1)
- dplanella (1)
- sduenas (1)
- GrayStranger (1)
- Virkeipa (1)
- tivaliy (1)
- Pablohn26 (1)
Pull Request Authors
- zhquan (19)
- valeriocos (17)
- alpgarcia (12)
- jjmerchante (12)
- mafesan (9)
- imnitishng (2)
- joelpaulkoch (2)
- vchrombie (2)
- sduenas (2)
- VSevagen (1)
- canasdiaz (1)
- bennyvasquez (1)
- jsmanrique (1)
- abhiandthetruth (1)
- dlumbrer (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 644 last-month
- Total docker downloads: 69
- Total dependent packages: 3
- Total dependent repositories: 8
- Total versions: 48
- Total maintainers: 2
pypi.org: grimoirelab-panels
Panels and visualizations for GrimoireLab dashboards
- Homepage: https://chaoss.github.io/grimoirelab/
- Documentation: https://grimoirelab-panels.readthedocs.io/
- License: GPL-3.0+
-
Latest release: 1.1.2
published over 1 year ago
Rankings
Dependencies
- python ^3.7
- bitergia/release-tools-check-changelog master composite
- chaoss/grimoirelab-github-actions/build master composite
- chaoss/grimoirelab-github-actions/publish master composite
- chaoss/grimoirelab-github-actions/release master composite