On Premises Configuration

• LDAP integration
• Reports branding

The configuration of the Nudge APM Monitor is made by editing a file in properties format named nudge-server.properties.

The default location of that file using the directory ~/.nudge/. It is possible to define the location by using the -Dnudge.properties at the start of the JVM of the container that deploys the Nudge APM Monitor.

If no such file exists at the first start of the Nudge APM Monitor, then it will try to create the file ~/.nudge/nudge-server.properties with a default content.

LDAP integration

The integration with the LDAP server is activated as soon as the configuration states auth.mode=ldap, that is when the property auth.mode has the value ldap. It is also needed to provide some further configuration about network connectivity, security and data-model.

Here is an overview of all related properties of the file nudge-server.properties (with value examples):

auth.mode=ldap
auth.ldap.url=ldap://com.company.auth:389/
auth.ldap.bind=admin
auth.ldap.pass=password
auth.ldap.dn.user=ou=People,ou=department,dc=company,dc=com
auth.ldap.objectClass=person
auth.ldap.field.email=mail
auth.ldap.field.login=uid
auth.ldap.field.firstname=givenName
auth.ldap.field.lastname=name

• auth.ldap.url is the connection link to the LDAP compatible authentication service. It must include the protocol, the network port and the host name (or IP).

• auth.ldap.bind is the user or the DN used to find users. This identifier must have enough rights in order to do a search within the DN defined by the property auth.ldap.dn.user over LDAP fields auth.ldap.field.login and auth.ldap.field.email.

• auth.ldap.pass is the password for the user defined by auth.ldap.bind.

• auth.ldap.dn.user is the DN that contains all the user-related data. All user searches will be made within that DN.

• auth.ldap.objectClass is the LDAP data model class corresponding to a user.

• auth.ldap.field.email is the LDAP field that corresponds to the user’s email.

• auth.ldap.field.login is the LDAP field that corresponds to the user’s connection identifier. The corresponding values will be used by users during connection attempts.

• auth.ldap.field.firstname is an optional property. It is the LDAP field that corresponds to the user’s first name.

• auth.ldap.field.lastname is an optional property. It is the LDAP field that corresponds to the user’s last name.

Reports branding

It’s possible to customize your reports. You can easily change the header, the footer and include the logo of your company (instead of the default Nudge APM logo).

Here is an overview of all related properties of the file nudge-server.properties (with value examples):

# branding logo file path
reporting.brand.logo.path=/home/user/.nudge/nudge.PNG
# branding logo display scale as a percentage (between 0 excluded and 100 included)
reporting.brand.logo.scale=50
# branding legal notice
reporting.brand.legal=My awesome company\n \u00A9 2016
# branding contact information
reporting.brand.contact=me@company.com

• reporting.brand.logo.path is the location of the image file that represents the logo to be displayed at the top-left of each page.
• reporting.brand.logo.scale is the scaling factor of that logo in percentage.
• reporting.brand.legal is the text displayed at the bottom-left.
• reporting.brand.contact is the text displayed at the bottom-right.

In all configured texts, you should use the syntax \uXXXX in order to insert special characters where XXXX is the corresponding unicode hexadecimal code. An ASCII mapping table may help you. For example, you might use \u00A9 in order to insert a copyright symbol (©).

We can use the \n sequence in order to insert a line break

Here is the structure of a page: