├── .gitignore ├── LICENSE ├── Makefile ├── README.md ├── Vagrantfile ├── Vagrantfile.flatcar ├── doc ├── ObservabilityNomad.png ├── consul-nodes.png ├── consul-services.png ├── nomad-grafana.png ├── prometheus-targets.png └── tns-app.png ├── jobs ├── 01-prometheus.nomad.hcl ├── 05-tempo.nomad.hcl ├── 11-loki.nomad.hcl ├── 15-tns.nomad.hcl ├── 21-promtail.nomad.hcl └── 25-grafana.nomad.hcl └── provisioning ├── dashboard.json └── dashboard.yaml /.gitignore: -------------------------------------------------------------------------------- 1 | .vagrant/ 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: fmt install 2 | 3 | HCLFMT := $(shell command -v hclfmt 2> /dev/null) 4 | 5 | fmt: 6 | ifndef HCLFMT 7 | GO111MODULE=on go get github.com/hashicorp/hcl/v2/cmd/hclfmt 8 | endif 9 | find jobs/*.hcl -maxdepth 0 | xargs -L 1 hclfmt -w 10 | 11 | 12 | install: 13 | find jobs/*.hcl -maxdepth 0 | xargs -L 1 nomad job run 14 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Adding Observability to Nomad Applications 2 | 3 | > Recording of the demo is available on the [hashitalk 2021 website](https://www.hashicorp.com/resources/adding-observability-to-hashicorp-nomad-applications-with-grafana). ([slides](https://docs.google.com/presentation/d/1CSWKew4ID0oKBnQpR-3wUUyF8XpIIPzwzSLsc61yZL8/edit#slide=id.gbc349f7587_0_60)) 4 | 5 | This repository demonstrates how you can leverage the [Grafana Open Source Observability Stack][oss-grafana] with [Nomad][nomad] workload. 6 | 7 | In this demonstration we will deploy an application ([TNS][TNS]) on [Nomad][nomad] along with the [Grafana Stack][oss-grafana]. The [TNS][TNS] application is written in Go and instrumented with: 8 | 9 | - Prometheus **Metrics** using [client_golang][client_golang]. 10 | - **Logs** using [gokit][gokit] (output format is [logfmt][logfmt]). 11 | - **Traces** using [jaeger go client][jaeger_client]. 12 | 13 | > You can use the instrumentation of your choice such as: [OpenTelemetry][OpenTelemetry], [Zipkin][Zipkin], json logs... 14 | 15 | We'll also deploy backends to store collected signals: 16 | 17 | - [Prometheus][Prometheus] will scrape **Metrics** using the scrape endpoint. 18 | - [Loki][Loki] will receive **Logs** collected by [Promtail][promtail]. 19 | - [Tempo][Tempo] will directly receives **Traces** and Spans. 20 | 21 | Finally, we'll deploy [Grafana][oss-grafana] and [provision](provisioning/) it with all our backend datasources and a dashboard to start with. 22 | 23 | ## Getting Started 24 | 25 | For simplicity you'll need to install and configure [vagrant][vagrant]. 26 | 27 | To get started simply run: 28 | 29 | ```bash 30 | vagrant up 31 | ``` 32 | 33 | In case you want a faster startup not based on Ubuntu but on Flatcar Linux (as CoreOS has been EOLed): 34 | 35 | ``` 36 | VAGRANT_VAGRANTFILE=Vagrantfile.flatcar vagrant up 37 | ``` 38 | 39 | **IMPORTANT NOTE**: Due to the new policies of Docker Hub image pulling, 40 | (see https://blog.container-solutions.com/dealing-with-docker-hub-rate-limiting) 41 | there may be cases where you will need to `docker login` to avoid getting error 42 | messages like: 43 | 44 | ``` 45 | Error response from daemon: toomanyrequests: You have reached your pull rate limit. You may increase the limit by authenticating and upgrading: https://www.docker.com/increase-rate-limit 46 | ``` 47 | 48 | In order to use DockerHub login, you need to provide two additional environment variables 49 | as follows: 50 | 51 | ``` 52 | DOCKERHUBPASSWD=my-dockerhub-password DOCKERHUBID=my-dockerhub-login vagrant up 53 | ``` 54 | 55 | Then you should be able to access: 56 | 57 | - TNS app => http://127.0.0.1:8001/ 58 | - Nomad => http://127.0.0.1:4646/ui/ 59 | - Consul => http://127.0.0.1:8500/ui/ 60 | - Grafana => http://127.0.0.1:3000/ 61 | - Prometheus => http://127.0.0.1:9090/ 62 | - Promtail => http://127.0.0.1:3200/ 63 | - Loki => http://127.0.0.1:3100/ 64 | 65 | You can go to the Nomad UI Jobs page to see all running jobs. 66 | 67 | ![alt text][nomad-grafana] 68 | 69 | ## Nomad Client Configuration 70 | 71 | [Promtail][promtail] need to access host logs folder. (alloc/{task_id}/logs) 72 | By default the docker driver in nomad doesn't allow mounting volumes. 73 | In this example we have enabled it using the plugin stanza: 74 | 75 | ```hcl 76 | plugin "docker" { 77 | config { 78 | volumes { 79 | enabled = true 80 | } 81 | } 82 | } 83 | ``` 84 | 85 | However you can also simply run Promtail binary on the host manually too or use nomad [`host_volume`][host_volume] feature. 86 | 87 | Promtail also needs to save tail positions in a file, you should make sure this file is always the same between restart. 88 | Again in this example we're using a host path mounted in the container to persist this file, 89 | 90 | [promtail]: https://grafana.com/docs/loki/latest/clients/promtail/ 91 | [host_volume]: https://www.nomadproject.io/docs/configuration/client#host_volume-stanza 92 | [nomad]: https://www.nomadproject.io/ 93 | [oss-grafana]: https://grafana.com/oss/ 94 | [vagrant]: https://www.vagrantup.com/ 95 | [nomad-grafana]: ./doc/nomad-grafana.png 96 | [client_golang]: https://github.com/prometheus/client_golang 97 | [TNS]: https://github.com/grafana/tns 98 | [gokit]: https://github.com/go-kit/kit/tree/master/log 99 | [jaeger_client]: https://github.com/jaegertracing/jaeger-client-go 100 | [logfmt]: https://brandur.org/logfmt 101 | [OpenTelemetry]: https://opentelemetry.io/ 102 | [Zipkin]: https://zipkin.io/ 103 | [Prometheus]: https://prometheus.io/ 104 | [Loki]: https://grafana.com/oss/loki/ 105 | [Tempo]: https://grafana.com/oss/tempo/ 106 | 107 | ## Troubleshooting 108 | 109 | ### Grafana shows nothing or TNS keeps crashing because of it can't connect to Tempo 110 | 111 | - You may have troubles with your `dns` configuration in the jobs, if your jobs can't talks to each other tries to change the ip to `127.0.0.1` or the internal ip address of your server if using a `VPC` or just removes the `dns` stanza. It's recommanded to use [Consul Connect](https://www.consul.io/docs/connect) to connect every services to each others. 112 | 113 | ### I can't see the logs in Grafana/Loki 114 | 115 | - You may have a different `data_dir` config in your `nomad` configuration. Here it's using `/opt/nomad/data` while we generally sets `/opt/nomad`. If it's your case, change the `volume` stanza of your `tempo` job. 116 | -------------------------------------------------------------------------------- /Vagrantfile: -------------------------------------------------------------------------------- 1 | # -*- mode: ruby -*- 2 | # vi: set ft=ruby : 3 | 4 | $script = <