Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The events subsystem in the Accelario Masking service functions as a monitoring and notification framework. It captures and logs various business events related to system and user processes, providing essential visibility for users and support personnel.

Description

Event logging.

The subsystem logs distinct events, such as adding or removing data sources and creating environments, or masking process steps. Each event is recorded with specific details like the action taken, the component involved, and the name of the entity (e.g., data source or environment).

Severity level.

Events are categorized by severity levels - 'Info' for successful operations and 'Error' for failed attempts or operations. This categorization aids in the quick identification of the status and importance of each event.

Message details.

Each event generates a descriptive message. For successful operations, the message confirms the successful completion (e.g., "Data Source <Name> was successfully added"). In case of failures, the message includes the error reason (e.g., "Failed to add data source <Name> due to <error reason>"), which is crucial for troubleshooting.

Component.

The subsystem is component-oriented, logging events under specific components like 'Data sources' or 'Environments'. This allows for easy filtering and analysis of events related to specific aspects of the system.

Action Tracking.

Each event message includes the type of action taken - such as 'Add data source', 'Remove data source', or 'Add environment'. This provides a clear context on the nature of the event.

Datetime.

This attribute records the exact date and time when the event occurred. It's crucial for tracking the sequence of events, understanding the system's behavior over time, and correlating events for troubleshooting.

Client ID.

This unique identifier is likely specific to the client or instance of the application where the event occurred. It's useful for distinguishing events across different clients or service instances.

License ID.

This is a unique identifier for the specific license under which the Masking solution is operating. Tracking events by license ID is beneficial for license management, auditing, and understanding usage or issues per licensed instance.

Application type.

Its is consistently 'Masking', the Accelario UsageMate event logging system is shared across multiple Accelario services.

Application version.

This specifies the version of the Masking service during the event. It's important for identifying issues or behaviors that are specific to certain versions and for managing version-wise operational insights.

Object name.

If applicable, this attribute provides a name of the specific component within the system to which the event is related. This is a name for a data source, environment, or other components in the system, enabling precise referencing of the event’s context.

Object reference ID.

If applicable, this ID provides a reference to the specific component object within the system to which the event is related. This could be a unique identifier for a data source, environment, or other components in the system, enabling precise linking of the event’s context.

User.

If applicable, this records which user (by username or user ID) was involved in or responsible for the event. This is particularly important for actions that are user-initiated or for auditing purposes to track user activity and responsibility.

Overall, this subsystem enhances operational transparency, aids in debugging, and assists in system auditing by providing a detailed, categorized, and easily navigable record of system events.

...

History

Version

Date

Description

Author

1.0

Initial version

Dima Urban (Unlicensed)

1.1

Added global component for generic service-level events Service

Added Synchronization events for resending

Dima Urban (Unlicensed)

1.2

Added license events

Dima Urban (Unlicensed)

1.3

License expiration, size exceeded events

Dima Urban (Unlicensed)

1.3.1

License server connect, updates automatically events

Dima Urban (Unlicensed)

1.4

Masking API direct call event, new license check events

Dima Urban (Unlicensed)

1.4.1

Service license is corrupt or not found - added

Dima Urban (Unlicensed)

1.5

Hardware statistics exchange

Dima Urban (Unlicensed)

1.5.1

Hardware statistics exchange, error message

Dima Urban (Unlicensed)

Description

The centralized events system UsageMate service in the Accelario functions as a monitoring and notification framework. It captures and logs various business events related to system and user processes, providing essential visibility for users and support personnel.

The detailed description of UsageMate service refer /wiki/spaces/GEN/pages/2191753225

List of masking components for masking events

  1. System parameters

  2. Data Sources

  3. EnvironmentsPrivacy Dashboard

  4. Masking Rules

  5. Privacy Policies

  6. Users

  7. Masking configurations

  8. Service (service level events)

Source Environment Environment Importing importedFailed to import Refreshing refreshedFailed to refresh Loading masking Loading masking InfoSaving masking Info data sources data sources data sources where succesfuly refreshedFailed to refresh all data sources scannedFailed to scan where scannedFailed to scan all data sources Environment Environmen masked succesfulled Failed to mask Failed to mask table data source Failed to create masking configuration <Name> Create Failed to export masking Failed to update masking

Message

Severity

Component

Action

1

Data Source <Name> was succesfuly added

Info

Data Sources

Add Data Source

2

Data Source <Name> was succesfuly synced

Info

Data Sources

Synchronization

3

Failed to add data source <Name> due to <error reason>

Error

Data Sources

Add Data Source

4

Data Source <Name> was succesfuly removed

Info

Data Sources

Remove Data Source

5

Failed to remove data source <Name> due to <error reason>

Error

Data Sources

Remove Data Source

6

Data

source <Name> was succesfuly updated

Info

Data Sources

Update Data Source

7

Failed to update data source <Name> due to <error reason>

Error

Data Sources

Update Data Source

8

Environment <Name> was succesfuly synced

Info

Environments

Synchronization

9

Environment <Name> was succesfuly created

Info

Environments

Add Environment

10

Failed to add

environment <Name> due to <error reason>

Error

Environments

Add Environment

11

Environment <Name> was succesfuly removed

Info

Environments

Remove Environment

12

Failed to remove Environment <Name> due to <error reason>

Error

Environments

Remove Environment

13

Environment header <Name> info was successfully updated

Info

Environments

Update Environment

14

Environment <Name> data structure update initiated refresh procedure

Info

Environments

Update Environment

15

Failed to update

environment <Name> due to <error reason>

Error

Environments

Update Environment

1516

Environment <Name> importing was started

Info

Environments

Import

1617

Environment <Name> importing was interrupted

Info

Environments

Import

1718

Environment <Name> importing was succesfuly

finished

Info

Environments

Import

1819

Environment <Name> importing was failed due to <error reason>

Error

Environments

Import

1920

Environment <Name> refreshing was started

Info

Environments

Refresh

2021

Environment <Name> refreshing was interrupted

Info

Environments

Refresh

2122

Environment <Name> refreshing was succesfuly

finished

Info

Environments

Refresh

2223

Environment <Name> refreshing failed due to <error reason>

Error

Environments

Refresh

2324

Masking configuration <Name> loading was successfully completed

Info

Environments

Load masking configuration

2425

Masking configuration <Name> loading was failed due to <error reason>

Error

Environments

Load masking configuration

2526

Masking configuration <Name> from environment <Name> was successfully saved into Masking configurations list

Info

Environments

Save masking configuration

2627

Masking configuration <Name> saving from environment <Name> was failed

Error

Environments

Save masking configuration

2728

All

datasources refreshing was started

Info

Privacy Dashboard

Refresh All

2829

All

datasources refreshing was interrupted

Info

Privacy Dashboard

Refresh All

2930

All

datasources refreshing was succesfuly finished

Info

Privacy Dashboard

Refresh All

30
31

All datasources refreshing failed due to <error reason>

Error

Privacy Dashboard

Refresh All

3132

Environment <Name> scanning was started

Info

Environments

Scan

3233

Environment <Name> scanning was interrupted

Info

Environments

Scan

3334

Environment <Name> scanning was succesfuly

finished

Info

Environments

Scan

3435

Environment <Name> scanning failed due to <error reason>

Error

Environments

Scan

3536

All datasources scanning was started

Info

Privacy Dashboard

Scan All

3637

All datasources scanning was interrupted

Info

Privacy Dashboard

Scan All

3738

All data sources

scanning was succesfuly

finished

Info

Privacy Dashboard

Scan All

38
39

All datasources scanning failed due to <error reason>

Error

Privacy Dashboard

Scan All

3940

Environment <Name> masking rules were succesfuly applied for masking

Info

Environments

Update Masking

4041

Failed to apply scanned masking rules to

environment <Name> due to <error reason>

Error

Environments

Update Masking

4142

Environment <Name> masking was started

Info

Environments

Mask | Mask preview

4243

Environment <Name> masking was interrupted

Info

Environments

Mask | Mask preview

4344

Environment <Name> masking was succesfuly

finished

Info

Environments

Mask | Mask preview

4445

Environment <Name> table <Schema>.<Table> was

succesfully masked in preview mode

Info

Environments

Mask preview

4546

Environment <Name> table <Schema>.<Table> masking preview mode was failed due to <error reason>

Error

Environments

Mask preview

4647

Environment <Name> masking was failed due to <error reason>

Error

Environments

Mask | Mask preview

47
48

Table <Schema>.<Table> masking for

environment <Name> was failed due to <error reason>

Error

Environments

Mask | Mask preview

4849

A custom masking rule <Name> was successfully synced

Info

Masking Rules

Synchronization

4950

A custom masking rule <Name> was successfully added

Info

Masking Rules

Add Masking Rule

5051

Failed to add custom masking rule <Name> due to <error reason>

Error

Masking Rules

Add Masking Rule

5152

A custom masking rule <Name> was successfully removed

Info

Masking Rules

Remove Masking Rule

5253

Failed to remove custom masking rule <Name> due to <error reason>

Error

Masking Rules

Remove Masking Rule

5354

A masking rule <Name> was successfully duplicated

Info

Masking Rules

Duplicate Masking Rule

5455

Failed to duplicate masking rule <Name> due to <error reason>

Error

Masking Rules

Duplicate Masking Rule

5556

A Privacy Policy <Name> was successfully synced

Info

Privacy Policies

Synchronization

5657

A Privacy Policy <Name> was successfully added

Info

Privacy Policies

Add Privacy Policy

5758

Failed to add Privacy Policy <Name> due to <error reason>

Error

Privacy Policies

Add Privacy Policy

5859

A Privacy Policy <Name> was successfully removed

Info

Privacy Policies

Remove Privacy Policy

5960

Failed to remove Privacy Policy <Name> due to <error reason>

Error

Privacy Policies

Remove Privacy Policy

6061

The user <Name> was succesfuly synced

Info

Users

Synchronization

6162

The user role <Role Name> was succesfuly synced

Info

Users

Synchronization

6263

The user role <Role Name> was succesfuly created

Info

Users

Create Role

6364

Failed to create user role <Role Name> due to <error reason>

Error

Users

Create Role

6465

The user <User Name> was succesfuly created

Info

Users

Create User

6566

Failed to create user <User Name> due to <error reason>

Error

Users

Create User

6667

The user role <Role Name> was succesfuly removed

Info

Users

Remove Role

6768

Failed to remove user role <Role Name> due to <error reason>

Error

Users

Remove Role

6869

The user <User Name> was succesfuly removed

Info

Users

Remove User

6970

Failed to remove user <User Name> due to <error reason>

Error

Users

Remove User

7071

The system parameters were successfully updated

Info

System parameters

Update system parameters

7172

The system parameters were successfully synced

Info

System parameters

Synchronization

7273

Themasking configuration <Name> was successfully synced

Info

Masking configurations

Synchronization

7374

The masking configuration <Name> was succesfuly created

Info

Masking configurations

Create Masking configuration

74
75

Masking configuration <Name> creating was failed due to <error reason>

Error

Masking configurations

Create Masking configuration

76

The masking configuration <Name> was succesfuly imported

Info

Masking configurations

Import Masking configuration

77

Masking configuration <Name> importing was failed due to <error reason>

Error

Masking configurations

Import Masking configuration

7578

The masking configuration <Name> was succesfuly exported to file

Info

Masking configurations

Export Masking configuration

76
79

Masking configuration <Name> exporting was failed due to <error reason>

Error

Masking configurations

Export Masking configuration

7780

The masking configuration <Name> was succesfuly updated

Info

Masking configurations

Update Masking configuration

78
81

Masking configuration <Name> updating was failed due to <error reason>

Error

Masking configurations

Update Masking configuration

82

Failed to send events to Usagemate due to <error reason>

Error

Service

Synchronization

83

Failed to connect with Accelario license service

Error

Service

Synchronization

84

Sending events to Usagemate was successfully restored

Info

Service

Synchronization

85

Service license was successfully updated

Info

License

Synchronization

86

Service license was successfully renewed automatically

Info

License

Synchronization

87

Current hardware stats were successfully synced

Info

Hardware statistics

Synchronization

88

Failed to collect and send current hardware stats

Error

Hardware statistics

Synchronization

89

Failed to update service license due to <error reason>

Error

License

Synchronization

90

License has expired

Error

License

License check

91

Service license is corrupt or not found

Error

License

License check

92

The purchased license is expiring within %X% days.

Warning

License

License check

93

The total data sources size %Size% exceeds license capacity %DBSizeLicense%.

Error

License

License check

94

Connected data sources total size %Size% exceeds X% of the purchased license capacity %DBSizeLicense%.

Warning

License

License check

95

External data values masking successfully executed.

Info

Service

Masking of external values

96

External data values masking call failed during processing.

Error

Service

Masking of external values

Notes:

Due to the logic of the UsageMate processing, if license is corrupt or not found - local events will be not sent to the Usagemate

JSON sample

Code Block
languagejson
[
    {
   
    "dateAction": "2023-11-13T10:09:27.977ZMask",
   
    "messageApplicationType": "DataSource 'LiveGI' was successfully addedMasking",
  
     "severityApplicationVersion": "INFO27.0.1",
    "Body":
      "component": "Data Sources",{
        "actiondataSourceName": "AddDB2 DataDemo SourceEndpoint",
        "objectelapsedTime": "LiveGI"1625,
        "ObjectIDenvironmentId": "402a5c3647b04da6ad649430aeb4c29865686e026bb2ae0690c2d5eb",
        "statusenvironmentName": "COMPLETEtest_DB2",
        "userfinished": "acc / AdminsNov 30, 2023 1:12:19 PM",
        "clientIDid": "admin@megacorpbank.com65686e136bb2ae0690c2d6c0",
        "licenseIDmessage": "3a429c0b15854cd1ab6f238ee2e224d0",
        "applicationTypename": "Maskingtest_DB2-1701342738317",
        "applicationVersionpid": "27.08507601749",
    },     {"progress": "100% (Tables 1/1)",
        "datestarted": "2023-11-13T10:09:28.466ZNov 30, 2023 1:12:18 PM",
        "messagestartedBy": "Environmentadmin 'LiveEnv' was successfully created/ Admins",
        "severitystatus": "INFOCOMPLETE",
        "componenttype": "Environments",DATA_MASKING"
        },
    "actionClientId": "Add EnvironmentDev_team",
    "Component": "Environments",
    "objectDate": "LiveEnv2023-11-30 13:12:19.942Z",
    "EventId": "680805434",
    "ObjectIDID": "65d0bd496a944a2296864eb39e60dd6265686e13ac9297002f52c797",
    "LicenseId": "8720847032816526877",
    "statusMessage": "COMPLETE",
   Environment 'test_DB2' was successfully masked",
    "userObject": "test_DB2"acc,
/ Admins",   "ObjectId": "65686e026bb2ae0690c2d5eb",
    "clientIDSeverity": "admin@megacorpbank.comINFO",
    "Status": "COMPLETE",
    "licenseIDUser": "c3f6baf2fdd4426d8add00357467509aadmin / Admins",
    }
]
  "applicationType": "Masking

Sample 2

Code Block
languagejson
{
    _id:"65faf5df7c526518c756f877",
    applicationType:"Masking",
    "applicationVersion": "2730.0.1",
    },clientId:"Dev_team",
    licenseId:"3016864372698098264",
{    eventId:"65faf5cb7f775253aca99710",
    "date": "20232024-1103-13T1020T14:0942:2839.548Z036Z",
    user:"SYSTEM",
    severity:"message": "A Privacy Policy 'GDPR' was successfully added",INFO",
    component:"Hardware statistics",
    action:"Synchronization",
    object:"1084140228",
    objectId:"severity": "INFO",1084140228",
    status:"SYNCHRONIZATION",
    message:"Current hardware stats were successfully "component": "Privacy Policies",synced",
    body:{
        cpuModel:"Intel64 Family 6 Model "action": "Add Privacy Policy158 Stepping 10, GenuineIntel",
        "object": "GDPR"cpuCores:6,
        "ObjectID": "fdc78cf6496449e8a2ea22fe331c94cfcpuFrequency:"MaxClockSpeed 2904 MHz",
        "status": "COMPLETE"totalDiskSpace:2128936423424,
        "user": "acc / Admins"usedDiskSpace:1194268278784,
        "clientID": "admin@megacorpbank.com"freeDiskSpace:934668144640,
        "licenseID": "57108c838f244a6c9aadf31ae4c57171"totalMemory:451936256,
        "applicationType": "Masking"usedMemory:82159104,
        "applicationVersion": "27.0"
freeMemory:3724696064
    },
   } ]sentToCollector:true
}