io.quarkiverse.logging.splunk.SplunkConfig.jdp Maven / Gradle / Ivy
#
#Tue Sep 28 15:47:16 UTC 2021
io.quarkiverse.logging.splunk.SplunkConfig.format=The log format, defining which metadata are inlined inside the log main payload.\n\nSpecific metadata (hostname, category, thread name, ...), as well as MDC key/value map, can also be sent in a structured\nway.
io.quarkiverse.logging.splunk.SplunkConfig.disableCertificateValidation=Disable TLS certificate validation with HEC endpoint
io.quarkiverse.logging.splunk.SplunkConfig.metadataHost=Overrides the host name metadata value.
io.quarkiverse.logging.splunk.SplunkConfig.url=Splunk HEC endpoint base url.\n
\nThe actual endpoint is expected at path /services/collector/events/1.0
io.quarkiverse.logging.splunk.SplunkConfig.batchInterval=Batching delay before sending a group of events.\nIf 0, the events are sent immediately.
io.quarkiverse.logging.splunk.SplunkConfig.metadataIndex=The optional name of the index by which the event data is to be stored. If set, it must be within the\nlist of allowed indexes of the token (if it has the indexes parameter set).\nhttps\://docs.splunk.com/Documentation/Splunk/8.1.0/Data/FormateventsforHTTPEventCollector\#Event_metadata
io.quarkiverse.logging.splunk.SplunkConfig.channel=A GUID to identify an HEC client and guarantee isolation at HEC level in case of slow clients.\nhttps\://docs.splunk.com/Documentation/Splunk/8.1.0/Data/AboutHECIDXAck\#About_channels_and_sending_data
io.quarkiverse.logging.splunk.SplunkConfig.enabled=Determine whether to enable the handler
io.quarkiverse.logging.splunk.SplunkConfig.token=The application token to authenticate with HEC, the token is mandatory if the extension is enabled\nhttps\://docs.splunk.com/Documentation/Splunk/8.1.0/Data/FormateventsforHTTPEventCollector\#HEC_token
io.quarkiverse.logging.splunk.SplunkConfig.includeException=Whether to send the thrown exception message as a structured metadata of the log event (as opposed to %e in a formatted\nmessage, it does not include the exception name or stacktrace)
io.quarkiverse.logging.splunk.SplunkConfig.sendMode=The strategy to send events to HEC.\n
\nIn sequential mode, there is only one HTTP connection to HEC and the order of events is preserved, but performance is\nlower.\nIn parallel mode, event batches are sent asynchronously over multiple HTTP connections, and events with the same\ntimestamp\n(that has 1 millisecond resolution) may be indexed out of order by Splunk.
io.quarkiverse.logging.splunk.SplunkConfig.batchSizeBytes=Maximum total size in bytes of events in a batch. By default 10KB, if 0 no batching.
io.quarkiverse.logging.splunk.SplunkConfig.includeLoggerName=Whether to send the logger name as a structured metadata of the log event (equivalent of %c in a formatted message)
io.quarkiverse.logging.splunk.SplunkConfig.batchSizeCount=Maximum number of events in a batch. By default 10, if 0 no batching.
io.quarkiverse.logging.splunk.SplunkConfig.includeThreadName=Whether to send the thread name as a structured metadata of the log event (equivalent of %t in a formatted message)
io.quarkiverse.logging.splunk.SplunkConfig.maxRetries=Maximum number of retries in case of I/O exceptions with HEC connection.
io.quarkiverse.logging.splunk.SplunkConfig.metadataSource=The source value to assign to the event data. For example, if you're sending data from an app you're developing,\nyou could set this key to the name of the app.\nhttps\://docs.splunk.com/Documentation/Splunk/8.1.0/Data/FormateventsforHTTPEventCollector\#Event_metadata
io.quarkiverse.logging.splunk.SplunkConfig.metadataSourceType=The source type value to assign to the event data\nhttps\://docs.splunk.com/Documentation/Splunk/8.1.0/Data/FormateventsforHTTPEventCollector\#Event_metadata\n
\nA given source type may have indexed fields extraction enabled, which is the case of the default built-in _json.
io.quarkiverse.logging.splunk.SplunkConfig.level=The splunk handler log level. By default it is not more strict than the root handler level.