logsettings.json Parameters - ironstream_for_kafka - Ironstream_Hub - ironstream_for_elastic - ironstream_for_splunk - 1.3

Ironstream Hub Administration

Product type
Software
Portfolio
Integrate
Product family
Ironstream
Product
Ironstream > Ironstream for Elastic®
Ironstream > Ironstream Hub
Ironstream > Ironstream for Splunk®
Ironstream > Ironstream for Kafka®
Version
1.3
Language
English
ContentType
Administration
Product name
Ironstream Hub
Title
Ironstream Hub Administration
First publish date
2022
ft:lastEdition
2024-04-15
ft:lastPublication
2024-04-15T10:44:03.897025

Fields

Description

Valid Values

LogType

User logs have these characteristics:

  • Messages about the operation of the product that can be understood by the user.
  • They will be written in the localized language of the server, if a language pack for the server’s language exists within product.

Trace logs have these characteristics:

  • For use by Precisely developers and support engineers for the purpose of diagnosis.
  • All User Logs messages will appear within Traces.
  • All Trace messages will be written in the Developer lingua franca – English.
  • The stack trace whenever the program encounters a critical system error.
  • Includes the monitoring details providing pipeline status values and other metrics.

User, Trace

LogLevel

The maximum level of messages that will be written by the log.

For example, if LogLevel is set to Info, then it will write all messages that are Info, Warning, and Error. It will not write Verbose messages.

Verbose, Info, Warning, Error

Format

Logs can be written in Text or Json format.

For JSON - more easily consumed by log parsing software such as Splunk or Log Stash.

For Text - more easily readable by humans.

Text, Json

OutputTarget

If Hub is running in a Docker container it may be useful to write to standard output and standard error. This ensures that the logs are available using the docker log command.

When OutputTarget is set to File the presence of a LogFileSettings key/value pair is mandatory. The fields of the LogFileSettings object can be found in the table below. The fields are mandatory.

Files generated by using the File target are created in the Log Directory.

File, Stdout, Stderr

IncludeMethodName

If set to true, then each log message will contain the function name, file name and line number of where the logging system has been invoked.

This can be useful for Precisely Support when diagnosing issues.

true, false