Skip to content

Latest commit

 

History

History
104 lines (76 loc) · 3.6 KB

README.md

File metadata and controls

104 lines (76 loc) · 3.6 KB
Raw

Glove

Prometheus Exporter Boilerplate

Documentation

Linux Deployment

Download the latest Glove binary. Make it executable from everywhere.

$ export LATEST_VERSION=$(curl --silent "https://api.github.com/repos/clivern/glove/releases/latest" | jq '.tag_name' | sed -E 's/.*"([^"]+)".*/\1/' | tr -d v)

$ curl -sL https://github.com/clivern/glove/releases/download/v{$LATEST_VERSION}/glove_{$LATEST_VERSION}_Linux_x86_64.tar.gz | tar xz

Create the configs file config.yml from config.dist.yml. Something like the following:

# App configs
app:
  # App name
  name: ${APP_NAME:-glove}
  # Env mode (dev or prod)
  mode: ${APP_MODE:-prod}
  # HTTP port
  port: ${API_PORT:-9253}
  # Hostname
  hostname: ${API_HOSTNAME:-127.0.0.1}
  # TLS configs
  tls:
    status: ${API_TLS_STATUS:-off}
    crt_path: ${API_TLS_PEMPATH:-cert/server.crt}
    key_path: ${API_TLS_KEYPATH:-cert/server.key}

  # Global timeout
  timeout: ${API_TIMEOUT:-50}

  # Log configs
  log:
    # Log level, it can be debug, info, warn, error, panic, fatal
    level: ${LOG_LEVEL:-info}
    # Output can be stdout or abs path to log file /var/logs/glove.log
    output: ${LOG_OUTPUT:-/var/logs/glove.log}
    # Format can be json
    format: ${LOG_FORMAT:-json}

The run the Glove with systemd

$ glove server -c /path/to/config.yml

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Glove is maintained under the Semantic Versioning guidelines and release process is predictable and business-friendly.

See the Releases section of our GitHub project for changelogs for each release version of Glove. It contains summaries of the most noteworthy changes made in each release.

Bug tracker

If you have any suggestions, bug reports, or annoyances please report them to our issue tracker at https://github.com/Clivern/glove/issues

Security Issues

If you discover a security vulnerability within Glove, please send an email to hello@clivern.com

Contributing

We are an open source, community-driven project so please feel free to join us. see the contributing guidelines for more details.

License

© 2022, Clivern. Released under MIT License.

Glove is authored and maintained by @Clivern.