Real time monitor dashboard using Jenkins API and New Relic API
- php >="5.3.3"
- cURL
- Zend Framework "2.2.0"
- Doctrine-mongo-odm-module
- MongoDB PHP driver
- Whoops error handler
- MongoDB server (required only by Message widget)
The recommended way to get a working copy of this project is to clone the repository
and use composer to install dependencies. If you want to install packages listed in
require-dev, skip "--no-dev" option.
php composer.phar self-update
php composer.phar install --no-dev
(The self-update directive is to ensure you have an up-to-date composer.phar
available.)
- Number - Displays numeric value with percentage difference between current and previous value.
- Graph - Similar to Number widget but with additional graph displaying history of values.
- Message - Displays text messages that can be pushed to a database using REST API.
- Build - Displays current status of a build with additional info about build author and code coverage (if provided). During a build process it shows progress bar. Widget relies on Jenkins REST API.
- Error - Similar to Number widget but with different behaviour when some errors appear.
- Alert - Shows urls that produced 500 status code (internal server error). Widget relies on Splunk REST API.
In order to run Stp.Rtm you have to specify configuration file for each of your dashboards. All configuration files should be placed under "/config/rtm/" directory.
Below you can find a template and two examples of configuration files. The configuration file should contain a list of all widgets that you want to display on your dashboard. For each widget you have to specify its unique id, type and all of required parameters. If you want to use NewRelic's API you have to provide additional information like x-api-key and accountId.
The template of a configuration file
return array(
'theme' = '%YOUR_THEME_NAME%', // (optional) default 'dark'
'newRelic' => array(
'headers' => array(
'x-api-key' => '%API_KEY%',
),
'params' => array(
'accountId' => '%ACCOUNT_ID%',
),
),
'widgets' => array(
array('id' => '%UNIQUE_TO_DASHBOARD_WIDGET_ID%',
'type' => 'messages',
'params' => array(
'dao' => 'messages',
'metric' => 'messages',
'span' => '%WIDGET_WIDTH%', // widget width, accepted values: 1-12
'title' => '%WIDGET_TITLE%', // string title
),
),
array('id' => '%UNIQUE_TO_DASHBOARD_WIDGET_ID%',
'type' => 'alert',
'params' => array(
'dao' => 'splunk',
'metric' => 'Fivehundreds',
'title' => '%WIDGET_TITLE%',// string title (optional)
'subtitle' => '%WIDGET_SUBTITILE%', // string subtitle (optional)
'config' => '%SPLUNKS_JOB_NAME%', // splunk's job name
),
),
array('id' => '%UNIQUE_TO_DASHBOARD_WIDGET_ID%',
'type' => 'number',
'params' => array(
'dao' => '%DAO_TO_FETCH_DATA%',
'metric' => '%METRIC_NAME_TO_PRESENT',
'title' => '%WIDGET_TITLE%', // string title (optional)
'subtitle' => '%WIDGET_SUBTITILE%', // string subtitle (optional)
'span' => '%WIDGET_WIDTH%', // widget width, accepted values: 1-12 (optional)
'valuePrefix' => '%VALUE_PREFIX%', // string value to be displayed in front of the value (optional)
'valueSuffix' => '%VALUE_SUFFIX%', // string value to be displayed after the value (optional)
),
),
array('id' => '%UNIQUE_TO_DASHBOARD_WIDGET_ID%',
'type' => 'error',
'params' => array(
'dao' => 'newRelic',
'metric' => 'errorRate',
'appId' => '%NEW_RELIC_APP_ID%',
'title' => '%WIDGET_TITLE%', // string title (optional)
'subtitle' => '%WIDGET_SUBTITILE%', // string subtitle (optional)
'span' => '%WIDGET_WIDTH%', // widget width, accepted values: 1-12 (optional)
'valuePrefix' => '%VALUE_PREFIX%', // string value to be displayed in front of the value (optional)
'valueSuffix' => '%', // string value to be displayed after the value (optional)
),
),
array('id' => '%UNIQUE_TO_DASHBOARD_WIDGET_ID%',
'type' => 'graph',
'params' => array(
'dao' => 'newRelic',
'metric' => 'cpuUsage',
'appId' => '%NEW_RELIC_APP_ID%',
'title' => '%WIDGET_TITLE%', // string title (optional)
'subtitle' => '%WIDGET_SUBTITILE%', // string subtitle (optional)
'span' => '%WIDGET_WIDTH%', // widget width, accepted values: 1-12 (optional)
'valuePrefix' => '%VALUE_PREFIX%', // string value to be displayed in front of the value (optional)
'valueSuffix' => '%', // string value to be displayed after the value (optional)
'beginDateTime' => '-30 minutes', // start time for collecting data for the graph
'endDateTime' => 'now', // end time for collecting data for the graph
),
),
array('id' => '%UNIQUE_TO_DASHBOARD_WIDGET_ID%',
'type' => 'build',
'params' => array(
'dao' => 'jenkins',
'view' => '%VIEW_NAME%', // Jenkins view name (from URL)
'job' => '%JOB_NAME%', // Jenkins job name (from URL)
'metric' => 'status',
'title' => '%WIDGET_TITLE%', // string title (optional)
'subtitle' => '%WIDGET_SUBTITILE%', // string subtitle (optional)
'span' => '%WIDGET_WIDTH%', // widget width, accepted values: 1-12 (optional)
'valuePrefix' => '%VALUE_PREFIX%', // string value to be displayed in front of the value (optional)
'valueSuffix' => '%', // string value to be displayed after the value (optional)
),
),
),
);
Sample configuration for NewRelic
/**
* This is a sample project-specific NewRelic dashboard.
* It consists of a all available NewRelic widgets for a single application.
* All you have to do is replace variables surronded with '%' char with your data.
*/
return array(
'newRelic' => array(
'headers' => array(
'x-api-key' => '%X_API_KEY%',
),
'params' => array(
'accountId' => '%ACCOUNT_ID%',
'appId' => '%APPLICATION_ID%',
),
),
'widgets' => array(
array('id' => 'messages',
'type' => 'messages',
'params' => array(
'dao' => 'events',
'metric' => 'messages',
'span' => 6,
'title' => 'Sample project',
'limit' => 10,
),
),
array('id' => '%WIDGET_ID_1%',
'type' => 'graph',
'params' => array(
'dao' => 'newRelic',
'metric' => 'feRpm',
'span' => 3,
'beginDateTime' => '-30 minutes',
'endDateTime' => 'now',
'title' => 'Frontend RPM',
),
),
array('id' => '%WIDGET_ID_2%',
'type' => 'graph',
'params' => array(
'dao' => 'newRelic',
'metric' => 'rpm',
'span' => 6,
'beginDateTime' => '-30 minutes',
'endDateTime' => 'now',
'title' => 'Backend RPM',
),
),
array('id' => '%WIDGET_ID_2%',
'type' => 'graph',
'params' => array(
'dao' => 'newRelic',
'metric' => 'cpuUsage',
'title' => 'CPU USAGE',
'valueSuffix' => '%',
'span' => 6,
'beginDateTime' => '-30 minutes',
'endDateTime' => 'now',
),
),
array('id' => '%WIDGET_ID_3%',
'type' => 'graph',
'params' => array(
'dao' => 'newRelic',
'metric' => 'averageResponseTime',
'title' => 'Average response time',
'span' => 6,
'valueSuffix' => 'ms',
'beginDateTime' => '-30 minutes',
'endDateTime' => 'now',
),
),
array('id' => '%WIDGET_ID_4%',
'type' => 'number',
'params' => array(
'dao' => 'newRelic',
'metric' => 'memory',
'title' => 'MEMORY',
'valueSuffix' => 'MB',
),
),
array('id' => '%WIDGET_ID_5%',
'type' => 'numberWithNewRelicThreshold',
'params' => array(
'dao' => 'newRelic',
'metric' => 'apdex',
'title' => 'Apdex',
'thresholdComparator' => 'higherIsBetter',
),
),
array('id' => '%WIDGET_ID_6%',
'type' => 'error',
'params' => array(
'dao' => 'newRelic',
'valueSuffix' => '%',
'metric' => 'errorRate',
'title' => 'ERROR RATE',
'thresholdComparator' => 'lowerIsBetter',
),
),
array('id' => '%WIDGET_ID_7%',
'type' => 'alert',
'params' => array(
'dao' => 'splunk',
'metric' => 'Fivehundreds',
'title' => 'Splunk',
'subtitle' => 'Status code 500',
'config' => '%SPLUNKS_JOB_NAME%'
),
),
),
);
Sample configuration for Jenkins
/**
* This is a sample single-job Jenkins dashboard.
* It consists of a single widget for a single build.
* All you have to do is replace %JENKINS_JOB_NAME% with your unique Jenkins job name.
*/
return array(
'widgets' => array(
array('id' => '%WIDGET_ID%',
'type' => 'build',
'params' => array(
'dao' => 'jenkins',
'job' => '%JENKINS_JOB_NAME%',
'metric' => 'status',
'title' => 'Sample project build',
),
),
),
);
Assuming that http://localhost serve index.php from the /public directory, you can run your dashboard by adding name of the config file to the url: http://localhost/configName
##License
Distributed under the MIT license