cinc_server_exporter 0.1.0

A prometheus exporter for CINC Server and CINC compatible configuration management solutions.
cinc_server_exporter-0.1.0 is not a library.

Contributors Forks Stargazers Issues MIT License LinkedIn

About The Project

While working at my current gig I found we were lacking some metrics to gain a deeper visibility in to our infrastructure. I built this exporter to fill some of those gaps.

Getting Started

This project assumes you have cinc-server installed with the default database settings.

Installation

  1. Switch to the database user
    sudo su - opscode-pgsql
    
  2. pull latest release
    wget # automated builds/releases coming soon
    
  3. run the service
    ./cinc_server_exporter
    
  4. test
    curl http://localhost:9165/metrics
    

Development Setup

Recommended prerequesites

  • nix
  • devenv.sh
  • direnv

Building and running

  1. Pull latest code
    git clone https://github.com/esoterick/cinc_server_exporter.git
    
  2. Enter project directory
    cd cinc_server_exporter
    
  3. Allow direnv and let nix to do it's thing
    direnv allow .
    
  4. Run test database
    devenv up
    
  5. Import Test Data
    # coming soon :(
    
  6. Run exporter
    cargo run
    
  7. Scrape
    curl http://localhost:9165/metrics
    

Usage

There are a handful of options to configure the exporter which is done via the following environment variables.

  • CINC_SERVER_EXPORTER_CONN_STRING - Postgres connection string to the CINC database
  • CINC_SERVER_EXPORTER_INTERVAL - Interval to scrape the database in seconds

Roadmap

  • Add changelog
  • Add test data
  • Add tests
  • Document configuration options
  • Add automated builds
  • Add release url to docs

See the open issues for a full list of proposed features (and known issues).

Contributing

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Robert J. Lambert III - robert.j.lambert@pm.me Project Link: https://github.com/esoterick/cinc_server_exporter

Acknowledgments