How do I use Property Inspector to search for properties within the unified config files?

Deephaven v1.20190322 introduced unified configuration files (typically iris-common.prop). The property inspector utility includes an -all option that searches in all areas of a unified config file.

However, releases prior to v1.20190809 do not provide an option to search all areas of a unified config file.

As a workaround, we recommend that you pass the service name for which to search property settings. This is done with -j and -D on the iris_exec command line:

sudo -u irisadmin /usr/illumon/latest/bin/iris_exec property_inspector -j -Dservice.name=dbquery -- -pn tls.passphrase.file -pf /etc/sysconfig/illumon.d/resources/iris-common.prop

Service Name	Description
authentication_server	Validates user credentials.
client_update_service	Ensures each Deephaven instance has the latest configuration files.
db_acl_write_server	Access Control List write server.
iris_db_user_mod	Used to modify ACLs, which may be useful in batch jobs or when troubleshooting GUI problems.
db_dis	Data Import Service.
db_ltds	Local Table Data Service.
db_merge	Oversees data merges.
dbquery	The Query Server process used for most query workers.
db_tdcp	Table Data Cache Proxy.
iris_controller	Persistent Query Controller, which stores and governs all persistent queries.
controller_tool	Persistent Query Controller Tool, an administrative tool that interacts with the controller to perform various functions.
log_aggregator_service	Log Aggregator Service, part of the Deephaven data pipeline used for writing loggers.
tailer1	The main tailer process, which reads Deephaven binary log files and sends them to the Data Import Service.
web_api_service	Web API Service.
import_bin_files	Directly imports Deephaven binary log files without using a tailer.
auth_server_reload_tool	Restarts the authentication server.
deploy_schema	Deprecated. Makes defined schemas visible to Deephaven. Note: This script and service name are deprecated, and the dhconfig script should be used instead.
iris_connectivity_test	Connects your Deephaven installation to verify that query workers are running, or that it is possible to start a worker.
iris_query_grep	Searches for strings within the text of persistent query scripts. This is often useful when doing some kind of migration, or to find what uses various functions.
iris_query_replacement_tool	Performs find/replace within the text of persistent query scripts.
generate_loggers	Generates logger and listener classes.
metadata_repair_tool	Repairs metadata; e.g., checkpoint records in individual partitions to ensure they have a valid size, and to prevent data corruption or lost files.
metadata_indexer	A manual indexing process.

Note: these will not necessarily match the names shown by monit.

Property Inspector Options

When invoking the Property Inspector, you have a number of different switches that can be passed in.

• -pf <file>: (required) This is the main property file that you are inspecting.
• -pn <property name>: If specified, the Property Inspector will display all uses of the named property, and indicate which file(s) and line(s) the property was found on, with the effective value listed first. Using the -pn switch means that Search Mode will be ignored.
• -out <file>: If specified, the output from the Property Inspector will be printed to the specified file. Otherwise, the output will be displayed in the console.
• -cs: If this switch is used, then the output from the Property Inspector will be produced in CSV format. Otherwise, the output is displayed in screen-friendly format.
• -all: If this switch is used, then the Property Inspector will ignore stanzas within the property file, ignoring system properties entirely. If this switch is not used, then the Property Inspector will only examine the stanzas that are indicated by the current set of system properties. To examine the configuration for a single service, set the service.name system property to the appropriate value for that service when invoking the Property Inspector, then do not use the -all switch. To examine the overall configuration of the entire system without regard to individual services, use the -all switch.
• -fm <mode>: Search Mode. This is the Search Mode you want to use, if the -pn switch is not used. Valid values for this are:
  • ALL: (default) Display all of the effective property values that result from the file and the current system properties. This mode shows the final values and which file and line those values came from. If PropertyX is set to value ‘1’ by default, but is later overridden to value ‘2’, then this will show ‘2’ and the location where ‘2’ was set.
  • ALL_DUPLICATES: Display all property values that were listed more than once within the property file (and any property files it included). If PropertyX is set to value ‘1’ by default, but is later overridden to value ‘2’, then this will show both ‘1’ and ‘2’, each with the file and line number where the value was set.
  • FILE_DUPLICATES: Same as ALL_DUPLICATES, but only finds cases where a given property was listed more than once within the same file. If PropertyX is set to value ‘1’ in the file defaults.prop and set to value ‘2’ in the file common.prop which includes defaults.prop, then this would not display PropertyX. If PropertyX is set to value ‘1’ and then later to value ‘2’ both within common.prop, then this would display PropertyX.
  • NON_DUPLICATES: Display all property values that were listed exactly once within the property file (and any property files it included). If PropertyX is set to value ‘1’ by default but is later overridden to value ‘2’, this will not display PropertyX. If PropertyX is set to value ‘1’ and never overridden, then this would display PropertyX.
  • COMPARE: This will compare the effective property values against a list of must-include properties, a list of must-exclude properties, or both. At least one of the -in and -ex switches must be specified when using this (see those switches for details). You may use one or both of those switches.
• -in <file>: When used with Search Mode COMPARE, the Property Inspector will display any properties in the specified -in file that are NOT found in the source property file (or any files included by the source property file). The -in file must have one property name per line, or a regular expression per line. Lines with a regular expression are denoted by a leading ‘/’. If a property is listed in the -in file and no matching property is found in the source property file, the Property Inspector will display the name of the missing property.
• -ex <file>: When used with Search Mode COMPARE, the Property Inspector will display any properties in the specified -ex file that ARE found in the source property file (or any files included by the source property file). The -ex file must have one property name per line, or a regular expression per line. Lines with a regular expression are denoted by a leading ‘/’. If a property is listed in the -ex file and at least one matching property is found in the source property file, the Property Inspector will display the name of the matched property, the line from the -ex file that matched that name, and the file and line number where the matched property was found.

Note: if you do not enter a switch, or if the Property Inspector Utility does not recognize the values entered, the Help option will be invoked.