Log Definitions

The log definitions are delivered as an XML file contained in the software component FSCAPPTELEMETRY. Locate the following component objects and export the log definitions.

• Log Definition for Server Instrumentation
  FSCAPPTELEMETRY@1.1001:LogAnalyzerDefinition
• Log Definition for Fabasoft Conversion Service Instrumentation
  FSCAPPTELEMETRY@1.1001:LogAnalyzerDefinitionConversion
• Log Definition for Client Instrumentation
  FSCAPPTELEMETRY@1.1001:LogAnalyzerDefinitionClient
• Log Definition for Fabasoft Integration for Liferay Portal Instrumentation
  FSCAPPTELEMETRY@1.1001:LogAnalyzerDefinitionPortal

Fabasoft app.telemetry Client

To use the provided log definitions in the Fabasoft app.telemetry Client perform the following steps:

1. Open the Fabasoft app.telemetry Client.
2. Create a new “Software-Telemetry Log Pool” in the "Log Pools" sub tree.
   
3. On the “Log Definition Columns” tab import the desired log definition.
   
4. On the “Log Pool Properties” tab set the desired settings. In the area Application Filters set for example the following Application Tiers:
   • Web Service or Conversion Service for server instrumentation
   • Client for Client (End-2-End) instrumentation
   • Web Application for Liferay Portal instrumentation

The application tiers are visible only if the instrumented services have already registered with the Fabasoft app.telemetry Agents. For example, Client is only visible if the Fabasoft Folio Web Client Instrumentation is configured and already has sent telemetry information.

The Application Tier filters for the starting point of a request. If the request involves additional application tiers (for example COO Service), this telemetry information is included automatically.

Note: Application tiers should not overlap. If application tiers overlap, telemetry information may only be collected by one log pool.

After these steps the columns of the imported log definition are available.

Note: In versions prior to 2015 Winter Release, Fabasoft Folio Web Services, Conversion Services and eServices were all registered with the Application Tier “Web Service”. When installing a new service with a current Fabasoft Folio version, the service type is automatically stored in the registry and the type is used for registering with the Fabasoft app.telemetry Agent. In the case of an update, this information must be added to the registry manually. Valid values for the service type are Web Service, Conversion Service, and eService:

[HKEY_LOCAL_MACHINE\SOFTWARE\Fabasoft\FscWeb\Modules\1/CONV]
@="C:\\Program Files\\Fabasoft\\Components\\Web\\1_CONV\\ASP\\content\\bin\\fscvext.dll"

[HKEY_LOCAL_MACHINE\SOFTWARE\Fabasoft\FscWeb\Modules\1/CONV\FSCSERVICETYPE]
@="Conversion Service"

Using a Linux environment this information is stored in /etc/fabasoft/settings/machine/SOFTWARE/Fabasoft/FscWeb/Modules:

su - fscsrv

cd /etc/fabasoft/settings/machine/SOFTWARE/Fabasoft/FscWeb/Modules

mkdir WebService_101

echo n "/opt/fabasoft/share/web/WebService_101/asp/content/bin/libfscvext.so" > WebService_100/registry.default

mkdir WebService_101/FSCSERVICETYPE

echo n "Conversion Service" > WebService_101/FSCSERVICETYPE/registry.default

Update an Existing Log Definition

To update an existing log definition select a log definition and repeat step 3 in chapter Fabasoft app.telemetry Client to update the XML file.