Server configuration file

This page describes the commonly adjusted values in the AppMon Server configuration file (server.config.xml).

Important

Do not edit the Server configuration file while the Server is running.

To explain the context of the XML paths in the Server Settings table below, the following XML code snippet shows the XML path serverconfig/settings/server with its attribute name. All XML paths are relative to the containing root element dynatrace.

<dynatrace version="<version>">
  <serverconfig memento.version="<version>">
    ...
    <settings>
      <server ...
       name="hostname" ... />
    ...
    </settings>
  ...

Server Settings table

The following lists the commonly adjusted values in server.config.xml:

XML Path Attribute Name Default Value Description
serverconfig/collectorconfig agentport 9998 The Collector listens at the specified port for incoming Agent connections. Restart the Collector after making any changes.
serverconfig/directories/storedessions path sessions/stored The sessions are stored in the specified folder, which is relative to the AppMon installation folder.
serverconfig/directories/temp path temp Temporary data is stored in the specified folder, which is relative to the AppMon installation folder. Restart the Server after making any changes.
serverconfig/directories/reports path reports Temporary files for automatically generated reports (using REST interfaces or scheduled) are stored in the specified folder, which is relative to the AppMon installation folder. Restart the Server after making any changes.
serverconfig/settings/collector allowcollectorconnections true Allow Collector connections.
serverconfig/settings/collector requiressl false Require SSL connections.
serverconfig/settings/collector collectorport 6698 The Server listens at the specified port for incoming Collector connections. Restart the Server after making any changes.
serverconfig/settings/collector collectorsslport 6699 The Server listens at the specified port for incoming Collector SSL-connections. Restart the Server after making any changes.
serverconfig/settings/client clientsslport 2021 The Server listens at the specified port for incoming Client connections. Restart the Server after making any changes.
serverconfig/settings/client clientallowsavecredentials true Enable or disable to the Remember Password option at the client login. Disabling prevents the client from storing the password locally.
serverconfig/settings/server name <hostname> Server name, initialized with lower-cased hostname. You can change the name, but make sure your new name does not contain special characters or spaces. Restart the Server after making any changes.
serverconfig/settings/server continuoussessionrecording false Enable or disable the continuous transaction recording.
serverconfig/settings/server jmxexportmanagement true Activate or deactivate an additional JMX interface of this Server to manage some Server features using JMX.
serverconfig/settings/server jmxexportmonitoring true Activate or deactivate the JMX interface of this Server. Activate the JMX interface to integrate the Server with other monitoring tools using standardized JMX interfaces.
serverconfig/settings/server jmxport 1099 The JMX port.
serverconfig/settings/server tunnelenabled true Allow HTTP Tunnel connections.
serverconfig/settings/server tunneladdress   The Server listens at the specified address for incoming Client connections. Restart the Server after making any changes.
serverconfig/settings/server tunnelport 8023 The Server listens at the specified port for incoming Client connections. Restart the Server after making any changes.
serverconfig/settings/server selfmonitoringenabled true Self-monitoring stores Server Measures to the Performance Warehouse and lets you configure the Server System Profile.
serverconfig/settings/server agentbasedselfmonitoringenabled true for memory > demo Agent-based self-monitoring places an AppMon Agent on the AppMon Server, providing the usual data that any AppMon Agent does, enabling dogfooding of diagnostic data.
serverconfig/settings/oopanalyzer address   Defines the address of the AppMon Memory Analysis Server to be used for Memory Snapshot Post-Processing.
serverconfig/settings/oopanalyzer port 7788 Defines the port to which the AppMon Memory Analysis Server listens.
serverconfig/settings/oopanalyzer logpath ../log/analysisserver Log path for the out-of-process Memory Analysis Server.
serverconfig/loggingconfig append true Whether to append new log lines.
serverconfig/loggingconfig console INFO Log level for console output.
serverconfig/loggingconfig level INFO Log level.
serverconfig/loggingconfig maxfiles 5 Maximum number of log and audit log files.
serverconfig/loggingconfig path ../log/server The log is stored in the specified folder, which is relative to the AppMon installation folder.
serverconfig/loggingconfig maxbytes 10485760 (1MB) The maximum size of one log/audit log file.
serverconfig/http externalhostname   Lets you define a different server-name for access to the web server from remote networks. This is used for links to dashboards in reports and other places where links to the Server are provided. This is an optional setting. It is only required if the Serveris not reachable with the address specified under Connectivity.
serverconfig/http httpport 8020 Enter the port number web service requests should be listened on for non SSL requests or 0 if non SSL requests should be ignored. The default port number is 8020.
serverconfig/http httpsport 8021 Enter the port number web service requests should be listened on for SSL requests or 0 if SSL requests should be ignored. The default port number is 8021.
serverconfig/http requiressl false Require SSL connections.
serverconfig/http webservicesenabled true Enables or disables web services which allow information retrieval about system profiles and other information, and access some Server features.
serverconfig/http webserverenabled true Enable Web Server
serverconfig/http externalhttpsport   Defines a different HTTPS port to access web services from remote machines or networks. This setting notifies the Server that an operating system or proxy was configured to listen on different ports than httpsport which forwards communication to web services. All created links use this port if configured.
serverconfig/http externalhttpport This option defines a different HTTP port to access web services from remote machines or networks. This setting notifies the Server that an operating system or proxy is configured to listen on different ports than httpport which forwards communication to web services. All created links use this port if configured.
serverconfig/http webserviceusertimeout -1 (disabled) A security feature that sets a timeout in seconds for how long a user at the server web interface can be idle until the user session times out, after which the user must re-authenticate. If this setting is enabled on a server, REST clients accessing this server must set HTTP header X-Dynatrace-UserRevalidation: false in all it's requests. Otherwise the REST clients always receive 401 Unauthorized responses, even if valid authentication data are set on the requests.
serverconfig/http uniquewebservicerealm false A security feature to prevent internet browsers to reuse locally stored authentication data for protected pages of the server web interfaces. If set to true, the server generates unique authentication realms every time the user gets an authentication prompt from the browser.
serverconfig/webstart webstartenabled true Enables or disables the Java Web Start feature which you use to download a Web Start version of the Client directly from the Server.
serverconfig/webstart tunnelenabled false The Client uses encrypted HTTP to tunnel all communication. Use this setting if your firewall configuration only allows HTTP traffic or if you have to connect using a reverse proxy.
serverconfig/webstart tunneladdress localhost Enter the hostname or IP address of a Server with tunnel enabled.
serverconfig/webstart tunnelport 8023 Enter the port of a Server with tunnel enabled.
serverconfig/webstart proxyenabled false The Client uses an HTTP CONNECT request to create compressed SSL connections to the Server using a forward proxy. Use this setting if you have to connect using a forward proxy.
serverconfig/webstart proxyaddress   Enter the hostname or IP address of your proxy.
serverconfig/webstart proxyport -1 Enter the port of your proxy.
serverconfig/webstart proxyauthenabled false Whether to authenticate (true) or attempt anonymously (false).
serverconfig/webstart proxyauthusername   Enter the username to authenticate at the proxy.
serverconfig/webstart proxyauthpassword1   Enter the password to authenticate at the proxy.
serverconfig/webstart anonymouswebstartenabled true Controls whether server web interface visitors must authenticate for all pages or can launch the Webstart client with no authentication.
serverconfig/oopanalyzerconfig address localhost Defines the AppMon Memory Analysis Server address used for Memory Snapshot Post-Processing.
serverconfig/oopanalyzerconfig port 7788 Defines the AppMon Memory Analysis Server listening port.
serverconfig/mailserver address   The hostname or IP address of the email server that sends emails. You must configure the email server to accept emails using the SMTP protocol.
serverconfig/mailserver port 25 Specify the TCP/IP port on the email server configured for receiving email. This port often is 25, but can be configured differently in certain environments.
serverconfig/mailserver ssl false An SMTP server may support or require encrypted communication using SSL. Choose if your SMTP server allows or requires SSL communication.
serverconfig/mailserver userid   Specify the username that is used for authentication on the email server. Leave empty if the email server does not require authentication.
serverconfig/mailserver password1   Specify the password that is used for authentication on the email server. Leave empty if the email server does not require authentication.
serverconfig/mailserver subject [dynaTrace] Specify a string to prepend to the subject-line of any email that is sent.
serverconfig/mailserver bounce Specify an email address to which undeliverable email should be forwarded (optional). For example, if the email cannot be delivered to some recipients because the email address is not correctly spelled, the email is sent to this address with information about which email could not be delivered and usually a full copy of the failed email. Usually this information is either relevant for system administrators for adjusting the configuration of the email software or for the person configuring the AppMon software for adjusting the email addresses. Other valid recipients still receive the email despite a failed addresses for another recipient. Only failed mail delivery is reported. Failures to create the report and other error situations are logged in the Server log files.
serverconfig/mailserver/from email   Email address that appears in From section of the actual email sent by the Server.
serverconfig/mailserver/from type Unresolved If the email attribute is configured, you must change this to Email.
serverconfig/webui webuihttpsport 9911 The port where AppMon listens for AppMon Web HTML and AppMon Web REST requests.
serverconfig/webui webuienabled true Enables or disables AppMon Web.
repositoryconfig querytimeout 7200 (2 hours) The overall timeout for queries (in seconds).
repositoryconfig/repository/database dbms embedded See Performance Warehouse Administration.
repositoryconfig/repository/database name dT4 for DB2
dynaTrace4 for all others
Specify the database name. The database must exist and be accessible.
repositoryconfig/repository/connection host   Specify the IP or host of the database.
repositoryconfig/repository/connection port Oracle: 1521
DB2: 50000
SQLServer: 1433
Specify the database port.
repositoryconfig/repository/credential user   Specify the database user.
repositoryconfig/repository/credential password1   Specify the database password.
repositoryconfig/repository/connection useurl false Direct edit of Connection URL (Oracle only).
repositoryconfig/repository/connection url   Connection URL (Oracle only).
repositoryconfig/repository/connection connectonstartup true Connect on startup.

1 For migration, starting the Server transfers the passwords to the keystore and the field (including the identifier)is removed from the configuration file.

Repository configuration

The following is a list of the possible values for attribute dbms under XML path repositoryconfig/repository/database:

DBMS Description
embedded Embedded Apache Derby database. For production, install an external database such as Oracle, DB2, or SQL Server.
Oracle For integration, an Oracle database must be created and configured (user, password) by the database administrator.
DB2 For integration, a DB2 database must be created and configured (user, password) by the database administrator.
SQLServer For integration, a SQLServer database must be created and configured (user, password) by the database administrator.
PostgreSQL For integration, a PostgreSQL database must be created and configured (user, password) by the database administrator.

Generating the default configuration file

On the first startup, the Server detects various settings and generates the initial configuration file. Typically you do not have to modify this file. To generate a configuration file without starting the Server, you can define a command line property, as shown below:

# ./dtserver -Dcom.dynatrace.diagnostics.server.init_config_and_exit=true