Skip to main content
ServiceEnterprise
Availability2024.1

Config Tool Import

Recommended for full directories

Configuration Console Import

Individual files or no CLI

Validate the configuration

Check logs after import

Troubleshooting

Read config-tool logs
Initialize the GermainUX Configuration After installing the GermainUX datastore, Germain Enterprise, GermainUX Services, and all required infrastructure components, initialize the platform by importing the configuration supplied with the GermainUX Service distribution. You can import the configuration using:

​
Prerequisites

Before importing the configuration, confirm that:
  • The GermainUX database or datastore is initialized.
  • ZooKeeper is running and contains the required GermainUX configuration root.
  • Kafka—or ActiveMQ for legacy releases—is running.
  • Hazelcast is running.
  • Germain Enterprise is deployed and accessible.
  • The GermainUX Services distribution has been extracted.
  • Your account has permission to import configuration.
  • The GermainUX version of the configuration files matches the installed platform version.

​
Locate the configuration files

Extract the GermainAPMService-<version> archive if this has not already been done. In this guide, SERVICE_HOME refers to the extracted directory. The configuration files are located under:
The distribution typically contains: Always import the core configuration first.

​
Before importing

Configuration imports can modify or replace existing settings. Before importing into an existing environment:
  • Back up the current GermainUX configuration.
  • Confirm that the files correspond to the correct GermainUX release.
  • Review environment-specific values.
  • Identify any credentials, URLs, or hostnames that must be changed.
  • Test the import in a non-production environment when possible.
Do not import configuration intended for another environment without reviewing it first.

​
Option 1: Import with the Germain Config Tool

This is the recommended method for importing a complete configuration directory. The Germain Config Tool is located under:

​
Windows

Run:
Example:

​
Linux

Run:
Example:

​
Import order

Import the directories in the following order:
1

Import core

2

Confirm that the core import completed successfully

3

Import ux and any required technology-specific directories

4

Import customer-specific or environment-specific configuration last

When files have parent-child relationships, import the parent first. For example:
must be imported before:

​
Review the import log

If the tool reports an error, review:
Additional instructions for the Germain Config Tool are available in:
Do not continue with dependent configuration files until errors in the base configuration have been resolved.

​
Option 2: Import through the Configuration Console

Use the Configuration Console when configuration files must be imported individually or when the command-line tool is unavailable.

​
1 1. Open the console

Open the Germain Configuration Console. Example:
Sign in using an account authorized to manage the platform configuration.

​
2. Open the REST Client

In the upper-right corner, select REST Client, located below the logout option.
Rest client

Rest client - GermainUX

​
3. Import the base configuration

Start with:
Open the file and copy its entire JSON content.
GermainUX Init Configuration: 3. Import the base configuration
In the REST Client:
1

Paste the JSON into Request Body

2

Set Qualified Name to: germain.apm

3

Select the PUT HTTP method

4

Select Execute

5

Confirm that the request completes successfully

6

Refresh the Configuration Console

The newly imported configuration structure should now be visible.

​
4. Import the remaining core files

Import the other files from the core directory. For each file:
1

Copy its JSON content into Request Body

2

Set the correct Qualified Name

3

Select PUT

4

Execute the request

5

Confirm that it succeeds before continuing

The qualified name normally matches the filename without the .json extension. For example: Import base files before their related child files. For example, import:
before importing:

​
Import optional configuration

After importing all files from core, import the required files from directories such as:
and any other feature, technology, or customer-specific directory.
Important: Enable MergeWhen importing files from any directory other than core, select Merge in the REST Client. This preserves previously imported configuration while adding or updating the new settings.If Merge is not selected, the import may overwrite existing configuration created by earlier REST requests.
Review each file before importing it to ensure it applies to the environment.

​
Restart affected services

Some imported settings take effect immediately, while others require one or more GermainUX components to restart. After completing the import: For a new installation, restarting all GermainUX components provides the clearest validation that the imported configuration can be loaded.

​
Validate the configuration

After the import, verify that:
  • The Configuration Console displays the expected configuration hierarchy.
  • All required core sections are present.
  • Optional technology configurations were merged successfully.
  • Germain Enterprise starts without configuration-loading errors.
  • All GermainUX Services remain running.
  • Germain nodes connect successfully.
  • The GermainUX Workspace opens without errors.
  • Expected dashboards, KPIs, rules, SLAs, and monitoring profiles are available.
  • Collected data is processed and displayed.
Review the following log if the command-line import fails:
Also review the Germain Enterprise and individual service logs for configuration-loading or dependency errors.

​
Troubleshooting

​
The Config Tool reports an import error

Verify:
  • The configuration-directory path is correct.
  • The executing account can read the files.
  • The files contain valid JSON.
  • The configuration matches the installed GermainUX version.
  • Germain Enterprise and ZooKeeper are reachable.
  • Parent configuration files were imported first.
Use config-tool.log to identify the first file that failed.

​
A qualified name is rejected

Confirm that:
  • The qualified name matches the filename without .json.
  • The parent configuration already exists.
  • Capitalization is correct.
  • The request uses the PUT method.
  • The JSON content belongs to the selected qualified name.

​
Previously imported settings disappear

This usually occurs when an optional configuration was imported without selecting Merge. Restore the last configuration backup or reimport the required configuration in the correct order:
1

Core configuration

2

Optional configurations with Merge enabled

3

Environment-specific customizations

​
Configuration exists but is not applied

Confirm that:
  • The affected services were restarted when required.
  • The component uses the expected ZooKeeper environment root.
  • The correct configuration version is active.
  • No environment-specific override replaces the imported value.
  • The logs confirm that the expected configuration was loaded.

​
Next step

After validating the initial configuration, configure the required monitoring components, applications, users, dashboards, rules, and SLAs through the GermainUX Workspace. Source: GermainUX Initial Configuration.

​
Get Help

Contact GermainUX Support

The GermainUX team helps you get up and running faster, empower your team, turn data into actionable insights, and optimize performance to deliver measurable business outcomes.

Can't find what you need?

Search all GermainUX docs with Ctrl + K, or use the feedback buttons at the bottom of this page to tell us what is missing.

The content of this document is proprietary to GERMAIN SOFTWARE.