ZENfra Data Collection Instructions (Direct Collection and ZENCollector Collection)

Welcome to the user instruction document for the ZENfra Data Collection process. In this document, you will learn how to utilize both the Direction Method and the ZENCollector Method for the data collection process.

By utilizing any of the below-mentioned methods, the user will get a secure and automated (based on user configuration) data collection process.

In the Direction Method, the ZENfra server directly retrieves data logs from the warehouse, streamlining the collection process and consolidating information efficiently.

This method facilitates direct log collection from user systems. To streamline the process, install and configure ZENcollector on the systems from which you want to upload logs to the ZENfra tool. 

In high-security IT environments, ZENCollector is the recommended choice for efficient and protected log retrieval. However, in less secure environments, users can opt for the direct collection method.

Follow the instructions given below to download and install ZENCollector on a computer or virtual machine.

• Start by clicking on the 'Data Collection' menu.
• This will take you to the 'Data Collection - Repository' page.
• On this page, look for the 'Download ZENCollector' button situated at the upper right corner.
• Click on the 'Download ZENCollector ' button to initiate the download process.
• Please be patient and wait for a few minutes as the ZENCollector Application is downloaded to your computer or virtual machine.

• After the download is complete, locate the ZENCollector file in the designated download section.
• Move the downloaded file to your system's Local Disk C.
• Right-click on the ZENCollector file and select the 'Extract All' option to extract the contents.

• Look for an application named 'ZENfra.Collector.Manager' in the extracted files.
• Right-click on the 'ZENfra.Collector.Manager' Application and choose the 'Run As Administrator' option.

( You will be guided through the installation process for ZENCollector. Kindly follow these attached images, to complete the installation process. )

Finally, the Download and Installation Process of ZENCollector is over.

• Access the ZENfra tool and navigate to the 'Data Collection' menu.
• Click on the 'New Repo' button located at the top right corner of the page.

• This action will redirect you to the page where you can select the configuration type, such as NFS, FTP, SFTP, API, or Cloud.
• Select the desired Configuration Method, which will direct you to the Repository Configuration page.
• Each configuration type will have its unique fields and common fields in the repository configuration page that need to be filled in to initiate the data collection process.

• Click on the NFS method to proceed.
• You will be directed to a question asking, "Is This Folder Already Mounted on This Server?"
• choose one of the two options (Yes / No) provided as an answer.

• Collection Method:

1. Direction Method: In this method, the data logs are collected using the ZENfra server.
2. ZENCollector Method: In this method, the data logs are collected through ZENfra’s data collection agent “ZENCollector”.

• Collection Source: this field will be active only for the ZENCollector Method, not for the Direct Collection Method. this input value will be automatically derived if the user chooses the ZENCollector method in the collection method field and sign-in to the ZENfra tool from a single device. For multiple devices, the user can choose from the drop-down options. 

• Config Name: enter a configuration name of your choice.
• File Path: provide the file path of the location where data logs are stored. (provide the file path by following the instructions provided at the right side)
• Log Process: choose between 'Upload Only' (to upload data without parsing) or 'Upload and Process' (for both uploading and continuous parsing).

• Device Type: select the type of device's log you intend to upload. 

• Name Pattern: specify the name pattern of the logs using asterisks, like this: *xxx*. ( Kindly understand the information given below and then proceed ).
• Exclude Pattern: optional field to ignore specific file patterns.

• Frequency: optional feature allowing you to schedule data log collection.
• Start & End Period: if frequency is enabled, provide the start date and time, as well as the end date.

• Event Type: static field contains row values, collecting success and collecting failure.
• E-Mail: Enable the button to receive notifications for successful or failed log collection.
• Users: enter the email address(s) of users for successful or failed log collection notifications (if the email option is enabled).
• Edit Email Content: click the edit icon to modify the default content of the notification message according to your requirements. 

If you select the "No" option on the configuration type page for that question, you will be redirected to the repository configuration page where there will be some changes in the repo settings fields.

Here are the fields of the repo settings when choosing the "No" option:

• Collection Method:

1. Direction Method: In this method, the data logs are collected using the ZENfra server.
2. ZENCollector Method: In this method, the data logs are collected through ZENfra’s data collection agent “ZENCollector”.

• Collection Source: this field will be active only for the ZENCollector Method, not for the Direct Collection Method. this input value will be automatically derived if the user chooses the ZENCollector method in the collection method field and sign-in to the ZENfra tool from a single device. For multiple devices, the user can choose from the drop-down options. 

• Mount Option: choose the appropriate mount type from the dropdown menu.
• NAS Server Name / IP Address: enter the name or IP address of your NAS server.
• Share Folder Name: provide the path of the share folder.
• Mount Point: specify the path of the mount point.
• Log Process: choose between 'Upload Only' (to upload data without parsing) or 'Upload and Process' (for both uploading and continuous parsing).

For visual reference and guidance, please refer to the pictures provided above.

( NOTE: The File Name Pattern Setting, Scheduling Setting, and Notification Setting features of the ZENCollector are common for all types of Configuration Methods. )

By clicking on the ‘FTP Configuration Method’, you will be redirected to the Repository Configuration page.

There you will have some Repo Setting Fields to fill in to configure the data collection process. The Repo Setting Fields are mentioned below:

• Collection Method:

1. Direction Method: In this method, the data logs are collected using the ZENfra server.
2. ZENCollector Method: In this method, the data logs are collected through ZENfra’s data collection agent “ZENCollector”.

• Collection Source: this field will be active only for the ZENCollector Method, not for the Direct Collection Method. this input value will be automatically derived if the user chooses the ZENCollector in the collection method field and sign-in to the ZENfra tool from a single device. For multiple devices, the user can choose from the drop-down options. 

• Host Name: Enter your Host Name.
• Port: Provide your Port ID.
• Remote Path: Enter the remote path.
• Password: Enter the password.
• Encryption: Select your host encryption type if encryption exists.
• Log Process: choose between 'upload only' (to upload data without parsing) or 'upload and process' (for both uploading and continuous parsing).

( NOTE: The File Name Pattern Setting, Scheduling Setting, and Notification Setting features of the ZENCollector are common for all types of Configuration Methods. )

By clicking on the ‘SFTP Configuration Method’, you will be redirected to the Repository Configuration page.

There you will have some Repo Setting Fields to fill in to configure the data collection process. The Repo Setting Fields are mentioned below:

• Collection Method:

1. Direction Method: In this method, the data logs are collected using the ZENfra server.
2. ZENCollector Method: In this method, the data logs are collected through ZENfra’s data collection agent “ZENCollector”.

• Collection Source: this field will be active only for the ZENCollector Method, not for the Direct Collection Method. this input value will be automatically derived if the user chooses the ZENCollector in the collection method field and sign-in to the ZENfra tool from a single device. For multiple devices, the user can choose from the drop-down options. 
• Host Name: Enter your Host Name.
• Port: Provide your Port ID.
• Remote Path: Enter the remote path.
• Password: Enter the password.
• Log Process: choose between 'upload only' (to upload data without parsing) or 'upload and process' (for both uploading and continuous parsing).

( NOTE: The File Name Pattern Setting, Scheduling Setting, and Notification Setting features of the ZENCollector are common for all types of Configuration Methods. )

By clicking on the ‘API Configuration Method’, you will be redirected to the API Selection Page.

By selecting the required API Configuration Method,  you will be directed to the Repository Configuration page.

There you will have some Repo Setting Fields to fill in to configure the data collection process. 

By clicking on the ‘Pure API Configuration Method’, you will be redirected to the Repository Configuration page.

There you will have some Repo Setting Fields to fill in to configure the data collection process. The Repo Setting Fields are mentioned below:

• Collection Method:

1. Direction Method: In this method, the data logs are collected using the ZENfra server.
2. ZENCollector Method: In this method, the data logs are collected through ZENfra’s data collection agent “ZENCollector”.

• Collection Source: this field will be active only for the ZENCollector Method, not for the Direct Collection Method. this input value will be automatically derived if the user chooses the ZENCollector in the collection method field and sign-in to the ZENfra tool from a single device. For multiple devices, the user can choose from the drop-down options. 
• Config Name: Specify the configuration name.
• Host Name: Provide the host name.
• API Token: Enter the API token.
• Log Process: choose between 'upload only' (to upload data without parsing) or 'upload and process' (for both uploading and continuous parsing).

( NOTE: The File Name Pattern Setting, Scheduling Setting, and Notification Setting features of the ZENCollector are common for all types of Configuration Methods. )

• Collection Method:

1. Direction Method: In this method, the data logs are collected using the ZENfra server.
2. ZENCollector Method: In this method, the data logs are collected through ZENfra’s data collection agent “ZENCollector”.

• Collection Source: this field will be active only for the ZENCollector Method, not for the Direct Collection Method. this input value will be automatically derived if the user chooses the ZENCollector in the collection method field and sign-in to the ZENfra tool from a single device. For multiple devices, the user can choose from the drop-down options.
• Config Name: enter a configuration name of your choice.
• vCenter/Host: Enter the vCenter/Hostname or IP address in the designated field.
• Username & Password: Provide the user credentials (username and password) for the specified vCenter/Host.
• Log Process: choose between 'Upload Only' (to upload data without parsing) or 'Upload and Process' (for both uploading and continuous parsing).

( NOTE: The File Name Pattern Setting, Scheduling Setting, and Notification Setting features of the ZENCollector are common for all types of Configuration Methods. )

• Collection Method:

1. Direction Method: In this method, the data logs are collected using the ZENfra server.
2. ZENCollector Method: In this method, the data logs are collected through ZENfra’s data collection agent “ZENCollector”.

• Collection Source: this field will be active only for the ZENCollector Method, not for the Direct Collection Method. this input value will be automatically derived if the user chooses the ZENCollector in the collection method field and sign-in to the ZENfra tool from a single device. For multiple devices, the user can choose from the drop-down options.
• Config Name: enter a configuration name of your choice.
• Host: Enter the Hostname or IP address in the designated field.
• Username & Password: Provide the user credentials (username and password) for the specified Host.
• Log Process: choose between 'Upload Only' (to upload data without parsing) or 'Upload and Process' (for both uploading and continuous parsing).

( NOTE: The File Name Pattern Setting, Scheduling Setting, and Notification Setting features of the ZENCollector are common for all types of Configuration Methods. )

• Clicking on the ‘Cloud Configuration Method’, you will be redirected to the Cloud Provider Selection Page.
• By clicking on the required Cloud Provider, you will be directed to the Repository Configuration page.
• There you will have some Repo Setting Fields to fill in to configure the data collection process. 

By clicking on the ‘AWS Cloud Configuration Method’, you will be redirected to the Repository Configuration page.

There you will have some Repo Setting Fields to fill in to configure the data collection process. The Repo Setting Fields are mentioned below:

• Collection Method:

1. Direction Method: In this method, the data logs are collected using the ZENfra server.
2. ZENCollector Method: In this method, the data logs are collected through ZENfra’s data collection agent “ZENCollector”.

• Collection Source: this field will be active only for the ZENCollector Method, not for the Direct Collection Method. this input value will be automatically derived if the user chooses the ZENCollector in the collection method field and sign-in to the ZENfra tool from a single device. For multiple devices, the user can choose from the drop-down options. 
• Config Name: Specify the configuration name.
• Access Key: Provide the access key.
• Secret Access Key: Enter the secret access key token.
• Data to be Collected: select which data to collect from the drop-down options.
• Log Process: choose between 'upload only' (to upload data without parsing) or 'upload and process' (for both uploading and continuous parsing).

( NOTE: The File Name Pattern Setting, Scheduling Setting, and Notification Setting features of the ZENCollector are common for all types of Configuration Methods. )

Before you start your Data Collection Repo Configuration for Azure, kindly Download Azure CLI and Install it in the system.

Use This Link to navigate to Download Page > Azure CLI Download 

Open the Windows PowerShell in Administrator Mode and run this command: 

" Get-Module -Name ImportExcel -ListAvailable "

If it doesn't find any module, you need to run below mentioned command to install the ImportExcel Module: 

" Install-Module -Name ImportExcel -Scope AllUsers " 

• Collection Method:

1. Direction Method: In this method, the data logs are collected using the ZENfra server.
2. ZENCollector Method: In this method, the data logs are collected through ZENfra’s data collection agent “ZENCollector”.

• Collection Source: this field will be active only for the ZENCollector Method, not for the Direct Collection Method. this input value will be automatically derived if the user chooses the ZENCollector in the collection method field and sign-in to the ZENfra tool from a single device. For multiple devices, the user can choose from the drop-down options.
• Config Name: enter a configuration name of your choice.
• Subscription ID: provide the Subscription ID associated with the AZURE subscription plan.
• App ID: enter the App ID associated with the AZURE application or service.
• Secret ID: input the Secret ID corresponding to the provided App ID of the AZURE.
• Tenant ID: enter the Tenant ID associated with the AZURE account or service.
• Data to be Collected: Choose the specific data types to be collected from the available options in the drop-down menu. (All, AZURE Instances Data, Cost Utilization)
• Log Process: choose between 'Upload Only' (to upload data without parsing) or 'Upload and Process' (for both uploading and continuous parsing).

( NOTE: The File Name Pattern Setting, Scheduling Setting, and Notification Setting features of the ZENCollector are common for all types of Configuration Methods. )

• Collection Method:

1. Direction Method: In this method, the data logs are collected using the ZENfra server.
2. ZENCollector Method: In this method, the data logs are collected through ZENfra’s data collection agent “ZENCollector”.

• Collection Source: this field will be active only for the ZENCollector Method, not for the Direct Collection Method. this input value will be automatically derived if the user chooses the ZENCollector in the collection method field and sign-in to the ZENfra tool from a single device. For multiple devices, the user can choose from the drop-down options.
• Config Name: enter a configuration name of your choice.
• Project ID: Enter the Project ID associated with your account or project.
• Credentials Key: Provide the Credentials Key required for authentication that will be in the JSON extension file.
• Data to be Collected: Choose the specific data types to be collected from the available options in the drop-down menu. (All, GCP Instances Data, Cost Utilization, and Metrics)
• Dataset ID: Specify the Dataset ID corresponding to the selected data source.
• Table ID: Enter the Table ID associated with the chosen data set for collection.
• Log Process: choose between 'Upload Only' (to upload data without parsing) or 'Upload and Process' (for both uploading and continuous parsing).

( NOTE: The File Name Pattern Setting, Scheduling Setting, and Notification Setting features of the ZENCollector are common for all types of Configuration Methods. )

• Collection Method:

1. Direction Method: In this method, the data logs are collected using the ZENfra server.
2. ZENCollector Method: In this method, the data logs are collected through ZENfra’s data collection agent “ZENCollector”.

• Collection Source: this field will be active only for the ZENCollector Method, not for the Direct Collection Method. this input value will be automatically derived if the user chooses the ZENCollector in the collection method field and sign-in to the ZENfra tool from a single device. For multiple devices, the user can choose from the drop-down options.
• Config Name: enter a configuration name of your choice.
• Host: Enter the Hostname or IP address in the designated field.
• Username & Password: Provide the user credentials (username and password) for the specified Host.
• Port: provide your Port ID.
• Key File: provide the Key File required for authentication that will be in the ppk extension.
• Remote Servers: provide the remote servers in this field.
• Log Process: choose between 'Upload Only' (to upload data without parsing) or 'Upload and Process' (for both uploading and continuous parsing).

( NOTE: The File Name Pattern Setting, Scheduling Setting, and Notification Setting features of the ZENCollector are common for all types of Configuration Methods. )

Once you click on the "Save" button, a pop-up will appear, prompting you to perform a connection test. While it is not mandatory, it is highly recommended to ensure that the repository configuration process is completed without any errors.

By selecting the "Yes" option, the system will initiate the test connection. If the test run is successful without any errors, you will receive a notification confirming the successful connection.

However, if you encounter any errors, please review your repository configuration and make any necessary corrections to the configuration process.

• Access the opening page of the Data Collection menu to view all created Configuration Repos.
• The data collection process will begin automatically according to the scheduled date and time.
• There is also the availability of instant collection of logs from the configured Repos. Follow the below-given steps for instant collection of logs.

• Click on the left-side Selection Button for the specific configuration(s) you need to collect data logs instantly.
• Click the 'Collect' button to perform an instant collection of logs for the selected configuration(s).

• Click on the Edit icon located under the Action field for the repository you wish to modify.

• You will be directed to the Editing Page for that specific repository. Make the necessary changes if required.
• Once the changes are made, the Update and Save Button, positioned in the top right corner of the page, will become active. Click on it to save your edits.
• If you want to delete the repository, locate the Delete Button at the top right corner of the page.
• Click on the delete button, and you will be asked to confirm the deletion. Select "Yes" to confirm the deletion of the repository.

• Upon successful deletion, you will receive a Notification confirming the successful removal of the repository.