Chapter 25 Global Settings

Table of Contents

25.1 Server Locale
25.2 Server Hostname
25.3 Customize MySQL Server Name
25.4 Data Purge Behavior
25.5 My Oracle Support Credentials
25.6 HTTP Proxy Settings
25.7 External Authentication

This chapter describes how to configure your MySQL Enterprise Service Manager installation.

25.1 Server Locale

This locale overrides the operating system locale for use in notifications. Select your locale from the list of options.

25.2 Server Hostname

This section describes how to define your server hostname.

Figure 25.1 Server Hostname

Server hostname settings

Table 25.1 Customize

Name Description

Hostname

Defines the hostname used in all notifications. This value must be a valid hostname.

Port Number

Defines the port number used for notifications. Do not change this value from the default unless you have altered or redirected the default port number during installation. An invalid value results in invalid links in notification messages. Default value is 18443.
Login Display Name Defines the hostname displayed on the login page.


25.3 Customize MySQL Server Name

This section describes how to configure the display names of your monitored MySQL hosts.

Figure 25.2 Customize MySQL Server Name

Customize MySQL Server Name settings

Table 25.2 Customize

Name Description
Show MySQL Server Names as: Defines how hostnames are displayed. The following display settings are possible:
  • Reported by Agent (default): the MySQL server names are displayed exactly as reported by the monitoring agent.

  • Hostname only: only the host name is displayed, omitting suffixes such as companyname.com.

  • Transformed by substitution expression: enables the Substitution Expression field. This enables you to replace some, or all, of the hostname with custom values.

Substitution Expression

Enables you to substitute your hostnames with custom values. These substitutions can be simple substitutions, or more complex regular expressions. The substitution expression is a name-value pair, with the original value, or regular expression on the left, and the substitution value on the right.

You can include multiple, comma-separated, substitutions.

For example:

                
dx521\.example\.com=Staging
dx984[.]example[.]com=Production
database-server-(.*?)\.example\.com=$1
^database-server-="", [.]example[.]com$="", dx521="Staging DB", dx984="Production DB"
              

More complex substitutions are possible by using a regular expression. For more information on the syntax used in these regular expressions, see Regular Expression Constructs.

Display Connection Endpoint Values Defines how connection endpoint values are displayed. The following display settings are possible:
  • Always (default): endpoint values are always displayed.

  • Never: endpoint values are never displayed.

  • For non-default values: endpoint values are displayed only if they differ from 3306 and /tmp/mysql.sock.


25.4 Data Purge Behavior

Data Purge Behavior enables you to automatically remove old log files data from the repository according to a schedule. The default purge interval is 4 weeks. To purge data, change this setting by choosing from the drop-down list. Choosing 12 months, for example, removes all data that is older than a year

Figure 25.3 Data Purge Behavior

Customize Data Purge Behavior settings

Purging data permanently removes information from the repository. Events derived from that data are purged with the data.

Note

The purge functionality purges closed events and related data, only.

The purge process is started approximately once every day, or when the MySQL Enterprise Monitor User Interface is restarted. If you change the purge duration from a large timespan to a smaller one, the data will be purged in increments of one hour, from oldest to newest, until the new data retention policy is met. This is done to reduce the load on the repository.

You can configure the data purge behavior in the following ways:

  • Remove Historical Data Collection Older Than configures the duration that the main data about your servers is retained. This includes all data collections, including CPU, memory and connections and activity statistics.

  • Remove Query Analyzer Data Older Than configures the duration that the query analyzer statistics and information about individual queries is retained.

Notes for setting purge behavior:

  • Purging can be carried out manually by enabling innodb_file_per_table for the repository database and using an OPTIMIZE TABLE operation to reclaim space from deleted rows in the table.

  • If you change the purge value from a high value to a very low value, the space used by the purged data is not reclaimed from the InnoDB tablespaces. Do this by running OPTIMIZE TABLE on the MySQL tables for MySQL Enterprise Service Manager to reclaim the space from the purged rows.

25.5 My Oracle Support Credentials

You can specify the credentials for logging into the My Oracle Support site. These must match the user name and password that you have registered with Oracle for access to the support site.

Figure 25.4 My Oracle Support Credentials

My Oracle Support Credentials

25.6 HTTP Proxy Settings

Enter your HTTP Proxy details, if you use a proxy to connect to the internet. If you use a proxy, and these values are not set, the What's New frame cannot update.

Figure 25.5 HTTP Proxy Settings

HTTP Proxy Settings

25.7 External Authentication

Table 25.3 External Authentication

Name Description

Disabled

No external authentication system is used. All user authentication is performed in MySQL Enterprise Monitor.

LDAP Authentication

Enables the LDAP configuration. Populate the fields as required by your LDAP installation.

Active Directory Authentication

Enables the Active Directory configuration. Populate the fields as required by your Active Directory installation.

Is Authoritative

To make the selected authentication system the authoritative authentication mechanism, check Is Authoritative.

Important

If you select this option, and the LDAP service is misconfigured, you can lock yourself out of MySQL Enterprise Monitor entirely.


External Authentication

Enables you to configure external authentication using LDAP or Active Directory.

Figure 25.6 External Authentication Settings: LDAP

LDAP Authentication Settings

Table 25.4 LDAP Authentication

Name Description

Primary Server Hostname and Port Number

Hostname or IP address of the primary LDAP directory server, and the Port number of the primary LDAP server. You must change this option to the port used for SSL connections if you have enabled encryption.

Secondary Server Hostname and Port Number

Hostname or IP address of the secondary LDAP directory server. Port number of the secondary LDAP server. You must change this option to the port used for SSL connections if you have enabled encryption.

Connect Timeout (seconds)

Time elapsed without establishing a connection to the LDAP server. If a connection is not established within the defined number of seconds, an error is returned.

Read Timeout (seconds)

Time elapsed without a response to a request for data from the LDAP server. If no response is received within the defined number of seconds, an error is returned.

Encryption

Encryption type required for communication with the LDAP server(s). Supported options are None, StartTLS, and SSL.

Referrals

Authentication follows the referrals provided by the server. The default is to use whatever the LDAP directory server is configured to do.

External Authentication Server Allows Anonymous Binds

Optionally allow Anonymous binds. When unchecked, MySQL Enterprise Monitor provides for a pre-auth bind user to lookup account records. For Active Directory, the most common user account attribute is sAMAccountName, whereas it is common for Unix-based LDAP to use CN. If the Active Directory server is not configured to honor CN binds, it cannot fetch credentials.

Authentication Mode

The authentication mode to use.

  • Bind as User: binds to the LDAP directory using the credentials given to login to MySQL Enterprise Service Manager

  • Comparison: requires an LDAP login/password that can see the configured password attribute to make a comparison with the given credentials.

User Full Name Attribute Name

Define the user fullname attribute. This enables the system to return the fullname of the user.

Search by User Distinguished Name (DN) Pattern

In the User Search Patternfield, define the pattern specifying the LDAP search filter to use after substitution of the username, where {0} defines where the username should be substituted for the DN.

Search by User Attribute Pattern

In the User Search Base (leave blank for top level) field, define the value to use as the base of the subtree containing users. If not specified, the search base is the top-level context.

To search the entire subtree, starting at the User Search Base Entry, enable Search entire subtree. If disabled, a single-level search is performed, including only the top level. To include nested roles in the search, enable Search Nested Roles.

User Search Attribute Pattern

The attribute pattern to use in user searches.

Map External Roles to Application Roles

Specifies whether the roles defined in LDAP should map to MySQL Enterprise Monitor application roles. If enabled, and LDAP is not configured to be authoritative, if a user authenticates successfully via LDAP and has a valid mapped role, they are granted permissions to the application. Roles are mapped according to the entries in the Application Role/LDAP Role(s) fields, which take comma-separated lists of LDAP roles to map to the given MySQL Enterprise Monitor roles. If you select this option, additional fields are displayed which enable you to configure how roles are found in the LDAP server.


Active Directory Authentication

Enables you to configure Active Directory authentication.

Table 25.5 Active Directory Authentication

Name Description
Domain The Active Directory Domain.
Primary Server Hostname and Port Number Hostname of the Active Directory server to use.
Secondary Server Hostname and Port Number (optional) Secondary Active Directory hostname. This is optional.
Map LDAP Roles to Application Roles Whether the roles defined in Active Directory can be mapped to those defined in MySQL Enterprise Monitor.