TTMSFNCCloudLogger
Usage
TTMSFNCCloudLogger is a wrapper component that provides access to the Exceptionless, Sentry and Rollbar API’s which are capable of managing exceptions and log messages.
See the documentation of the separate services for more detailed information.
Email address and password are used for Exceptionless and a token is necessary for Sentry and Rollbar.
Properties
| Property name |
Description |
| LogService: TTMSFNCCloudLoggerService |
The service that is being used. lsExceptionless, lsRollbar or lsSentry.) When switching between services, all of the stored projects are cleared. |
| EmailAddress: String |
The email address of the user to authenticate. (Used for Exceptionless.) |
| Password: String |
The password of the user to authenticate. (Used for Exceptionless.) |
| Token: String |
The authentication token of the user with the necessary scopes. (Used for Sentry and Rollbar.) |
| Projects: TTMSFNCCloudLoggerProjects [TTMSFNCCloudLoggerProject] |
Contains the different projects that you have set up in your service.These projects each have different stacks/issues/items (TTMSFNCCloudLoggerStack) in the collection Stacks. This is a group of exceptions and messages with the same parameters and can be requested in the same way as the Projects on TTMSFNCCloudLoggerProject level. These stacks in turn have the property Events (TTMSFNCCloudLoggerEvents), which is a collection of the exceptions and messages and can be retrieved in the same way on TTMSFNCCloudLoggerStack level. |
| ProjectCursor: String |
The cursor to add to the GetProjects method to retrieve the following projects. |
Methods
| Method name |
Description |
| Connect |
Checks if the authentication token is valid or retrieves an authentication token. (Has the possibility to add an email address and password or an authentication token as a parameter in case this was not set via the properties.) |
| GetProjects/GetAllProjects |
Retrieve (all) the projects for the account. The procedure fills the Projects (TTMSFNCCloudLoggerProjects) property. |
| GetProjectByID |
Retrieve the TTMSFNCCloudLoggerProject object that has the requested ID. |
| GetProjectByName |
Retrieve the TTMSFNCCloudLoggerProject object that has the requested name. |
| GetItemByID |
Retrieve the TTMSFNCCloudLoggerStack object that has the requested ID. |
| LogException |
Sends an exception to the project with a message, an error type and source. Can be extended with an optional stacktrace, level and timestamp. (In the Rollbar service the environment is fixed to the default value ‘production’.) |
| LogMessage |
Sends a message to the project. Can be extended with an optional level, timestamp and source. (In the Rollbar service the environment is fixed to the default value ‘production’.) |
Events
| Event name |
Description |
| OnConnected |
Event fired when the authorization token is retrieved or valid |
| OnGetProjects/OnGetAllProjects |
Event fired when the/all requested projects for the account are retrieved. This event returns additional to the sender and the request result also the Projects (TTMSFNCCloudLoggerProjects). |
| OnGetStacks/OnGetAllStacks |
Event fired when the/all requested stacks from a project are retrieved. This event returns additional to the sender and the request result also the project (TTMSFNCCloudLoggerProject) for which it was returned and the list of stacks (TTMSFNCCloudLoggerStacks). |
| OnGetEvents/OnGetAllEvents |
Event fired when the requested events for a stack are retrieved. This event returns additional to the sender and the request result also the stack of the project(TTMSFNCCloudLoggerStacks) and the requested events (TTMSFNCCloudLoggerEvents). |
| OnLogException |
Event fired when the created exception is sent to the project. This event returns the sender and the request result. |
| OnLogMessage |
Event fired when the created exception is sent to the project. This event returns the sender and the request result. |