Masking service events

History

Version	Date	Description	Author
1.0	27 Nov 2023	Initial version	Dima Urban (Unlicensed)
1.1	13 Dec 2023	Added global component for generic service-level events Service Added Synchronization events for resending	Dima Urban (Unlicensed)
1.2	20 Dec 2023	Added license events	Dima Urban (Unlicensed)
1.3	18 Jan 2024	License expiration, size exceeded events	Dima Urban (Unlicensed)
1.3.1	24 Jan 2024	License server connect, updates automatically events	Dima Urban (Unlicensed)
1.4	09 Feb 2024	Masking API direct call event, new license check events	Dima Urban (Unlicensed)
1.4.1	16 Feb 2024	Service license is corrupt or not found - added	Dima Urban (Unlicensed)
1.5	29 Feb 2024	Hardware statistics exchange	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

System parameters
Data Sources
Environments
Masking Rules
Privacy Policies
Users
Masking configurations
Service (service level events)

	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
16	Environment <Name> importing was started	Info	Environments	Import
17	Environment <Name> importing was interrupted	Info	Environments	Import
18	Environment <Name> importing was succesfuly finished	Info	Environments	Import
19	Environment <Name> importing was failed due to <error reason>	Error	Environments	Import
20	Environment <Name> refreshing was started	Info	Environments	Refresh
21	Environment <Name> refreshing was interrupted	Info	Environments	Refresh
22	Environment <Name> refreshing was succesfuly finished	Info	Environments	Refresh
23	Environment <Name> refreshing failed due to <error reason>	Error	Environments	Refresh
24	Masking configuration <Name> loading was successfully completed	Info	Environments	Load masking configuration
25	Masking configuration <Name> loading was failed due to <error reason>	Error	Environments	Load masking configuration
26	Masking configuration <Name> from environment <Name> was successfully saved into Masking configurations list	Info	Environments	Save masking configuration
27	Masking configuration <Name> saving from environment <Name> was failed	Error	Environments	Save masking configuration
28	All datasources refreshing was started	Info	Privacy Dashboard	Refresh All
29	All datasources refreshing was interrupted	Info	Privacy Dashboard	Refresh All
30	All datasources refreshing was succesfuly finished	Info	Privacy Dashboard	Refresh All
31	All datasources refreshing failed due to <error reason>	Error	Privacy Dashboard	Refresh All
32	Environment <Name> scanning was started	Info	Environments	Scan
33	Environment <Name> scanning was interrupted	Info	Environments	Scan
34	Environment <Name> scanning was succesfuly finished	Info	Environments	Scan
35	Environment <Name> scanning failed due to <error reason>	Error	Environments	Scan
36	All datasources scanning was started	Info	Privacy Dashboard	Scan All
37	All datasources scanning was interrupted	Info	Privacy Dashboard	Scan All
38	All data sources scanning was succesfuly finished	Info	Privacy Dashboard	Scan All
39	All datasources scanning failed due to <error reason>	Error	Privacy Dashboard	Scan All
40	Environment <Name> masking rules were succesfuly applied for masking	Info	Environments	Update Masking
41	Failed to apply scanned masking rules to environment <Name> due to <error reason>	Error	Environments	Update Masking
42	Environment <Name> masking was started	Info	Environments	Mask \| Mask preview
43	Environment <Name> masking was interrupted	Info	Environments	Mask \| Mask preview
44	Environment <Name> masking was succesfuly finished	Info	Environments	Mask \| Mask preview
45	Environment <Name> table <Schema>.<Table> was succesfully masked in preview mode	Info	Environments	Mask preview
46	Environment <Name> table <Schema>.<Table> masking preview mode was failed due to <error reason>	Error	Environments	Mask preview
47	Environment <Name> masking was failed due to <error reason>	Error	Environments	Mask \| Mask preview
48	Table <Schema>.<Table> masking for environment <Name> was failed due to <error reason>	Error	Environments	Mask \| Mask preview
49	A custom masking rule <Name> was successfully synced	Info	Masking Rules	Synchronization
50	A custom masking rule <Name> was successfully added	Info	Masking Rules	Add Masking Rule
51	Failed to add custom masking rule <Name> due to <error reason>	Error	Masking Rules	Add Masking Rule
52	A custom masking rule <Name> was successfully removed	Info	Masking Rules	Remove Masking Rule
53	Failed to remove custom masking rule <Name> due to <error reason>	Error	Masking Rules	Remove Masking Rule
54	A masking rule <Name> was successfully duplicated	Info	Masking Rules	Duplicate Masking Rule
55	Failed to duplicate masking rule <Name> due to <error reason>	Error	Masking Rules	Duplicate Masking Rule
56	A Privacy Policy <Name> was successfully synced	Info	Privacy Policies	Synchronization
57	A Privacy Policy <Name> was successfully added	Info	Privacy Policies	Add Privacy Policy
58	Failed to add Privacy Policy <Name> due to <error reason>	Error	Privacy Policies	Add Privacy Policy
59	A Privacy Policy <Name> was successfully removed	Info	Privacy Policies	Remove Privacy Policy
60	Failed to remove Privacy Policy <Name> due to <error reason>	Error	Privacy Policies	Remove Privacy Policy
61	The user <Name> was succesfuly synced	Info	Users	Synchronization
62	The user role <Role Name> was succesfuly synced	Info	Users	Synchronization
63	The user role <Role Name> was succesfuly created	Info	Users	Create Role
64	Failed to create user role <Role Name> due to <error reason>	Error	Users	Create Role
65	The user <User Name> was succesfuly created	Info	Users	Create User
66	Failed to create user <User Name> due to <error reason>	Error	Users	Create User
67	The user role <Role Name> was succesfuly removed	Info	Users	Remove Role
68	Failed to remove user role <Role Name> due to <error reason>	Error	Users	Remove Role
69	The user <User Name> was succesfuly removed	Info	Users	Remove User
70	Failed to remove user <User Name> due to <error reason>	Error	Users	Remove User
71	The system parameters were successfully updated	Info	System parameters	Update system parameters
72	The system parameters were successfully synced	Info	System parameters	Synchronization
73	Themasking configuration <Name> was successfully synced	Info	Masking configurations	Synchronization
74	The masking configuration <Name> was succesfuly created	Info	Masking configurations	Create Masking configuration
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
78	The masking configuration <Name> was succesfuly exported to file	Info	Masking configurations	Export Masking configuration
79	Masking configuration <Name> exporting was failed due to <error reason>	Error	Masking configurations	Export Masking configuration
80	The masking configuration <Name> was succesfuly updated	Info	Masking configurations	Update Masking configuration
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

[
    {
    "Action": "Mask",
    "ApplicationType": "Masking",
    "ApplicationVersion": "27.0.1",
    "Body":
        {
        "dataSourceName": "DB2 Demo Endpoint",
        "elapsedTime": 1625,
        "environmentId": "65686e026bb2ae0690c2d5eb",
        "environmentName": "test_DB2",
        "finished": "Nov 30, 2023 1:12:19 PM",
        "id": "65686e136bb2ae0690c2d6c0",
        "message": "",
        "name": "test_DB2-1701342738317",
        "pid": "8507601749",
        "progress": "100% (Tables 1/1)",
        "started": "Nov 30, 2023 1:12:18 PM",
        "startedBy": "admin / Admins",
        "status": "COMPLETE",
        "type": "DATA_MASKING"
        },
    "ClientId": "Dev_team",
    "Component": "Environments",
    "Date": "2023-11-30 13:12:19.942Z",
    "EventId": "680805434",
    "ID": "65686e13ac9297002f52c797",
    "LicenseId": "8720847032816526877",
    "Message": "Environment 'test_DB2' was successfully masked",
    "Object": "test_DB2",
    "ObjectId": "65686e026bb2ae0690c2d5eb",
    "Severity": "INFO",
    "Status": "COMPLETE",
    "User": "admin / Admins"
    }
]

Sample 2

{
    _id:"65faf5df7c526518c756f877",
    applicationType:"Masking",
    applicationVersion:"30.0.1",
    clientId:"Dev_team",
    licenseId:"3016864372698098264",
    eventId:"65faf5cb7f775253aca99710",
    date:"2024-03-20T14:42:39.036Z",
    user:"SYSTEM",
    severity:"INFO",
    component:"Hardware statistics",
    action:"Synchronization",
    object:"1084140228",
    objectId:"1084140228",
    status:"SYNCHRONIZATION",
    message:"Current hardware stats were successfully synced",
    body:{
        cpuModel:"Intel64 Family 6 Model 158 Stepping 10, GenuineIntel",
        cpuCores:6,
        cpuFrequency:"MaxClockSpeed 2904 MHz",
        totalDiskSpace:2128936423424,
        usedDiskSpace:1194268278784,
        freeDiskSpace:934668144640,
        totalMemory:451936256,
        usedMemory:82159104,
        freeMemory:3724696064
    },
    sentToCollector:true
}