Commit d87a4df1 authored by Marc Vef's avatar Marc Vef
Browse files

Merge branch 'rnou/stats_prometheus' into 'master' 

Push stats to prometheus

See merge request !132
parents 126a171c 6d30ca4e

.gitlab-ci.yml

+2 −0
Original line number Diff line number Diff line
@@ -61,6 +61,8 @@ gkfs: 
      -DGKFS_USE_GUIDED_DISTRIBUTION:BOOL=ON

      -DGKFS_ENABLE_PARALLAX:BOOL=ON

      -DGKFS_ENABLE_ROCKSDB:BOOL=ON

      -DGKFS_CHUNK_STATS:BOOL=ON

      -DGKFS_ENABLE_PROMETHEUS:BOOL=ON

      ${CI_PROJECT_DIR}

    - make -j$(nproc) install

    # reduce artifacts size

CHANGELOG.md

+11 −0
Original line number Diff line number Diff line
@@ -7,8 +7,19 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 


## [Unreleased]





### New



- Added statistics gathering on daemons ([!132](https://storage.bsc.es/gitlab/hpc/gekkofs/-/merge_requests/132)).

    - Stats output can be enabled with:

    - `--enable-collection` collects normal statistics.

    - `--enable-chunkstats` collects extended chunk statistics.

- Statistics output to file is controlled by `--output-stats <filename>`

- Added Prometheus support for outputting

  statistics ([!132](https://storage.bsc.es/gitlab/hpc/gekkofs/-/merge_requests/132)):

    - Prometheus dependency optional and enabled at compile time with the CMake argument `GKFS_ENABLE_PROMETHEUS`.

    - `--enable-prometheus` enables statistics pushing to Prometheus if statistics are enabled.

    - `--prometheus-gateway` sets an IP and port for the Prometheus connection.

- Added new experimental metadata backend:

  Parallax ([!110](https://storage.bsc.es/gitlab/hpc/gekkofs/-/merge_requests/110)).

    - Added support to use multiple metadata backends.

CMakeLists.txt

+6 −0
Original line number Diff line number Diff line
@@ -195,6 +195,12 @@ if(GKFS_USE_GUIDED_DISTRIBUTION) 
    message(STATUS "[gekkofs] Guided data distributor input file path: ${GKFS_USE_GUIDED_DISTRIBUTION_PATH}")

endif()



option(GKFS_ENABLE_PROMETHEUS "Enable Prometheus Push " OFF)

if(GKFS_ENABLE_PROMETHEUS)

    add_definitions(-DGKFS_ENABLE_PROMETHEUS)

endif ()

message(STATUS "[gekkofs] Prometheus Output: ${GKFS_ENABLE_PROMETHEUS}")



configure_file(include/common/cmake_configure.hpp.in include/common/cmake_configure.hpp)

README.md

+21 −5
Original line number Diff line number Diff line
@@ -109,6 +109,11 @@ Options: 
                              RocksDB is default if not set. Parallax support is experimental.

                              Note, parallaxdb creates a file called rocksdbx with 8GB created in metadir.

  --parallaxsize TEXT         parallaxdb - metadata file size in GB (default 8GB), used only with new files

  --enable-collection         Enables collection of general statistics. Output requires either the --output-stats or --enable-prometheus argument.

  --enable-chunkstats         Enables collection of data chunk statistics in I/O operations.Output requires either the --output-stats or --enable-prometheus argument.

  --output-stats TEXT         Creates a thread that outputs the server stats each 10s to the specified file.

  --enable-prometheus         Enables prometheus output and a corresponding thread.

  --prometheus-gateway TEXT   Defines the prometheus gateway <ip:port> (Default 127.0.0.1:9091).

  --version                   Print version and exit.

```
@@ -231,19 +236,30 @@ Then, the `examples/distributors/guided/generate.py` scrpt is used to create the 
Finally, modify `guided_config.txt` to your distribution requirements.



### Metadata Backends

There are two different metadata backends in GekkoFS. The default one uses `rocksdb`, however an alternative based on `PARALLAX` from `FORTH` 

is available.

To enable it use the `-DGKFS_ENABLE_PARALLAX:BOOL=ON` option, you can also disable `rocksdb` with `-DGKFS_ENABLE_ROCKSDB:BOOL=OFF`.



There are two different metadata backends in GekkoFS. The default one uses `rocksdb`, however an alternative based

on `PARALLAX` from `FORTH`

is available. To enable it use the `-DGKFS_ENABLE_PARALLAX:BOOL=ON` option, you can also disable `rocksdb`

with `-DGKFS_ENABLE_ROCKSDB:BOOL=OFF`.



Once it is enabled, `--dbbackend` option will be functional.



### Statistics



GekkoFS daemons are able to output general operations (`--enable-collection`) and data chunk

statistics (`--enable-chunkstats`) to a specified output file via `--output-stats <FILE>`. Prometheus can also be used

instead or in addition to the output file. It must be enabled at compile time via the CMake

argument `-DGKFS_ENABLE_PROMETHEUS` and the daemon argument `--enable-prometheus`. The corresponding statistics are then

pushed to the Prometheus instance.



### Acknowledgment



This software was partially supported by the EC H2020 funded NEXTGenIO project (Project ID: 671951, www.nextgenio.eu).



This software was partially supported by the ADA-FS project under the SPPEXA project (http://www.sppexa.de/) funded by the DFG.

This software was partially supported by the ADA-FS project under the SPPEXA project (http://www.sppexa.de/) funded by

the DFG.



This software is partially supported by the FIDIUM project funded by the DFG.



This software is partially supported by the ADMIRE project (https://www.admire-eurohpc.eu/) funded by the European Union’s Horizon 2020 JTI-EuroHPC Research and Innovation Programme (Grant 956748).
 
This software is partially supported by the ADMIRE project (https://www.admire-eurohpc.eu/) funded by the European

Union’s Horizon 2020 JTI-EuroHPC Research and Innovation Programme (Grant 956748).

docker/0.9.1/deps/Dockerfile

+1 −1
Original line number Diff line number Diff line
@@ -21,7 +21,7 @@ RUN apt-get update && \ 
		python3-dev \

		python3-venv \

		python3-setuptools \

    libnuma-dev libyaml-dev \

    libnuma-dev libyaml-dev libcurl4-openssl-dev \

    procps && \

    python3 -m pip install --upgrade pip && \

    rm -rf /var/lib/apt/lists/* && \