Masking events WIP

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.

List of events components

System parameters
Data Sources
Environments
Privacy Dashboard
Masking Rules
Privacy Policies
Users
Masking configurations

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

JSON sample

[
    {
        "date": "2023-11-13T10:09:27.977Z",
        "message": "DataSource 'LiveGI' was successfully added",
        "severity": "INFO",
        "component": "Data Sources",
        "action": "Add Data Source",
        "object": "LiveGI",
        "ObjectID": "402a5c3647b04da6ad649430aeb4c298",
        "status": "COMPLETE",
        "user": "acc / Admins",
        "clientID": "admin@megacorpbank.com",
        "licenseID": "3a429c0b15854cd1ab6f238ee2e224d0",
        "applicationType": "Masking",
        "applicationVersion": "27.0"
    },
    {
        "date": "2023-11-13T10:09:28.466Z",
        "message": "Environment 'LiveEnv' was successfully created",
        "severity": "INFO",
        "component": "Environments",
        "action": "Add Environment",
        "object": "LiveEnv",
        "ObjectID": "65d0bd496a944a2296864eb39e60dd62",
        "status": "COMPLETE",
        "user": "acc / Admins",
        "clientID": "admin@megacorpbank.com",
        "licenseID": "c3f6baf2fdd4426d8add00357467509a",
        "applicationType": "Masking",
        "applicationVersion": "27.0"
    },
    {
        "date": "2023-11-13T10:09:28.548Z",
        "message": "A Privacy Policy 'GDPR' was successfully added",
        "severity": "INFO",
        "component": "Privacy Policies",
        "action": "Add Privacy Policy",
        "object": "GDPR",
        "ObjectID": "fdc78cf6496449e8a2ea22fe331c94cf",
        "status": "COMPLETE",
        "user": "acc / Admins",
        "clientID": "admin@megacorpbank.com",
        "licenseID": "57108c838f244a6c9aadf31ae4c57171",
        "applicationType": "Masking",
        "applicationVersion": "27.0"
    }
]