Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Prometheus Exporter for Bamboo exposes Bamboo metrics as JVM and issue statistics to Prometheus.

...

  • Global controls the Prometheus server's global configuration.
  • Rule_files specifies the location of any rules that you want the Prometheus server to load.
  • Scrape_configs controls what resources Prometheus monitors.

 To enable Prometheus Exporter for Bamboo so that it collects metrics and pulls it into Prometheus: 

  1. Use the following scrape_configs:

    Code Block
    titleprometheus.yml
    scrape_configs:
      - job_name: 'bamboo'
        scheme: https #change to http if don't you have https
        metrics_path: '/<your_bamboo_context_path>/plugins/servlet/prometheus/metrics'
        static_configs:
          - targets: ['myhost:1990']


    For a complete specification of configuration options, see the Prometheus configuration documentation.

  2. On the Prometheus Status >Targets page, select the Prometheus Exporter for Bamboo endpoint to get the Prometheus metrics (see example below).

  3. Build any of the available dashboards with the selected metrics.

Configuring a secret token (recommended)

Warning
titleWarning

Note that this plugin publicly exposes some sensitive data by default. The metrics page exposes the usernames for who logged in last and so on. We recommend that you enable token protection to make sure the public cannot view usernames.

...

  1. Log into your Bamboo as Admin.
  2. Go to Bamboo Administration > Manage apps, and click Prometheus Exporter Settings
    The Prometheus Exporter Settings page opens. 
  3. Generate or create a Token. We recommend to use 128 characters.
     


  4. Use this secret token in the following scrape_configs inside the prometheus.yml configuration file: 

    Code Block
    titleprometheus.yml
      - job_name: 'bamboo'
        scheme: https #change to http if don't you have https
        metrics_path: '/<your_bamboo_context_path>/plugins/servlet/prometheus/metrics?token=secrettoken'
        params:
             token: ['1234567890'] # i'd reccomend use 128 symbol lenght long [A-Za-z0-9]
        static_configs:
          - targets: ['myhost:1990']


...