Namespace: Consultingwerk.Framework.Server.Telemetry
Class 
TelemetryService Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Framework.Server.Telemetry.TelemetryService

Inherits: Progress.Lang.Object
Implements: Ccs.Common.IService, Consultingwerk.Framework.Server.Telemetry.ITelemetryService

File:TelemetryService
Purpose:Interface for service collecting application telemetry data
Author(s):Mike Fechner / Consultingwerk Ldt.
Created:Mon Jan 17 00:30:09 CET 2022

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
+ BeginRequest () Tracks the beginning of the PASOE request
+ dispose () Destroy/Shutdown/Anti-Initializer
+ EndRequest () Tracks the end of the PASOE request
# CHARACTER FormatFileName (character) Formats an ABL procedure name to look something like a type name
+ initialize () Initializer/Startup
# LoadSettings () Loads the settings from telemetry.conf
+ SetClientPrincipal (handle) Sets user and domain based on the client principal provided
+ SetData (integer, character, character) Sets application specific data
+ SetError (Error) Updates details about an Error
# SetKey () Sets the key for the aggregation in ProTop
+ SetRequestUri (URI) Updates the URI
+ SetServiceInterface () Set the initial Service Interface
# SetServiceInterface (OERequestInfo) Updates the Service Interface
+ SetServiceRequest (character, character) Updates the Service Request
+ SetStopCondition (Stop) Updates details about a StopCondition
+ SetUserInformation (character, character) Updates the user and domain name
# ValidateSettings (JsonObject) Validates the Settings
+ WritePendingRequest () Writes the Pending Request data

Top Property Summary
Options Name Purpose
+ LOGICAL BufferedOutput
+ INTEGER DetailLevel
+ CHARACTER FileNamePattern
+ CHARACTER InstanceIdentifier
+ CHARACTER OutputDirectory
+ CHARACTER PendingRequestFileName
+ CHARACTER PendingRequestsOutputDirectory
+ CHARACTER ServiceInterfacePath


Method Detail
Top

PUBLIC BeginRequest ()
Purpose: Tracks the beginning of the PASOE request
Notes:

Top

PUBLIC dispose ()
Purpose: Destroy/Shutdown/Anti-Initializer
Notes:

Top

PUBLIC EndRequest ()
Purpose: Tracks the end of the PASOE request
Notes:

Top

PROTECTED CHARACTER FormatFileName (character)
Purpose: Formats an ABL procedure name to look something like a type name
Notes: Path separators are replaced with "."
The extension is removed

Parameters:
pcFileName CHARACTER
: The name of the Service Interface or Service Name
Returns CHARACTER
A formatted filename
Top

PUBLIC initialize ()
Purpose: Initializer/Startup
Notes:

Top

PROTECTED LoadSettings ()
Purpose: Loads the settings from telemetry.conf
Notes:

Top

PUBLIC SetClientPrincipal (handle)
Purpose: Sets user and domain based on the client principal provided
Notes:

Parameters:
phPrincipal HANDLE
The handle of the client-principal
Top

PUBLIC SetData (integer, character, character)
Purpose: Sets application specific data
Notes:

Parameters:
piDetailLevel INTEGER
The detail level from where this setting should be shown
pcName CHARACTER
The name of the value
pcValue CHARACTER
The value
Top

PUBLIC SetError (Error)
Purpose: Updates details about an Error
Notes:

Parameters:
poError Progress.Lang.Error
The Error to log
Top

PROTECTED SetKey ()
Purpose: Sets the key for the aggregation in ProTop
Notes:

Top

PUBLIC SetRequestUri (URI)
Purpose: Updates the URI
Notes:

Parameters:
poUri OpenEdge.Net.URI
The URI
Top

PUBLIC SetServiceInterface ()
Purpose: Set the initial Service Interface
Notes:

Top

PROTECTED SetServiceInterface (OERequestInfo)
Purpose: Updates the Service Interface
Notes:

Parameters:
poRequestInfo Progress.Lang.OERequestInfo
The OERequestInfo for the current request
Top

PUBLIC SetServiceRequest (character, character)
Purpose: Updates the Service Request
Notes:

Parameters:
pcServiceName CHARACTER
The name of the service component
pcServiceRequest CHARACTER
The name of the service request (method)
Top

PUBLIC SetStopCondition (Stop)
Purpose: Updates details about a StopCondition
Notes:

Parameters:
poStopCondition Progress.Lang.Stop
The StopCondition to log
Top

PUBLIC SetUserInformation (character, character)
Purpose: Updates the user and domain name
Notes:

Parameters:
pcUserName CHARACTER
The user name
pcDomainName CHARACTER
The domain name
Top

PROTECTED ValidateSettings (JsonObject)
Purpose: Validates the Settings
Notes:

Parameters:
poSettings Progress.Json.ObjectModel.JsonObject
The JSON Object containing the Settings
Top

PUBLIC WritePendingRequest ()
Purpose: Writes the Pending Request data
Notes: Writes single JSON object into a ndjson file - so that our
Telemetry output viewer can be used to view those documents



Property Detail
Top

PUBLIC LOGICAL BufferedOutput

Returns LOGICAL
Top

PUBLIC INTEGER DetailLevel

Returns INTEGER
Top

PUBLIC CHARACTER FileNamePattern

Returns CHARACTER
Top

PUBLIC CHARACTER InstanceIdentifier

Returns CHARACTER
Top

PUBLIC CHARACTER OutputDirectory

Returns CHARACTER
Top

PUBLIC CHARACTER PendingRequestFileName

Returns CHARACTER
Top

PUBLIC CHARACTER PendingRequestsOutputDirectory

Returns CHARACTER
Top

PUBLIC CHARACTER ServiceInterfacePath

Returns CHARACTER


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 05:51:45