notifier

notifier

Getting started

Golang binary is built with static link. You can download it directly from the GitHub Release page or build it by yourself by cloning this repo and running make.

A Docker image is available for amd64, arm and arm64 platforms on Docker Hub: vibioh/notifier.

You can configure app by passing CLI args or environment variables (cf. Usage section). CLI override environment variables.

You'll find a Kubernetes exemple in the infra/ folder, using my app chart

CI

Following variables are required for CI:

Usage

The application can be configured by passing CLI args described below or their equivalent as environment variable. CLI values take precedence over environments variables.

Be careful when using the CLI values, if someone list the processes on the system, they will appear in plain-text. Pass secrets by environment variables: it's less easily visible.

Usage of notifier:
  -address string
        [server] Listen address {NOTIFIER_ADDRESS}
  -alertmanagerRecipient string
        [alertmanager] Alertmanager recipient {NOTIFIER_ALERTMANAGER_RECIPIENT}
  -alertmanagerSender string
        [alertmanager] Alertmanager sender {NOTIFIER_ALERTMANAGER_SENDER}
  -cert string
        [server] Certificate file {NOTIFIER_CERT}
  -corsCredentials
        [cors] Access-Control-Allow-Credentials {NOTIFIER_CORS_CREDENTIALS}
  -corsExpose string
        [cors] Access-Control-Expose-Headers {NOTIFIER_CORS_EXPOSE}
  -corsHeaders string
        [cors] Access-Control-Allow-Headers {NOTIFIER_CORS_HEADERS} (default "Content-Type")
  -corsMethods string
        [cors] Access-Control-Allow-Methods {NOTIFIER_CORS_METHODS} (default "GET")
  -corsOrigin string
        [cors] Access-Control-Allow-Origin {NOTIFIER_CORS_ORIGIN} (default "*")
  -csp string
        [owasp] Content-Security-Policy {NOTIFIER_CSP} (default "default-src 'self'; base-uri 'self'")
  -frameOptions string
        [owasp] X-Frame-Options {NOTIFIER_FRAME_OPTIONS} (default "deny")
  -graceDuration duration
        [http] Grace duration when SIGTERM received {NOTIFIER_GRACE_DURATION} (default 30s)
  -hsts
        [owasp] Indicate Strict Transport Security {NOTIFIER_HSTS} (default true)
  -idleTimeout duration
        [server] Idle Timeout {NOTIFIER_IDLE_TIMEOUT} (default 2m0s)
  -key string
        [server] Key file {NOTIFIER_KEY}
  -loggerJson
        [logger] Log format as JSON {NOTIFIER_LOGGER_JSON}
  -loggerLevel string
        [logger] Logger level {NOTIFIER_LOGGER_LEVEL} (default "INFO")
  -loggerLevelKey string
        [logger] Key for level in JSON {NOTIFIER_LOGGER_LEVEL_KEY} (default "level")
  -loggerMessageKey string
        [logger] Key for message in JSON {NOTIFIER_LOGGER_MESSAGE_KEY} (default "message")
  -loggerTimeKey string
        [logger] Key for timestamp in JSON {NOTIFIER_LOGGER_TIME_KEY} (default "time")
  -mailerName string
        [mailer] HTTP Username or AMQP Exchange name {NOTIFIER_MAILER_NAME} (default "mailer")
  -mailerPassword string
        [mailer] HTTP Pass {NOTIFIER_MAILER_PASSWORD}
  -mailerURL string
        [mailer] URL (https?:// or amqps?://) {NOTIFIER_MAILER_URL}
  -okStatus int
        [http] Healthy HTTP Status code {NOTIFIER_OK_STATUS} (default 204)
  -port uint
        [server] Listen port (0 to disable) {NOTIFIER_PORT} (default 1080)
  -prometheusAddress string
        [prometheus] Listen address {NOTIFIER_PROMETHEUS_ADDRESS}
  -prometheusCert string
        [prometheus] Certificate file {NOTIFIER_PROMETHEUS_CERT}
  -prometheusGzip
        [prometheus] Enable gzip compression of metrics output {NOTIFIER_PROMETHEUS_GZIP}
  -prometheusIdleTimeout duration
        [prometheus] Idle Timeout {NOTIFIER_PROMETHEUS_IDLE_TIMEOUT} (default 10s)
  -prometheusIgnore string
        [prometheus] Ignored path prefixes for metrics, comma separated {NOTIFIER_PROMETHEUS_IGNORE}
  -prometheusKey string
        [prometheus] Key file {NOTIFIER_PROMETHEUS_KEY}
  -prometheusPort uint
        [prometheus] Listen port (0 to disable) {NOTIFIER_PROMETHEUS_PORT} (default 9090)
  -prometheusReadTimeout duration
        [prometheus] Read Timeout {NOTIFIER_PROMETHEUS_READ_TIMEOUT} (default 5s)
  -prometheusShutdownTimeout duration
        [prometheus] Shutdown Timeout {NOTIFIER_PROMETHEUS_SHUTDOWN_TIMEOUT} (default 5s)
  -prometheusWriteTimeout duration
        [prometheus] Write Timeout {NOTIFIER_PROMETHEUS_WRITE_TIMEOUT} (default 10s)
  -readTimeout duration
        [server] Read Timeout {NOTIFIER_READ_TIMEOUT} (default 5s)
  -shutdownTimeout duration
        [server] Shutdown Timeout {NOTIFIER_SHUTDOWN_TIMEOUT} (default 10s)
  -tracerRate string
        [tracer] Jaeger sample rate, 'always', 'never' or a float value {NOTIFIER_TRACER_RATE} (default "always")
  -tracerURL string
        [tracer] Jaeger endpoint URL (e.g. http://jaeger:14268/api/traces) {NOTIFIER_TRACER_URL}
  -url string
        [alcotest] URL to check {NOTIFIER_URL}
  -userAgent string
        [alcotest] User-Agent for check {NOTIFIER_USER_AGENT} (default "Alcotest")
  -writeTimeout duration
        [server] Write Timeout {NOTIFIER_WRITE_TIMEOUT} (default 10s)