Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/springerpe/springernature-custom-alerts-dashboards-boshrelease
Custom Resources for Prometheus
https://github.com/springerpe/springernature-custom-alerts-dashboards-boshrelease
bosh bosh-release prometheus-boshrelease
Last synced: about 2 months ago
JSON representation
Custom Resources for Prometheus
- Host: GitHub
- URL: https://github.com/springerpe/springernature-custom-alerts-dashboards-boshrelease
- Owner: SpringerPE
- License: apache-2.0
- Created: 2017-08-16T12:59:09.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-03T11:50:18.000Z (over 1 year ago)
- Last Synced: 2023-12-01T23:10:24.622Z (about 1 year ago)
- Topics: bosh, bosh-release, prometheus-boshrelease
- Language: Shell
- Size: 585 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Add-on BOSH Release for [prometheus-boshrelease](https://github.com/cloudfoundry-community/prometheus-boshrelease)
Add-on release with custom resources: dashboards, alerts for Prometheus Boshrelease.
Please, read the specs of each job to know more.
# Developing
Blobs of this release are stored in this git repository in the folder `blobstore`. The idea was taken from here: https://starkandwayne.com/blog/bosh-releases-with-git-lfs/
After this, files created by `bosh create-release --final` can be committed to the repo with git commit and it will be stored with git lfs. No need run `bosh sync-blobs`, instead just `git commit && git push`. All of these steps are automatically done by the script `create-final-public-release.sh`.
When do a git commit, try to use good commit messages; the release changes on each release will be taken from the commit messages!
## Creating Dev releases (for testing)
To create a dev release -for testing purposes-, just run:
```
# Create a dev release
bosh create-release --force --tarball=/tmp/release.tgz
# Upload release to bosh director
bosh -e upload-release /tmp/release.tgz
```
Then you can modify your manifest to include `latest` as a version (no `url` and `sha` fields are needed when the release is manually uploaded):
```
releases:
[...]
- name: springernature-custom-alerts-dashboards
version: latest
```
Once you know that the dev version is working, you can generate and publish a final version of the release (see below), and remember to change the deployment manifest to use a url of the new final manifest like this:
```
releases:
[...]
- name: springernature-custom-alerts-dashboards
url: https://github.com/SpringerPE/springernature-custom-alerts-dashboards-boshrelease/releases/download/v8/springernature-custom-alerts-dashboards-8.tgz
version: 8
sha1: 12c34892f5bc99491c310c8867b508f1bc12629c
```
or much better, use an operations file ;-)
## Creating a new final release and publishing to GitHub releases:
Run: `./create-final-public-release.sh [version-number]`
Keep in mind you will need a Github token defined in a environment variable `GITHUB_TOKEN`. Please get your token here: https://help.github.com/articles/creating-an-access-token-for-command-line-use/
and run `export GITHUB_TOKEN="xxxxxxxxxxxxxxxxx"`, after that you can use the script.
`version-number` is optional. If not provided it will create a new major version (as integer), otherwise you can specify versions like "8.1", "8.1.2". There is a regular expresion in the script to check if the format is correct. Bosh client does not allow you to create 2 releases with the same version number. If for some reason you need to recreate a release version, delete the file created in `releases/springernature-custom-alerts-dashboard-boshrelease` and update the index file in the same location, you also need to remove the release (and tags) in Github.
# Usage in a deployment manifest
This is and add-on release, it will work only if it is deployed together with the
*prometheus-boshrelease* on the nodes.
Considering v2 manifest style, add the new releases in the `releases` block:
```
releases:
[...]
- name: springernature-custom-alerts-dashboards
version: latest
```
then in your `instance_groups`, add:
```
instance_groups:
[...]
jobs:
[...]
- name: grafana
release: prometheus
- name: mysql_cluster_dashboards
release: springernature-custom-alerts-dashboards
```
### Dashboards
* mysql_cluster_dashboards. Provides cluster groups of mysql nodes based on a tag
called `cluster`. In order to use it with prometheus, you have to add a label
to the metrics. It has to be done in job scrape configuration (assuming one
prometheus job per MySQL cluster):
```
# With static IPs of the MySQL nodes, just add the label.
- job_name: mysql-dev
static_configs:
- targets:
- 10.230.11.215:9104
- 10.230.24.2:9104
labels:
cluster: dev
```
```
# With dynamic discovery of the MySQL nodes (using bosh_exporter).
# Have a look at the second relabel_config to add a label `test` to the metrics.
- job_name: mysql-test
file_sd_configs:
- files:
- /var/vcap/store/bosh_exporter/bosh_target_groups.json
relabel_configs:
- source_labels: [__meta_bosh_job_process_name]
regex: mysqld_exporter
action: keep
- source_labels: [__address__]
target_label: cluster
regex: "(.*)"
replacement: "test"
- source_labels: [__address__]
regex: "(.*)"
target_label: __address__
replacement: "${1}:9104"
```
* logstahs_dashboards. Provides dashboards to monitor logstash pipelines, provided
by https://github.com/SpringerPE/cf-logging-boshrelease `logstash_exporter` job.
taken from https://github.com/BonnierNews/logstash_exporter
:
```
# With static IPs of the Logstash nodes (not recommended), just add the label.
- job_name: logstash-platform
static_configs:
- targets:
- 10.230.11.215:9104
- 10.230.24.2:9104
```
```
# With dynamic discovery of the logstash nodes (using bosh_exporter).
# Have a look at the second relabel_config to add a label `platform` to the metrics.
- job_name: logstash
file_sd_configs:
- files:
- /var/vcap/store/bosh_exporter/bosh_target_groups.json
relabel_configs:
- source_labels: [__meta_bosh_job_process_name]
regex: logstash_exporter
action: keep
- source_labels: [__address__]
target_label: cluster
regex: "(.*)"
replacement: "platform"
- source_labels: [__address__]
regex: "(.*)"
target_label: __address__
replacement: "${1}:9104"
```
### Alerts
* TODO
# Author
SpringerNature Platform Engineering, José Riguera López ([email protected])
Copyright 2017 Springer Nature
# License
Apache 2.0 License