Arhs-atlasBoard is an extension of Atlasboard from Atlassian. It allows to create dashboard, add/remove and configure widgets via the web interface.
Homepage npm JavaScript Download
npm install arhs-atlasboard@0.9.1
Provided by the Arηs group. http://www.arhs-group.com/
https://bitbucket.org/nscheys/arhs-atlasboard
npm install -g arhs-atlasboard
After installing arhs-atlasboard as a global module, you can generate a new fully functional project that contains a sample dashboard by doing the following :
arhs-atlasboard create
This will create a directory called arhs-atlasboard in the current directory. Move to this directory and start the atlasboard server:
cd arhs-atlasboard
arhs-atlasboard start
You can now have access to your project's home page via http://localhost:3000. The project's home page allows you to create new dashboards and displays all the created dashboards.
You can also directly access the example dashboard via http://localhost:3000/dashboard (login:"dashboard", password:"password").
There are 2 ways to configure your dashboard (position of widgets, size of widgets, value of parameters, ...):
A list of available widgets is displayed along with a screenshot and a description of each widget.
In this popup, you can set the values for the configuration parameters of your widget or remove the widget from your dashboard.
Arhs-Atlasboard comes with several widgets that you can reuse for your dashboard. However, following your needs, you may want to create your own widgets. For that purpose, follow these three steps :
Widgets parameters are defined in a JSON file located at config/atlasboard.json. It contains the following elements:
widgets.<widgetName>
contains the properties and parameters of the widget named
title
: the widget titlejob
: the name of the job corresponding to the widgetdescription
: A description of the widgetwidth
: Initial width of the widget (nb columns)height
: Initial height of the widget (nb rows)config
: An object containing the configuration parameters of the widget. For each parameter :
type
: Type of the parameter. Possible values : "int","float","string","array","password"help
: Description of the parameterdefaultValue
: default value of the parameter (optional)min
: Minimum value of the parameter (optional)max
: Maximum value of the parameter (optional)optional
: If true, the parameter is optional.fields
: Only for parameters of type "array". Allows to define the name of the fields for the array elements.{
"live-logging" : {
"enabled":false
},
"widgets":{
"vmstate":{
"title":"VM State",
"job":"vmstatejob",
"description":"The widget allows to monitor the state (cpu, memory, disk space) of a list of virtual machines.",
"width":2,
"height":2,
"config":{
"interval": {"type":"int", "help":"The execution interval in seconds.", "defaultValue":120, "min":1},
"vms": {"type":"array", "help":"The list of VM to monitor.", "fields": ["name","host"]},
"maxCpu": {"type":"float", "help":"The threshold (in %) above which the cpu load is considered critical", "defaultValue":90,"optional":true, "min":0,"max":100},
"maxRam": {"type":"float","help":"The threshold (in %) above which the ram usage is considered critical", "defaultValue":90,"optional":true, "min":0,"max":100},
"minDiskGB": {"type":"float","help":"The threshold (in Gb) under which the hard disk space left is considered critical", "defaultValue":1,"optional":true, "min":0}
}
}
}
}
The widget allows to monitor the status of a list of Jenkins build jobs. Only the last build results are shown.
Parameters :
jenkinsUrl
: The url of the jenkins instance.jobs
: The list of jobs to monitor.username
: User name for authentication on JenkinsapiKey
: API Token for authentication on JenkinsThe widget allows to monitor the status of the smoke tests and displays the failed tests.
Parameters :
jenkinsUrl
: The url of the jenkins instance.smokeJob
: The job that corresponds to the smoke tests.limitFailed
: Maximum number of failed tests that are displayed on the screen.username
: User name for authentication on JenkinsapiKey
: API Token for authentication on JenkinsThe widget allows to monitor the sonar issues of a project. It shows the rules compliance, the nummber of issues and their criticality levels.
Parameters :
jenkinsUrl
: The url of the jenkins instance.sonarUrl
: The url of the sonar instance.projectKey
: The project key of the monitored projectcomparisonInterval
: The period of time used (in days) for comparing results. Ex: If the period is 14 days, the last sonar analysis is compared with the sonar analysis from 2 weeks ago.complianceWarningThreshold
: The warning threshold (in %) for rules compliance. If the compliance is lower than the threshold, the compliance's value is displayed in orange.complianceCriticalThreshold
: The critical threshold (in %) for rules compliance. If the compliance is lower than the threshold, the compliance's value is displayed in red.username
: User name for authentication on Sonarpassword
: Password for authentication on SonarThe widget displays the latest commits on a Git Stash repository.
Parameters :
stash_server
: The url of the stash serverproject
: The project key identifying the project that is monitored.repo
: The name of the git repositorybranch
: Branch identifier (ex: refs/heads/master)username
: User name for authentication on the repositorypassword
: Password for authentication on the repositoryThe widget displays a list of jira issues filtered according to a particular criterion.
Parameters :
jira_server
: The url of the jira server.jql
: The jql expression for filtering the issues (ex : project = user
: User name for authentication on Jirapassword
: Password for authentication on JiraThe widget shows the JIRA issues that are in progress for a particular sprint.
Parameters :
jiraUrl
: The url of the jira instancerapidViewId
: The rapid view iduser
: User name for authentication on Jirapassword
: Password for authentication on JiraThe widget shows information about the next planned release, in particular the remaining days before the release date.
Parameters :
jiraUrl
: The url of the jira instanceprojectCode
: The project codewarningThreshold
: If the number of days remaining before the deadline is lower than the threshold, it will be displayed in orange.criticalThreshold
: If the number of days remaining before the deadline is lower than the threshold, it will be displayed in red.user
: User name for authentication on Jirapassword
: Password for authentication on JiraThe widget shows the burndown chart of a particular sprint.
Parameters :
jiraUrl
: The url of the jira instancerapidViewId
: The rapid view idsprintId
: The sprint iduser
: User name for authentication on Jirapassword
: Password for authentication on JiraThe widget allows to monitor the state (cpu, memory, disk space) of a list of virtual machines.
Parameters :
vms
: The list of VM to monitormaxCpu
: The threshold (in %) above which the cpu load is considered criticalmaxRam
: The threshold (in %) above which the ram usage is considered criticalminDiskGB
: he threshold (in Gb) under which the hard disk space left is considered criticalNote that each widget has a configuration parameter called "interval" which defines the refresh rate of the widget.