Monitoring

General

The monitoring endpoints do not go through authorization checks. Also they are not restricted to localhost.

The meters are not per project on purpose. Firstly, to avoid metric cardinality explosion, secondly not to leak any private information (given the above).

Keep in mind that the names of the meters are very much volatile right now. They will stabilize over time.

web application

/metrics/prometheus serves metrics in the Prometheus format. If the web application is running on https://foo.bar/source/ then the URL for the metrics will be https://foo.bar/source/metrics/prometheus

Insert this snippet into /etc/prometheus/prometheus.yml:

  - job_name: opengrok

    metrics_path: '/source/metrics/prometheus'
    static_configs:
      # replace with actual server name and port (defaults to HTTP)
      - targets: ['localhost:8080']

and reload the Prometheus configuration. The web application metrics will become available.

Notable metrics start with:

• jvm
• authorization
• requests