| commit | author | age | ||
| 66abfd | 1 | # Return of the Monitoring |
| 5a16fd | 2 | |
| bfabf3 | 3 | > In this exercise we will create a build monitor to radiate vital build information and statistics |
| d03287 | 4 | |
| D | 5 |  |
| 5a16fd | 6 | |
| 0284bf | 7 | ## Exercise Intro |
| 3e28c6 | 8 | Build monitors provide a tight feedback loop which is vital to high performing teams. Being in a highly visible location, build monitors radiate crucial build and test information, meaning the team doesn't have to go out of their way to find it. Build monitors also provide a degree of accountability whilst also keeping the team motivated to fix problems. With broken components visualised, seeing build monitors change from red to green can give the collective feeling that progress is being made. |
| 79c7e5 | 9 | |
| 867471 | 10 | On residencies we display the build monitors on Raspberry Pi's hooked up to large TV screens that everyone can see at a glance. We've also used colour-changing lightbulbs in the labs that change from Green to Red depending on the success/fail status of jobs. There are many other ways to notify people of Build Failures such as Slack notices, text messages or just plain old email. This exercise is about radiating the information to allow teams respond quickly to change. |
| 3e28c6 | 11 | |
| DS | 12 | In this Exercise we will be creating a build monitor to display all of our jobs in one visual display as well as pipeline views. We will then add the cause of build failures for each job to the monitors. This will allow you to rapidly see why a particular build is failing and fix it faster. |
| 13 | ||
| 14 | Finally, build monitors can promote team cohesion as they enable all team members to be on the same page regarding the current project status. They can also engage business users and clients on the stats of the system. __The most important thing here isn't the tool, but the visual feedback.__ | |
| a4e18f | 15 | |
| RH | 16 | ## Why do we use build monitors? |
| 17 | - Provides instant feedback to teams regarding the current status of the build. | |
| 18 | - Tightens feedback loop by having vital information needed by teams, available upfront. | |
| 19 | - Motivates teams to fix problems together. | |
| 3e28c6 | 20 | |
| a85dba | 21 | ____ |
| 5a16fd | 22 | ## Learning Outcomes |
| D | 23 | As a learner you will be able to |
| bfabf3 | 24 | - Create dashboards in Jenkins to display build status |
| f386eb | 25 | - Seed Jenkins using DSL to create dashboards by default |
| 5a16fd | 26 | |
| D | 27 | ## Tools and Frameworks |
| 28 | > Name of tool - short description and link to docs or website | |
| 29 | ||
| bfabf3 | 30 | 1. [Build Monitor plugin](https://wiki.jenkins.io/display/JENKINS/Build+Monitor+Plugin) - Build Monitor Plugin provides a highly visible view of the status of selected Jenkins jobs. It easily accommodates different computer screen sizes and is ideal as an Extreme Feedback Device to be displayed on a screen on your office wall. (Inspired by the no longer maintained RadiatorView plugin). |
| 1f906d | 31 | 1. [Build Fail Analyser](https://wiki.jenkins.io/display/JENKINS/Build+Failure+Analyzer) - This plugin analyses the causes of failed builds and presents the causes on the build page. It does this by using a knowledge base of build failure causes that is built up from scratch. Saving statistics about failure causes is also possible. |
| 6bd3ef | 32 | 1. [Pipeline Aggregator View](https://wiki.jenkins.io/display/JENKINS/Pipeline+Aggregator+View) - Allows the users to view the history of their pipelines with stage information (failed/In Progress/Passed) and the changes monitored) |
| 5a16fd | 33 | |
| D | 34 | ## Big Picture |
| 1a8071 | 35 | > From the previous exercise; we introduced non-functional testing to our pipeline. This exercise focuses on radiation of useful information such as build stats and times from our pipeline. |
| D | 36 | |
| 37 |  | |
| 5a16fd | 38 | |
| D | 39 | _____ |
| 40 | ||
| 41 | ## 10,000 Ft View | |
| 853f0c | 42 | > The goal of this exercise is to introduce Build Monitors to radiate team's progress on Dashboards. |
| 5a16fd | 43 | |
| bfabf3 | 44 | 2. Create a new Dashboard for our Builds using the plugin above. Use Regex to add jobs to it. Use the BuildFail Analyser to add meaningful data to the reason for failures. |
| 5a16fd | 45 | |
| 542e51 | 46 | 2. Use the pipeline views in OpenShift and Jenkins to produce dashboards that teams can use. |
| 5a16fd | 47 | |
| D | 48 | ## Step by Step Instructions |
| 542e51 | 49 | > This is a fairly structured guide with references to exact filenames and sections of text to be added. Include pictures and code snippets where appropriate. |
| 5a16fd | 50 | |
| bfabf3 | 51 | ### Part 1 - Create a build monitor |
| 6bd3ef | 52 | > _In this exercise we will create a new build monitor to show key information about our builds_ |
| 5a16fd | 53 | |
| 6bd3ef | 54 | 2. On Jenkins home page; create a new view by hitting the plus icon on the home screen (should be beside the `all` above the jobs list) |
| bfabf3 | 55 | |
| 6bd3ef | 56 | 2. Give the job a sensible name such as `todolist-monitor` and select `Build Monitor View` |
| D | 57 |  |
| bfabf3 | 58 | |
| 6bd3ef | 59 | 2. On the configuration page; select `Recurse in subfolders` |
| D | 60 |  |
| 61 | ||
| 62 | 2. Check the box to use Regular Expression and set the value to be something that should scrape our apps such as `.*todolist.*` | |
| 63 |  | |
| 64 | ||
| 853f0c | 65 | 2. Finally; select `Display committers` and set the Failure Analyser to `Description`. This allows us to write regexes for when failures occur in Jenkins and have the reasons plotted on the graph. For example; number of test scores or common compilation errors. |
| 6bd3ef | 66 |  |
| D | 67 | |
| 68 | 2. Save your configuration to see your Build Monitor! | |
| f386eb | 69 |  |
| 6bd3ef | 70 | |
| fd42cf | 71 | 2. Let's create another view for Jenkins using the `Pipeline Aggregator View` plugin. This view is great because it shows lots of valuable information in a clean; easy to visualise way. Create a new view called `todolist-pipelines` and select `Pipeline Aggregator View` |
| D | 72 |  |
| 73 | ||
| 74 | 2. On the configure page; set the regex to `todolist.*` | |
| 75 |  | |
| 76 | ||
| 77 | 2. Set the view to `Only display last build` for simplicity of the view. | |
| 78 |  | |
| 79 | ||
| 80 | 2. Save your configuration to see your Build Monitor! | |
| 81 |  | |
| 6bd3ef | 82 | |
| 364c66 | 83 | 2. Explore the Jenkins Blue Ocean view for some additional monitors and views that make Jenkins look pretty! |
| D | 84 |  |
| 85 | ||
| f386eb | 86 | ### Part 2 - Build Fail Analyser |
| D | 87 | > _In this exercise we will intentionally fail the build to capture some metrics about why it's failed and how we can tighten the feedback for future failures_ |
| 88 | ||
| 89 | 2. Open the `todolist-fe` app in your favourite editor. In this exercise, we will fail a test and capture the message in the log and visualise it on a dashboard. | |
| 90 | ||
| 867471 | 91 | 2. Open one of the tests you wrote in previous exercises; for example `tests/unit/vue-components/TodoItem.spec.js`. Negate the test at the very bottom of the file by adding a `.not` to the `expect()` statement as shown below. |
| f386eb | 92 | ```javascript |
| D | 93 | it("call makImportant when clicked", () => { |
| 94 | const wrapper = mount(TodoItem, { | |
| 95 | methods, | |
| 96 | propsData: { todoItem: importantTodo } | |
| 97 | }); | |
| 98 | // TODO - test goes here! | |
| 99 | const input = wrapper.find(".important-flag"); | |
| 100 | input.trigger("click"); | |
| 101 | expect(methods.markImportant).not.toHaveBeenCalled(); | |
| 102 | }); | |
| 103 | }); | |
| 104 | ``` | |
| 105 | ||
| 68037e | 106 | 2. Run your tests locally and you should see one failing test as shown below. Jenkins will have the same output so we can capture this as code! |
| f386eb | 107 |  |
| D | 108 | |
| 68037e | 109 | 2. The `Test Suites: 1 failed, 11 passed, 12 total` string can be coded into a regex. On Jenkins homepage; hit the `Failure Cause Management` nav on the left hand menu. On the page that loads; hit `Create new`. |
| f386eb | 110 | |
| D | 111 | 2. Call the new Failure Cause `jest-tests`. Set the Description to be `${1,1} failed out of ${1,2}`. The `${1,1}` refers to the first capture group in a regex. Click `Add indication > Build log`. Set the Pattern to match for the test output we've seen in our test execution on the terminal using this regex `.*Tests:.*(\d+) failed.*(\d+) total.*`. |
| 112 |  | |
| 113 | ||
| 68037e | 114 | 2. Our dashboards are set to show the `Description` field from the `Build Fail Analyser`. Run a build by checking in our failed tests and check the result on the Build Monitor created in the previous step |
| f386eb | 115 | ```bash |
| 58480f | 116 | git add . |
| D | 117 | ``` |
| 118 | ```bash | |
| 119 | git commit -m "TEST - failing build" | |
| 120 | ``` | |
| 121 | ```bash | |
| 122 | git push | |
| f386eb | 123 | ``` |
| D | 124 |  |
| 125 | ||
| 853f0c | 126 | 2. We can save up these regexes and inject them into the `jenkins-s2i` so the configuration is there the next time we launch and we don't have to code them up again. In `enablement-ci-cd` repo; the `jenkins-s2i/configuration/build-failure-analyzer.xml` already contains ones we've collected on previous residencies. |
| f386eb | 127 | |
| D | 128 | ### Part 3 - Seed Jenkins Dashboards |
| 6bd3ef | 129 | > _TODO - Add instructions for creating dashboards as part of s2i in Jenkins setup using DSL_ |
| D | 130 | |
| 131 | 2. Open the s2i in `enablement-ci-cd` ..... | |
| 5a16fd | 132 | |
| D | 133 | _____ |
| 134 | ||
| 135 | ## Extension Tasks | |
| 136 | > _Ideas for go-getters. Advanced topic for doers to get on with if they finish early. These will usually not have a solution and are provided for additional scope._ | |
| 137 | ||
| bfabf3 | 138 | Additional Alerting |
| D | 139 | - Add `Slack` integration to the Pipeline by setting up a WebHook to call the slack endpoint with Build Stats |
| 140 | - Add `Twillio` text integration to send you text messages when the build fails. | |
| 141 | Additional Monitoring | |
| 5e7a31 | 142 | - Explore the Application's EFK stack inside OpenShift |
| 5a16fd | 143 | |
| D | 144 | ## Additional Reading |
| 145 | > List of links or other reading that might be of use / reference for the exercise | |
| 146 | ||
| 4f0295 | 147 | ## Slide Links |
| RH | 148 | |
| 149 | - [Intro](https://docs.google.com/presentation/d/1nfv1f04HkvN6ruOZ5JRMnHsSfDClyMNOhXxcC7WsSr4/) | |
| 150 | - [Wrap-up](https://docs.google.com/presentation/d/1-HI9Wd5WWlzaMWmFpBEclqdyt9pFumaVbfOUrkfYKY0/) | |
| 3e28c6 | 151 | - [All Material](https://drive.google.com/drive/folders/1Lx0OotWjisugCY11Ef0dF7EZXMIPoXOO) |
