Integrate with con terra Applications / server side logging

This page contains the following sections:

Integrate with con terra security.manager
- Steps for installation and configuration
Integrate with con terra map.apps
- Steps for installation and configuration
Required jar-Files for integrating map.apps and security.manager
Integrate with other con terra products
Logging parameters

service.monitor Analytics can be integrated with other con terra products. This is possible due to the same kind of handling and securing of http Requests. Once integration has been accomplished, the following parameters will be logged on client access:

basic HTTP request parameters (URL, protocol)
basic HTTP response parameters (request duration, HTTP status code)
User Agent
authentication information
client IP

Integrate with con terra security.manager

In order to log information about requests in your security.manager installation, you need to install the shipped GelfWebSecurityProcessor. This processor usually logs via UDP protocol, TCP protocol is also possible.

Steps for installation and configuration

Copy the *.jar files located in [CD-CONTENTS]/software/service.monitor Analytics web/service-log/lib and /lib-ext (see below)
1. to [security.manager]/webapps/wss/WEB-INF/lib
2. to [security.manager]/webapps/administration/WEB-INF/lib
File [CD-CONTENTS]/software/service.monitor Analytics web/service-log/spring-log-bean-sample-security.manager.xml contains a pre-configured web security processor bean definition, which you need to copy
1. to [security.manager]/webapps/administration/WEB-INF/classes/spring-security-config.xml
2. to [security.manager]/webapps/wss/WEB-INF/classes/spring-security-config.xml
For enabling logging the previously added bean needs to be referenced in the Spring Web Processor lists. Please see file [CD-CONTENTS]/software/service.monitor Analytics web/service-log/security-manager-<version>/spring-security-config-wss.xml for understanding the configurational changes.
Repeat bean referencing like defined in [CD-CONTENTS]/software/service.monitor Analytics web/service-log/security-manager-<version>/spring-security-config-administration.xml
You have to define the target port and url in the security.manager application.properties under [SECURITY_MANAGER_DATA_FOLDER]/application.properties
```
analytics.gelf.server=myserver.domain.de
analytics.gelf.port=12201
analytics.message.src=security.manager
analytics.log.enabled=true
```
Please restart your Servlet Container after applying changes.

Integrate with con terra map.apps

In order to log information about requests inside of your map.apps installation, you need to install the shipped GelfWebSecurityFilter. This processor usually logs via UDP protocol, TCP protocol is also possible.

Steps for installation and configuration

Copy the *.jar files located in [CD-CONTENTS]/software/service.monitor Analytics web/service-log/lib and /lib-ext (see below)
1. to [map.apps]/WEB-INF/lib
File [CD-CONTENTS]/software/service.monitor Analytics web/service-log/spring-log-bean-sample-map.apps.xml contains a pre-configured filter bean definition, which you need to copy
1. to [map.apps]/WEB-INF/classes/spring-filter-config.xml
For enabling logging the previously added bean needs to be referenced in the filter chain. Please see file [CD-CONTENTS]/software/service.monitor Analytics web/service-log/map.apps-<version>/spring-filter-config.xml for understanding the configurational changes.
1. You have to define the target port and url in the map.apps application.properties under [MAP_APPS_DATA_FOLDER]/application.properties
  analytics.gelf.server=myserver.domain.de analytics.gelf.port=12201 analytics.message.src=map.apps
Please restart your Servlet Container after applying changes.

Required jar-Files for integrating map.apps and security.manager

The files required for integration scenarios are residing in folder service-log/lib:

ct-analytics-usagelog-api-1.x.jar
ct-analytics-usagelog-api-2.x.jar
gelfclient-<version>.jar
netty-all-<version>.FINAL.jar security.manager does always require ct-analytics-usagelog-api-1.x.jar. Likewise map.apps apart of those versions starting wih 4.7, which do use ct-analytics-usagelog-api-2.x.jar.

However, additional files from service-log/lib-ext may be required. Please see the table below for the additional files:

security.manager
Version	files from `/lib-ext` für administration-webapp`	files from `/lib-ext` für wss-webapp`
4.4	`ct-rest-support-1.3.0.jar jackson-core-2.8.3.jar`	`ct-rest-support-1.3.0.jar jackson-core-2.8.3.jar`
4.5	`ct-rest-support-1.3.0.jar jackson-core-2.8.3.jar`	`ct-rest-support-1.3.0.jar jackson-core-2.8.3.jar`
4.6.4	`ct-rest-support-1.3.0.jar jackson-core-2.8.3.jar`	`ct-rest-support-1.3.0.jar jackson-core-2.8.3.jar`
4.7.1	`jackson-core-2.8.3.jar`	`ct-rest-support-1.3.0.jar jackson-core-2.8.3.jar`
4.8.0		`ct-rest-support-1.3.0.jar`
4.9		`ct-rest-support-1.3.0.jar`
4.10		`ct-rest-support-1.3.0.jar`
4.10.1		`ct-rest-support-1.4.17.jar`
4.11		`ct-rest-support-1.4.17.jar`
4.12	`ct-rest-support-1.4.17.jar`	`ct-rest-support-1.4.17.jar`
4.13	`ct-rest-support-1.4.17.jar`	`ct-rest-support-1.4.17.jar`
4.14	`ct-rest-support-1.4.17.jar`	`ct-rest-support-1.4.17.jar`
4.14.1
4.15	, please use ready-configured `spring-filter-config.xml`	, please use ready-configured `spring-filter-config.xml`
4.16.x	, please use ready-configured `spring-filter-config.xml`	, please use ready-configured `spring-filter-config.xml`

map.apps
Version	Dateien aus `/lib-ext
3.x	Please use integration files from service.monitor Analytics 4.3.0.
4.0	, only in combination with `ct-rest-support-1.4.17.jar`, `ct-rest-support-1.3.0.jar` included with map.apps does not work in this combination.
4.1	, only in combination with `ct-rest-support-1.4.17.jar`, `ct-rest-support-1.4.0.jar` included with map.apps does not work in this combination.
4.2.0	, only in combination with `ct-rest-support-1.4.17.jar`, `ct-rest-support-1.4.3.jar` included with map.apps does not work in this combination.
4.2.1 / 4.2.2	, only in combination with `ct-rest-support-1.4.17.jar`, `ct-rest-support-1.4.4.jar` included with map.apps does not work in this combination.
4.3	, only in combination with `ct-rest-support-1.4.17.jar`, `ct-rest-support-1.4.4.jar` included with map.apps does not work in this combination.
4.4	, only in combination with `ct-rest-support-1.4.17.jar`, `ct-rest-support-1.4.7.jar` included with map.apps does not work in this combination.
4.5.1	, only in combination with `ct-rest-support-1.4.17.jar`, `ct-rest-support-1.4.11.jar` included with map.apps does not work in this combination.
4.6
4.7	, please use `ct-analytics-usagelog-api-2.x.jar`
4.8	, please use `ct-analytics-usagelog-api-2.x.jar`
4.9	, please use `ct-analytics-usagelog-api-2.x.jar`

Integrate with other con terra products

A lot of other con terra products support service.monitor Analytics integration as shown above. Please ask for Support Plus or Consultancy Services for additional Support.

Logging parameters

useragent

Information about the user’s OS and browser

Example: "user_agent": "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:41.0) Gecko/20100101 Firefox/41.0"

client_ip

Anonymized client IP

Example: "client_ip": "123.12.12.000"

request

Request parameter information

Example:

"request": {
  "server_host": "test.remote.host.com",
  "url_query": "?queryProperty=testvalue",
  "server_context: "/wss",
  "referrer": "http://www.mytest.de",
  "protocol": "https"
}

auth

Authentication information

Example:

"auth": {
  "authenticated": true,
  "user_id": "userA",
  "login_time": "2011-17-10 11:17:50",
  "group_name": "sampleGroup",
  "roles": [
    "admin",
    "editor"
  ]
}

response

Response parameter information

Example:

"response": {
  "status": 200
}

response_time

Response time in nano seconds and response time in milli seconds

Example:

"response_time": 12345678,
"response_time_ms": 1234.5678