Uses of Class
io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Packages that use NtfyLog4j2Appender.Builder

Package	Description
io.github.pimak.ntfy.log4j2

Uses of NtfyLog4j2Appender.Builder in io.github.pimak.ntfy.log4j2

Methods in io.github.pimak.ntfy.log4j2 that return NtfyLog4j2Appender.Builder

Modifier and Type	Method	Description
static NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.newBuilder()	The plugin builder log4j2 instantiates for an <Ntfy .../> element.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setActions(String actions)	Action buttons as a raw ntfy Actions header value (short format, e.g.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setAppName(String appName)	Application name used as the title prefix when no explicit title is set.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setAsync(String async)	Opt into asynchronous (offloaded) delivery: individual error alerts are handed to the engine's bounded work queue and published by a daemon worker, so a slow/unreachable ntfy server never blocks the logging thread.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setAsyncQueueCapacity(String asyncQueueCapacity)	Bounded async delivery queue capacity; only consulted when async is "true".
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setCache(String cache)	false asks the server not to store the message (Cache: no).
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setClickUrl(String clickUrl)	URL opened when a notification is tapped (ntfy Click header).
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setConnectTimeout(String connectTimeout)	HTTP connect timeout as a duration string (bare int = ms, Nms/Ns/Nm/Nh/Nd, or ISO-8601).
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setDigestPriority(String digestPriority)	ntfy Priority header for the aggregated digest.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setDigestTags(String digestTags)	ntfy Tags header for the aggregated digest.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setEnabled(String enabled)	Master switch; "false" keeps the appender inert even with a complete configuration.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setErrorPriority(String errorPriority)	ntfy Priority header for individual error alerts.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setErrorTags(String errorTags)	ntfy Tags header for individual error alerts.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setExcludedExceptionTypes(String excludedExceptionTypes)	A single comma-separated value of fully qualified exception class names.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setExcludedLoggers(String excludedLoggers)	A single comma-separated value of logger-name prefixes to exclude from alerting.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setFirebase(String firebase)	false asks the server not to forward the message to Firebase (Firebase: no).
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setIcon(String icon)	URL of the icon shown beside the notification (ntfy Icon header).
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setIconsByLogger(String iconsByLogger)	Per-logger icon overrides as prefix=url pairs separated by commas.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setIncludeMdcKeys(String includeMdcKeys)	A single comma-separated allow-list of MDC keys whose values are rendered into alert bodies, one key: value line each.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setLocale(String locale)	Language of notification bodies and diagnostics as a BCP 47 tag (e.g.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setMaxAlertsPerWindow(String maxAlertsPerWindow)	Individual alerts allowed per suppression window before digesting kicks in (integer).
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setMaxStackFrames(String maxStackFrames)	Maximum root-cause stack frames included in the notification body (integer).
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setPassword(String password)	Basic-authentication password.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setRequestTimeout(String requestTimeout)	HTTP request timeout as a duration string (bare int = ms, Nms/Ns/Nm/Nh/Nd, or ISO-8601).
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setRequireHttpsForCredentials(String requireHttpsForCredentials)	Strict mode: refuse engine activation (rather than only warn) when credentials would be sent over a cleartext http:// endpoint.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setStartupPing(String startupPing)	Opt-in startup self-test verifying at boot that the configured endpoint, credentials and topic actually work — instead of finding out when the first real error alert fails to deliver.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setStartupPingFailFast(String startupPingFailFast)	Whether a failed startup self-test aborts application startup instead of only warning.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setStartupPingNotifyFailures(String startupPingNotifyFailures)	Whether a failed self-test is announced on a route that passed.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setStartupPingWarn(String startupPingWarn)	Startup self-test for the optional WARN route, independent of startupPing.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setSuppressionWindow(String suppressionWindow)	Length of the rate-limiting/digest window as a duration string (bare int = ms, Nms/Ns/Nm/Nh/Nd, or ISO-8601).
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setTitle(String title)	Fixed notification title; overrides the derived appName - RootCause title.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setToken(String token)	Bearer token authentication (takes precedence over username/password).
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setTopic(String topic)	Topic alerts are published to.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setUrl(String url)	Base URL of the ntfy server, e.g.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setUsername(String username)	Basic-authentication user name.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setWarnPriority(String warnPriority)	ntfy Priority header for WARN alerts and the WARN digest; default default.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setWarnTags(String warnTags)	ntfy Tags header for WARN alerts and the WARN digest; default warning.
NtfyLog4j2Appender.Builder	NtfyLog4j2Appender.Builder.setWarnTopic(String warnTopic)	The topic WARN-level events are published to.