šŸ˜¬ hyperglass 2.0 and its documentation is still in development!
Configuration
Logging & Webhooks

Logging

Console, file, HTTP, and/or syslog logging configuration.

ParameterTypeDefault ValueDescription
directoryString/tmpPath to directory where logs will be created.
formatStringtextLog text format, must be text or json.
max_sizeString50MBMaximum log file size before being overwritten.

Syslog

ParameterTypeDefault ValueDescription
hostStringSyslog target host.
portNumber514Syslog target UDP port.
Syslog Example
config.yaml
logging:
    syslog:
        host: log.example.com
        port: 514

HTTP Logging

If enabled, logs will be sent by HTTP POST method.

ParameterTypeDefault ValueDescription
providerStringgenericMust be generic, msteams, or slack.
hostStringURL
headersMap
paramsMap
verify_sslBooleantrueEnable or disable SSL certificate verification.
timeoutNumber5HTTP connection timeout in seconds.

Authentication

Authentication is supported using HTTP basic authentication or an API key.

ParameterTypeDefault ValueDescription
http.authentication.modeStringbasicMust be basic or api_key.
http.authentication.usernameStringBasic authentication username if mode is set to basic.
http.authentication.passwordStringBasic authentication password if mode is set to basic, or API key value if mode is set to api_key.
http.authentication.headerStringX-API-KeyHeader name if mode is set to api_key.

Examples

Generic
config.yaml
logging:
    http:
        provider: generic
        host: https://httpbin.org
        headers:
            x-special-header: super special header value
        params:
            source: hyperglass
        verify_ssl: true
        timeout: 5
        authentication:
            mode: basic
            username: your username
            password: super secret password

In the above example, hyperglass will send a POST request to https://httpbin.org?source=hyperglass with Basic Authentication headers set.

Microsoft Teams Webhook
config.yaml
logging:
    http:
        provider: msteams
        host: <MS Teams webhook URL>
Slack
config.yaml
logging:
    http:
        provider: slack
        host: <Slack webhook URL>