-
Notifications
You must be signed in to change notification settings - Fork 9
4. Widgets
All widgets have General
tab and some of them have a separate tab
with settings specific to the widget
General Tab Fields:
-
Type
- type of widget f.e AEM Bundle, AEM Healthcheck -
Title
- any text -
Columns
- set widget width in grid -
Rows
- set widget height in grid -
Go to new line
- check if widget should be displayed in new line -
Disabled
- check if widget should have disabled state
*Expandable Content - option that allows you to display a large amount of content in the form of expandable content. Option is is not available for all widget. Take a look at screens below
-
Endpoint
- choose AEM endpoint -
Schedule Period
- time interval between executions >> recommended:300
(5min) -
Error threshold for 'resolved' bundles
- how many bundles with statusresolved
are needed to throw an error instead of warning -
Error threshold for 'installed' bundles
- how many bundles with statusinstalled
are needed to throw an error instead of warning -
Excluded bundles
- list of bundles to be ignored when calculating widget status; can be either display name or symbolic name. Excluded bundles will be put in a separate section, with an option to view them all (including statuses).
-
Endpoint
- choose AEM endpoint -
Schedule Period
- time interval between executions >> recommended:300
(5min) -
Health Checks
- choose health checks which you would like to show*
*
There are other health checks available in AEM. If other checks are desirable they can be added easily by contributing to:
cogboard-webapp/src/constants/index.js#AEM_HEALTH_CHECKS
constant.
-
Endpoint
- choose configured Bamboo endpoint -
Schedule Period
- time interval between executions >> recommended:300
(5min) -
ID
- choose deployment which you would like to show
-
Go to
<bamboo_host>/deploy/viewAllDeploymentProjects.action
-
Click on deployment from list
-
Project page opens:
- In URL you will find
ID
number >> <bamboo_host>/deploy/viewEnvironment.action?id=1234567
- In URL you will find
-
Endpoint
- choose configured Bamboo endpoint -
Schedule Period
- time interval between executions >> recommended:300
(5min) -
ID
- choose plan you would like to show
- Go to
<bamboo_host>/allPlans.action
- Click on plan from list
- Project page opens:
- In URL you will find
ID
number >> <bamboo_host>/browse/CSOI-SDFAPTAS
- In URL you will find
Widget displays one of three status icons:
- success (green checkmark)
- failure (red cancel icon)
- indeterminate (indeterminate checkbox icon)
Users can toggle widget state by clicking its area.
State can also be updated by sending a POST request to content update endpoint: http://<board_host>/api/widget/contentUpdate
for example using curl
command in the CLI (first ensure that curl is installed on the machine):
curl -d '{"id": "widget17","content": {"widgetStatus": "CHECKBOX_OK"}}' -H "Content-Type: application/json" -X POST http://<board_host>/api/widget/contentUpdate
The JSON body of the request should follow the example structure:
{
"id": "widget17",
"content": {
"widgetStatus": "CHECKBOX_FAIL"
}
}
where:
-
id
- the widget ID that can be copied from widget edit dialog.
-
widgetStatus
- widget status to be set, possible vaues are:CHECKBOX_OK
,CHECKBOX_FAIL
,CHECKBOX_UNKNOWN
No additional configuration needed
-
URL
- URL of a page that will be embedded as an iframe in a widget
example:https://www.youtube.com/embed/uBP9K2QJSSs
-
Endpoint
- choose Jenkins endpoint* -
Schedule Period
- time interval between executions | recommended:300
(5min) -
Path
- path to the job | example:/job/ProjectName/job/build-name
*
example Jenkins Endpoint props:
{
id: "endpoint1",
label: "Jenkins Endpoint",
url: "http://internal.url or http://ip.address",
publicUrl: "https://external.url",
credentials: "credential2"
}
Tested on Jenkins v.2.46.3
Widget displays the amount of Jira issues in user defined buckets. Buckets of issues can be added, deleted and edited.
-
Endpoint
- choose Jira endpoint -
Schedule Period
- time interval between executions | recommended:300
(5min) -
Maximum number of issues
- limit of the issues pulled from Jira in every bucket -
Bucket Name
- name of the user defined bucket -
JQL Query
- user defined query that matches the ticket requirements*
*JQL - Jira Query Language documentation
You can also use build-in jira search:
and copy the jql query parameter value from URL
Widget displays list of links specified be user. Items can be added, deleted and edited.
-
Link Title
- any ext -
Link Url
- url to external website
A widget for displaying and storing logs. It connects to a server via SSH and collects logs from a given file. You can then filter the logs by date, their level, as well as a set of rules defined by regular expressions.
-
Endpoint
- choose an endpoint from which you want to acquire the logs (requires an endpoint with an URL following the schemassh://host:port
and appropriate credentials) -
Schedule Period
- time intervel between retrieving logs from the server -
Path
- path to a file containing the logs -
Maximum number of lines to return
- maximum number of lines that will be shown by the widget -
Log file size lmit
- maximum size of logs stored in the database for this widget (in MiB) -
Log record expiration period
- number of days after which the logs are deleted from the database
Values written in the search field will be highlighted. Any logs matching the query will also receive a yellow checkmark in their upper left corner. There is a 0.5 second delay after typing for the results to appear. You have to provide at least 3 characters.
Logs not matching all the filters will not be displayed.
Date
and level
fields are omitted.
You can manage the filters by clicking on the Advanced button.
You can hover over a filter to view its regular expression. To modify a filter, click on the wrench icon. To add a new filter, click on the "Add filter" button. New filters are enabled by default. To disable a filter, click on the switch next to it.
You can enable a filter by selecting it from the list which appears after clicking on the field. To disable a filter, click on the "X" icon next to it.
Logs are shown if their level is greater than or equal to the selected log level (the default level is info
).
Defined levels:
-
debug
- 10 -
info
- 20 -
warning
- 30 -
error
- 40
Date span allows you to show logs only from a specific period of time.
Quarantine is used to filter out logs before they are saved to the database. Any incoming log matching a regular expression from any of the quarantine rules will be dropped and will not be saved in the database or shown to the user. Upon changing the rules, logs already stored in the database will be checked for matching any of the new rules (and deleted if they do).
The quarantine rules can only be set by the users logged in as admins. Regular users do not see the button to change them.
At present, the button is next to the "Clear logs" button (it is planned for it to be moved to the modal shown after clicking the "Advanced" button).
Adding a quarantine rule is largely similar to adding a filter. However, it has one additional option: the ability to enter a reason for setting the rule.
New logs are always displayed at the end of the list, so if the user wants to see them, she or he has to scroll to the end of it. The "Follow logs" button allows the user to automatically scroll to the end every time the widget is refreshed. Upon scrolling, the functionality is disabled.
The "Clear logs" button sets the beginning of the date span to after the date of the last log. This clears out all of the visible logs, resulting in an empty list (until new logs arrive).
Filters, Log level and Date span settings are saved in the browser's local storage.
Widget cycle through defined text items in scheduled time intervals. Admin user can force item picking with a refresh button.
-
Randomize
- By default widget cycle throw items in LIFO order, if this is enabled items are selected randomly -
Daily
- If enabled next value will be selected in next day - minute after midnight -
Interval
- Interval between cycling items in minutes -
Entries
- List of values to be showed
-
Schedule Period
- time interval between executions >> recommended:300
(5min) -
Request Method
- choose request method >>GET | PUT | POST | DELETE
-
Content Type
- choose header content type >>application/json | application/xml | multipart/form-data | text/html | text/plain
-
Endpoint
- choose service endpoint -
Path
- service url >> example:/login
-
Response Body Fragment
- response body fragment that is expected for this service -
Expected Status Code
- status code that is expected for this service >> default:200
Widget displays:
- Expected status code. If the response status code is different it shows ex. "200 EXPECTED, GOT 404"
- Response status:
-
MATCH
- response includes expected response fragment -
NOT MATCH
- response not includes expected response fragment -
OK
- when expected response body remains empty
-
- Response body message - in a popover after hovering a mouse over response status
-
SonarQube Version
- 7.x, 6.x or 5.x supported -
Endpoint
- choose Jenkins endpoint* -
Schedule Period
- time interval between executions | recommended:300
(5min) -
Key
- project key | example:com.cognifide.zg:com.cognifide.zg:stable
-
Metrics
- choose metrics which you would like to show
- Go to
<sonarqube_host>/dashboard/index
- Click on project from list
- Project page opens:
- In URL you will find
ID
number | <sonarqube_host>/overview?id=316488
- On a page (upper-right corner) you will find
Key
- In URL you will find
*
example SonarQube Endpoint props:
{
id: "endpoint2",
label: "SonarQube Endpoint",
url: "http://internal.url or http://ip.address",
publicUrl: "https://external.url",
user: "user.name",
password: "pass",
token: "token"
}
- user should fill one of two login options:
password
ortoken
field
-
Text
- any text (multiple lines allowed) -
Text Size
- text sizes fromXXS
toXXL
>> default:M
-
Vertical Text
- rotate text by 90 degrees >> default:false
Widget displays list of items specified be user. Items can be added, deleted and edited. You can check the done items.
-
Item Title
- any text (multiple lines allowed)
It creates a blank space between widgets.
No additional configuration needed. This widget is invisible when the user logged out.
Widget displays current time and date of the specific timezone
-
Timezone
- choose GMT timezone -
Date Format
- choose date display format -
Time Format
- choose between 12 or 24 hour time format -
Display date
- check if date should be displayed -
Display time
- check if time should be displayed -
Text Size
- choose size of date and time
Widget is able to show information about: cpu, ram, heap, disk, logged users, uptime and number of processes.
It is mandatory to fill all the fields with proper content to have properly working widget.
-
Endpoint
- choose Zabbix endpoint -> endpoint URL and Public URL must have/zabbix/api_jsonrpc.php
on the end -
Schedule Period
- time interval between executions -
Host
- provide host name, host name shouldn't be taken from group level. Choose lower level host name - e.g.pre-cog-front-publisher01.dll.dlgpl.net
-
Metric
- choose which metric should be displayed:- Active users
- Available Memory
- CPU Utilization
- Mem heap size
- Number of processes
- System uptime
- Used disk space
- Used swap space
Next two configuration fields are available only if specific metric will be selected e.g. available memory, disk space etc. This is due to the fact that in some cases the progress bar will be displayed. So we need to specify range and maximum value, which will be used to calculate the percentage value.
-
Max Value
- provide max value for metric (in GB) -
Range
- define the range where the widget will display ok, warning or error status based on the percentage value