io.quarkiverse.logging.splunk.SplunkHandlerConfig.jdp Maven / Gradle / Ivy
#
#Tue Dec 19 10:08:38 UTC 2023
io.quarkiverse.logging.splunk.SplunkHandlerConfig.batchSizeCount=Maximum number of events in a batch. By default 10, if 0 no batching.
io.quarkiverse.logging.splunk.SplunkHandlerConfig.enabled=Determine whether to enable the handler
io.quarkiverse.logging.splunk.SplunkHandlerConfig.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.SplunkHandlerConfig.async=AsyncHandler config\n
\nThis is independent of the SendMode, i.e. whether the HTTP client is async or not.
io.quarkiverse.logging.splunk.SplunkHandlerConfig.level=The splunk handler log level. By default, it is no more strict than the root handler level.
io.quarkiverse.logging.splunk.SplunkHandlerConfig.metadataSeverityFieldName=The name of the key used to convey the severity / log level in the metadata fields.\nOnly applicable to 'flat' serialization.\nWith 'nested' serialization, there is already a 'severity' field.
io.quarkiverse.logging.splunk.SplunkHandlerConfig.metadataFields=Optional static key/value pairs to populate the "fields" key of event metadata. This isn't\napplicable to raw serialization.\nhttps\://docs.splunk.com/Documentation/Splunk/latest/Data/FormateventsforHTTPEventCollector\#Event_metadata
io.quarkiverse.logging.splunk.SplunkHandlerConfig.url=Splunk HEC endpoint base url.\n
\nWith raw events, the endpoint targeted is /services/collector/raw.\nWith flat or nested JSON events, the endpoint targeted is /services/collector/event/1.0.
io.quarkiverse.logging.splunk.SplunkHandlerConfig.disableCertificateValidation=Disable TLS certificate validation with HEC endpoint
io.quarkiverse.logging.splunk.SplunkHandlerConfig.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/latest/Data/AboutHECIDXAck\#About_channels_and_sending_data
io.quarkiverse.logging.splunk.SplunkHandlerConfig.token=The application token to authenticate with HEC, the token is mandatory if the extension is enabled\nhttps\://docs.splunk.com/Documentation/Splunk/latest/Data/FormateventsforHTTPEventCollector\#HEC_token
io.quarkiverse.logging.splunk.SplunkHandlerConfig.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.SplunkHandlerConfig.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/latest/Data/FormateventsforHTTPEventCollector\#Event_metadata
io.quarkiverse.logging.splunk.SplunkHandlerConfig.serialization=The format of the payload.\n
\n- With raw serialization, the log message is sent 'as is' in the HTTP body. Metadata can only be common to a whole\nbatch and are sent via HTTP parameters.\n
- With nested serialization, the log message is sent into a 'message' field of a JSON structure which also contains\ndynamic metadata.\n
- With flat serialization, the log message is sent into the root 'event' field. Dynamic metadata is sent via the\n'fields' root object.\n
io.quarkiverse.logging.splunk.SplunkHandlerConfig.batchSizeBytes=Maximum total size in bytes of events in a batch. By default 10KB, if 0 no batching.
io.quarkiverse.logging.splunk.SplunkHandlerConfig.raw=Determines whether the events are sent in raw mode. In case the raw event (i.e. the actual log message)\nis not a JSON object you need to explicitly set a source type or Splunk will reject the event (the\ndefault source type, _json, assumes that the incoming event can be parsed as JSON)\n\n@deprecated Use {@link \#serialization}
io.quarkiverse.logging.splunk.SplunkHandlerConfig.metadataSourceType=The optional format of the events, to enable some parsing on Splunk side.\nhttps\://docs.splunk.com/Documentation/Splunk/latest/Data/FormateventsforHTTPEventCollector\#Event_metadata\n\nA given source type may have indexed fields extraction enabled, which is the case of the built-in _json used for nested\nserialization.
io.quarkiverse.logging.splunk.SplunkHandlerConfig.maxRetries=Maximum number of retries in case of I/O exceptions with HEC connection.
io.quarkiverse.logging.splunk.SplunkHandlerConfig.includeThreadName=Whether to send the thread name as a structured metadata of the log event (equivalent of %t in a formatted message).\nOnly applicable to 'nested' serialization.
io.quarkiverse.logging.splunk.SplunkHandlerConfig.batchInterval=Batching delay before sending a group of events.\nIf 0, the events are sent immediately.
io.quarkiverse.logging.splunk.SplunkHandlerConfig.includeLoggerName=Whether to send the logger name as a structured metadata of the log event (equivalent of %c in a formatted message).\nOnly applicable to 'nested' serialization.
io.quarkiverse.logging.splunk.SplunkHandlerConfig.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).\nOnly applicable to 'nested' serialization.
io.quarkiverse.logging.splunk.SplunkHandlerConfig.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/latest/Data/FormateventsforHTTPEventCollector\#Event_metadata
io.quarkiverse.logging.splunk.SplunkHandlerConfig.metadataHost=Overrides the host name metadata value.