---
title: Charmhub | Deploy Prometheus using Charmhub - The Open Operator Collection
description: Deploy the latest version of Prometheus on any cloud.
url: https://charmhub.io/prometheus/configurations
---

# Prometheus

[Prometheus Charmers](https://charmhub.io/publisher/prometheus-charmers "View all packages from Prometheus Charmers")

* [Prometheus Charmers](https://charmhub.io/publisher/prometheus-charmers "View all packages from Prometheus Charmers")
* [Monitoring](https://charmhub.io/?filter=monitoring)

Platform:

16.04

14.04

stable 11

```
juju deploy prometheus
```

[Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications)

* [custom-rules](https://charmhub.io/prometheus/configurations#custom-rules)
* [daemon-args](https://charmhub.io/prometheus/configurations#daemon-args)
* [evaluation-interval](https://charmhub.io/prometheus/configurations#evaluation-interval)
* [external-labels](https://charmhub.io/prometheus/configurations#external-labels)
* [external\_url](https://charmhub.io/prometheus/configurations#external_url)
* [federate-config](https://charmhub.io/prometheus/configurations#federate-config)
* [install\_keys](https://charmhub.io/prometheus/configurations#install_keys)
* [install\_method](https://charmhub.io/prometheus/configurations#install_method)
* [install\_sources](https://charmhub.io/prometheus/configurations#install_sources)
* [label-juju-units](https://charmhub.io/prometheus/configurations#label-juju-units)
* [monitor-name](https://charmhub.io/prometheus/configurations#monitor-name)
* [nagios\_context](https://charmhub.io/prometheus/configurations#nagios_context)
* [nagios\_servicegroups](https://charmhub.io/prometheus/configurations#nagios_servicegroups)
* [prometheus\_registration\_authtoken](https://charmhub.io/prometheus/configurations#prometheus_registration_authtoken)
* [prometheus\_registration\_listen](https://charmhub.io/prometheus/configurations#prometheus_registration_listen)
* [prometheus\_registration\_port](https://charmhub.io/prometheus/configurations#prometheus_registration_port)
* [rules-repo](https://charmhub.io/prometheus/configurations#rules-repo)
* [rules-update-notify-email](https://charmhub.io/prometheus/configurations#rules-update-notify-email)
* [rules-update-schedule](https://charmhub.io/prometheus/configurations#rules-update-schedule)
* [rules-update-ssh-key](https://charmhub.io/prometheus/configurations#rules-update-ssh-key)
* [scrape-interval](https://charmhub.io/prometheus/configurations#scrape-interval)
* [scrape-jobs](https://charmhub.io/prometheus/configurations#scrape-jobs)
* [snap\_channel](https://charmhub.io/prometheus/configurations#snap_channel)
* [snap\_proxy](https://charmhub.io/prometheus/configurations#snap_proxy)
* [snap\_proxy\_url](https://charmhub.io/prometheus/configurations#snap_proxy_url)
* [snapd\_refresh](https://charmhub.io/prometheus/configurations#snapd_refresh)
* [static-targets](https://charmhub.io/prometheus/configurations#static-targets)
* [web-listen-port](https://charmhub.io/prometheus/configurations#web-listen-port)

[Learn about configurations >](https://juju.is/docs/juju/configuration#heading--application-configuration)

* custom-rules | string

  Plan text rules to be loaded by prometheus.yml
* daemon-args | string

  Arbitary string containing list of arguments, separated by a semi-colon
  to be given to the prometheus daemon.
  Examples:
  "-my-famous-arg 1; -my-almost-famous-arg 2 3 4 5 6; -my-boring-arg 7"
* evaluation-interval | string

  Default: 15s

  Default evaluation interval
* external-labels | string

  a comma-separated list of label=value labels that are applied to all
  metrics exported via federation. (E.g. label1=foo,label2=bar)
* external\_url | string

  The URL under which Prometheus is externally reachable (for example,
  if Prometheus is served via a reverse proxy). Used for generating
  relative and absolute links back to Prometheus itself. If the URL
  has a path portion, it will be used to prefix all HTTP endpoints
  served by Prometheus. If omitted, relevant URL components will be
  derived automatically.
  It's templatized to accept the following vars: {private\_address},
  {public\_address}, {port}, thus you can use e.g.:
  juju set prometheus external\_url="http://{private\_address}:{port}/"
* federate-config | string

  This will be parsed as YAML, format is a list of dicts as shown in the example.
  Example:

  + job\_name: 'prom-2'
    params:
    'match[]':
    - '{job="prometheus"}'
    - '{**name**=~"^job:"}'
    targets:
    - 'source-prometheus-2:9090'
  + job\_name: 'prod-1'
    scheme: https
    metrics\_path: /prometheus/federate
    params:
    'match[]':
    - '{job=~".+"}'
    targets:
    - 'my-production-site:443'
      label: production
* install\_keys | string

  YAML list of GPG keys for installation sources, as a string. For apt repository
  URLs, use the public key ID used to verify package signatures. For
  other sources such as PPA, use empty string. This list must have the
  same number of elements as install\_sources, even if the key items are
  all empty string. An example to go with the above for install\_sources:
  install\_keys: |

  + "ABC"
  + ""
* install\_method | string

  Default: snap

  How to install prometheus. If set to "apt" the package will be installed using apt-get. If set to "snap", empty string or unset snap package will be installed
* install\_sources | string

  Default: [ "ppa:canonical-bootstack/prometheus" ]

  YAML list of additional installation sources, as a string. The number of
  install\_sources must match the number of install\_keys. For example:
  install\_sources: |

  + ppa:project1/ppa
  + ppa:project2/ppa
* label-juju-units | boolean

  If set to true, a "juju\_unit" label is added to metrics with the name of
  the related juju unit. If the related unit is a subordinate, it should
  set the "principal-unit" key on the relation, with the name of the unit
  it's related to.
* monitor-name | string

  Prometheus monitor name, will default <service\_name>-monitor if not set
* nagios\_context | string

  Default: juju

  A string that will be prepended to instance name to set the host name
  in nagios. So for instance the hostname would be something like:
  juju-myservice-0
  If you're running multiple environments with the same services in them
  this allows you to differentiate between them.
* nagios\_servicegroups | string

  Default: juju

  Comma separated list of nagios servicegroups for the graphite check
* prometheus\_registration\_authtoken | string

  Default: changeme

  The authtoken used with prometheus registration requests.
* prometheus\_registration\_listen | string

  The ip prometheus registration will listen on, leave undefined to skip installation and setup of prometheus
  registration, set to 0.0.0.0 to listen on all interfaces.
* prometheus\_registration\_port | int

  Default: 12321

  The port the prometheus registration service will listen on.
* rules-repo | string

  Git repository with custom rules. Rules have to be in \*.rules files
* rules-update-notify-email | string

  Email address that will receive cronned rule update failure emails
* rules-update-schedule | string

  Default: \*/10 \* \* \* \*

  Cron format schedule used for refresh from external rules repo.
  Only used if "rules-repo" is set
* rules-update-ssh-key | string

  Plain text private SSH key used to for git authentication.
  Also see "rules-repo" config option
* scrape-interval | string

  Default: 15s

  Interval at which to scrape targets
* scrape-jobs | string

  Can be used to add custom scrape jobs, for example SNMP exporter config.
  This will be parsed as YAML, format is a list of dicts as shown in the example.
  For convenience "{{ snmp\_exporter }}" and "{{ blackbox\_exporter }}" will be
  replaced with SNMP and blackbox exporter addresses respectively.
  Example:

  + job\_name: 'snmp'
    scrape\_interval: 1m
    scrape\_timeout: 1m
    static\_configs:
    - targets:
      * device1.example.com
      * device2.example.com
        params:
        module: [default]
        relabel\_configs:
    - source\_labels: [**address**]
      target\_label: \_\_param\_target
    - source\_labels: [\_\_param\_target]
      target\_label: instance
    - target\_label: **address**
      replacement: "{{ snmp\_exporter }}" # SNMP exporter.
  + job\_name: 'my-job'
    scrape\_interval: 30s
    scrape\_timeout: 30s
    static\_configs:
    - targets:
      * server1.example.com
      * server2.example.com
* snap\_channel | string

  Default: stable

  If install\_method is set to "snap" this option controlls channel name.
  Supported values are: "stable", "candidate", "beta" and "edge"
* snap\_proxy | string

  DEPRECATED. Use snap-http-proxy and snap-https-proxy model configuration settings. HTTP/HTTPS web proxy for Snappy to use when accessing the snap store.
* snap\_proxy\_url | string

  DEPRECATED. Use snap-store-proxy model configuration setting. The address of a Snap Store Proxy to use for snaps e.g. http://snap-proxy.example.com
* snapd\_refresh | string

  How often snapd handles updates for installed snaps. The default (an empty string) is 4x per day. Set to "max" to check once per month based on the charm deployment date. You may also set a custom string as described in the 'refresh.timer' section here:
  https://forum.snapcraft.io/t/system-options/87
* static-targets | string

  Where to gather metrics from.
  Examples:
  host1.maas:9090
  host1.maas:9090, host2.maas:9090
* web-listen-port | int

  Default: 9090

  Port to listen on for the web interface, API, and telemetry.