Skip to content

Latest commit

 

History

History
149 lines (111 loc) · 4.88 KB

README.md

File metadata and controls

149 lines (111 loc) · 4.88 KB
Raw

Alces Concertim Metric Reporting Daemon

Overview

Concertim Metric Reporting Daemon (ct-metric-reporting-daemon) provides a HTTP API for metrics to be reported to Concertim.

The reported metrics are periodically processed by Metric Reporting Daemon. The processing creates various summaries of the reported metrics and saves them in RRD files.

The metrics and the associated views are made available over a HTTP API.

Quick start

  1. Clone the repository 
    git clone https://github.com/openflighthpc/concertim-metric-reporting-daemon.git
  2. Build the docker image 
    docker build --network=host --tag concertim-metric-reporting-daemon:latest .
  3. Start the docker container 
    docker run -d --name concertim-metric-reporting-daemon \
	--network=host \
	concertim-metric-reporting-daemon

Use Concertim OpenStack Service to collect and report metrics and use Concertim Visualisation App to view the reported metrics.

Building the docker image

Concertim Metric Reporting Daemon is intended to be deployed as a Docker container. There is a Dockerfile in this repo for building the image.

  1. Clone the repository 
    git clone https://github.com/openflighthpc/concertim-metric-reporting-daemon.git
  2. Build the docker image 
    docker build --network=host --tag concertim-metric-reporting-daemon:latest .

Configuration

Peristent RRD files

The metrics reported to Metric Reporting Daemon are stored in RRD files. To ensure that the RRD files outlive the container a volume should be used. The example below uses the host directory /var/lib/metric-reporting-daemon/rrds.

sudo mkdir -p /var/lib/metric-reporting-daemon/rrds

Mount the directory /var/lib/metric-reporting-daemon/rrds to /var/lib/metric-reporting-daemon/rrds when starting the docker container.

docker run --name concertim-metric-reporting-daemon \
    --network=host \
    --volume /var/lib/metric-reporting-daemon/rrds:/var/lib/metric-reporting-daemon/rrds \
    concertim-metric-reporting-daemon

Configuration file

You can optionally, copy the configuration file to the host, make changes to it and mount it to the container.

sudo cp -a config/config.prod.yml /etc/metric-reporting-daemon/config.yml
$EDITOR /etc/metric-reporting-daemon/config.yml

Mount the configuration file to /opt/concertim/etc/metric-reporting-daemon/config.yml when starting the container.

docker run --name concertim-metric-reporting-daemon \
    --network=host \
    --volume /etc/metric-reporting-daemon/config.yml:/opt/concertim/etc/metric-reporting-daemon/config.yml \
    concertim-metric-reporting-daemon

Usage

Once the docker image has been built, the RRD persistent storage created and the config file copied to the host, the container can be started with the following command.

docker run -d --name concertim-metric-reporting-daemon \
    --network=host \
    --volume /var/lib/metric-reporting-daemon/rrds/:/var/lib/metric-reporting-daemon/rrds/ \
    --volume /etc/metric-reporting-daemon/config.yml:/opt/concertim/etc/metric-reporting-daemon/config.yml \
    concertim-metric-reporting-daemon

HTTP API

See the usage docs for details on the HTTP API for reporting and querying metrics.

Development

See the development docs for details on development and getting started with development.

Deployment

Concertim Metric Reporting Daemon is deployed as part of the Concertim appliance using the Concertim ansible playbook.

Contributing

Fork the project. Make your feature addition or bug fix. Send a pull request. Bonus points for topic branches.

Read CONTRIBUTING.md for more details.

Copyright and License

Eclipse Public License 2.0, see LICENSE.txt for details.

Copyright (C) 2024-present Alces Flight Ltd.

This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at https://www.eclipse.org/legal/epl-2.0, or alternative license terms made available by Alces Flight Ltd - please direct inquiries about licensing to [email protected].

Concertim Metric Reporting Daemon is distributed in the hope that it will be useful, but WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. See the Eclipse Public License 2.0 for more details.