Skip to content

Commit

Permalink
docs(README): update console help output
Browse files Browse the repository at this point in the history
  • Loading branch information
@maxwo
maxwo authored Sep 29, 2024
1 parent 19c3e1c commit 3435a0f
Showing 1 changed file with 50 additions and 25 deletions.
75 changes: 50 additions & 25 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,63 +102,88 @@ A tool to relay Prometheus alerts as SNMP traps
Flags:
-h, --[no-]help Show context-sensitive help (also try --help-long and --help-man).
-h, --[no-]help Show context-sensitive help (also try
--help-long and --help-man).
--[no-]web.systemd-socket Use systemd socket activation listeners instead
of port listeners (Linux only).
--web.listen-address=:9464 ...
Addresses on which to expose metrics and web interface. Repeatable for multiple addresses.
--web.config.file="" [EXPERIMENTAL] Path to configuration file that can enable TLS or authentication. See:
Addresses on which to expose metrics and web
interface. Repeatable for multiple addresses.
--web.config.file="" Path to configuration file that can
enable TLS or authentication. See:
https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md
--alert.severity-label="severity"
Label where to find the alert severity.
--alert.severities="critical,warning,info"
The ordered list of alert severities, from more priority to less priority.
The ordered list of alert severities, from more
priority to less priority.
--alert.default-severity="critical"
The alert severity if none is provided via labels.
--snmp.version=V2c SNMP version. V2c and V3 are currently supported.
--snmp.sub-object-default-oid="1.3.6.1.4.1.123.456"
Base OID to use for the sub-objects of each trap. Defaults to the trap-default-oid
--snmp.destination=127.0.0.1:162
The alert severity if none is provided via
labels.
--snmp.version=V2c SNMP version. V2c and V3 are currently
supported.
--snmp.destination=127.0.0.1:162 ...
SNMP trap server destination.
--snmp.retries=1 SNMP number of retries
--snmp.trap-oid-label="oid"
Label where to find the trap OID.
--snmp.trap-default-oid="1.3.6.1.4.1.98789"
Trap OID to send if none is found in the alert labels.
Trap OID to send if none is found in the alert
labels.
--snmp.trap-description-template=description-template.tpl
SNMP description template.
--snmp.extra-field-template=4=extra-field-template.tpl ...
SNMP extra field templates, eg. --snmp.extra-field-templates=4=new-field.template.tpl to add a 4th
field to the trap, with the given template file. You may add several fields using that flag several
times.
SNMP extra field templates, eg.
--snmp.extra-field-templates=4=new-field.template.tpl
to add a 4th field to the trap, with the given
template file. You may add several fields using
that flag several times.
--snmp.timeout=5s SNMP timeout duration
--snmp.community="public" SNMP community (V2c only). Passing secrets to the command line is not recommended, consider using the
SNMP_NOTIFIER_COMMUNITY environment variable instead. ($SNMP_NOTIFIER_COMMUNITY)
--snmp.sub-object-default-oid=1.3.6.1.4.1.123.456
OID to use as the base of the sub-objects of
each trap.
--snmp.community="public" SNMP community (V2c only). Passing secrets to
the command line is not recommended, consider
using the SNMP_NOTIFIER_COMMUNITY environment
variable instead. ($SNMP_NOTIFIER_COMMUNITY)
--[no-]snmp.authentication-enabled
Enable SNMP authentication (V3 only).
--snmp.authentication-protocol=MD5
Protocol for password encryption (V3 only). MD5 and SHA are currently supported.
Protocol for password encryption (V3 only).
MD5 and SHA are currently supported.
--snmp.authentication-username=USERNAME
SNMP authentication username (V3 only). Passing secrets to the command line is not
recommended, consider using the SNMP_NOTIFIER_AUTH_USERNAME environment variable instead.
SNMP authentication username (V3 only). Passing
secrets to the command line is not recommended,
consider using the SNMP_NOTIFIER_AUTH_USERNAME
environment variable instead.
($SNMP_NOTIFIER_AUTH_USERNAME)
--snmp.authentication-password=PASSWORD
SNMP authentication password (V3 only). Passing secrets to the command line is not
recommended, consider using the SNMP_NOTIFIER_AUTH_PASSWORD environment variable instead.
SNMP authentication password (V3 only). Passing
secrets to the command line is not recommended,
consider using the SNMP_NOTIFIER_AUTH_PASSWORD
environment variable instead.
($SNMP_NOTIFIER_AUTH_PASSWORD)
--[no-]snmp.private-enabled
Enable SNMP encryption (V3 only).
--snmp.private-protocol=DES
Protocol for SNMP data transmission (V3 only). DES and AES are currently supported.
Protocol for SNMP data transmission (V3 only).
DES and AES are currently supported.
--snmp.private-password=SECRET
SNMP private password (V3 only). Passing secrets to the command line is not recommended, consider using
the SNMP_NOTIFIER_PRIV_PASSWORD environment variable instead. ($SNMP_NOTIFIER_PRIV_PASSWORD)
SNMP private password (V3 only). Passing
secrets to the command line is not recommended,
consider using the SNMP_NOTIFIER_PRIV_PASSWORD
environment variable instead.
($SNMP_NOTIFIER_PRIV_PASSWORD)
--snmp.security-engine-id=SECURITY_ENGINE_ID
SNMP security engine ID (V3 only).
--snmp.context-engine-id=CONTEXT_ENGINE_ID
SNMP context engine ID (V3 only).
--snmp.context-name=CONTEXT_ENGINE_NAME
SNMP context name (V3 only).
--log.level=info Only log messages with the given severity or above. One of: [debug, info, warn, error]
--log.format=logfmt Output format of log messages. One of: [logfmt, json]
--log.level=info Only log messages with the given severity or
above. One of: [debug, info, warn, error]
--log.format=logfmt Output format of log messages. One of: [logfmt,
json]
--[no-]version Show application version.
```

Expand Down

0 comments on commit 3435a0f

Please sign in to comment.