Managing Worker Node Details

The Worker details screen is a direct administration resource into the node's current status, progress, scan profile configuration, and all job troubleshooting information. Review each area of this article to learn more about the screen's tabs and what features are available for worker node deployment and supervision.

Worker Node Statuses

One of following statuses will be listed for each deployed worker node:

Status

Description

Not Started

A new worker node has been created AND the installation has not been initiated.

Active

A new worker node has been created AND the installation has been initiated.

Healthy

The worker node has been installed AND the scan-job-manager is healthy AND the NATS service is running.

Down

The worker node has been installed AND the scan-job-manager is not healthy OR the NATS service is down.

To sort and filter worker nodes

  1. On the Data Discovery menu, select Setup > Worker nodes. The Worker nodes screen appears.
    Note:

    This list screen contains all of the worker nodes that exist in your current organization level or any nested suborganizations under the current level. For more information on how to manage user access for organizations, see Managing Organizations.

  2. Click any column header to sort worker nodes based on alphabetical or ascending or descending order.


  3. Click the Add Filter button to show worker nodes based on specified criteria.


    Available Filters:

    • Platform Provider

    • Created By

    • Credential Store

    • Status

    • Version

  4. Click the Column Selector icon. The Column Selector modal appears.

  5. Click a field name, then use the directional arrows to move fields across the Available Fields and Visible Fields groups.


  6. Click the Apply button. Your changes should appear in the Worker nodes list screen.

To delete worker nodes

Attention:

Deleting the worker node is an irreversible action. If there are active scan(s) or data source(s) still associated with this worker node, it cannot be deleted.

To force delete a worker node, please contact OneTrust Support to request this feature.

  1. On the Data Discovery menu, select Setup > Worker nodes. The Worker nodes screen appears.

  2. Hover over the row of a given worker node to reveal the Context Menu icon.
  3. Click the icon, then select Delete. The Delete Worker Node modal appears.

  4. Click the Delete button.

Summary Tab

This tab contains the worker node's general information, including the chosen platform provider, credential vault store option, and worker ID to copy for deployment. It will also inform users of what version the worker node is currently running.



  1. On the Data Discovery menu, select Setup > Worker nodes. The Worker nodes screen appears.

  2. Select a worker node. The Worker details screen appears with the Summary tab open by default.

  3. Edit the Node Name, Description, and other fields fields as necessary.

    Note:

    Requires access control permissions to edit worker nodes.

  4. You can change the managing organization selected during creation to another suborganization level. Only users with access to the level will be able to view the worker node.



  5. See the Status of the worker node's health and its Last Updated Date.



    Status

    Description

    Not Started

    A new worker node has been created AND the installation has not been initiated.

    Active

    A new worker node has been created AND the installation has been initiated.

    Healthy

    The worker node has been installed AND the scan-job-manager is healthy AND the NATS service is running.

    Down

    The worker node has been installed AND the scan-job-manager is not healthy OR the NATS service is down.

  6. See the Disk Usage section to observe the worker node's current disk use and available space.

    Note:

    Disk Usage is available for the following deployment types:

    • AWS Guided Installation with gp2 storage

    • Azure Guided Installation with managed-premium storage

    • GCP Standard Guided Installation with standard storage

    • Onebox



  7. See the Job Status widget to review the total number of jobs set up for this worker node by status.



Jobs Tab

This tab contains a running list of all scan jobs that are active, pending completion, or ended.

  1. On the Data Discovery menu, select Setup > Worker nodes. The Worker nodes screen appears.

  2. Select a worker node. The Worker details screen appears.

  3. Navigate to the Jobs tab.

  4. The full list of jobs will populate with the following fields to assist during review.



    • Job ID

    • Job Progress

    • Created Date

    • Last Updated Date

    • Status

      Status Label

      Description

      Aborted

      The job has been ended.

      Completed

      The job is complete and ready for review.

      Pending

      The job is pending results.

      Processing

      The job progress is actively processing.

  5. Click the Filter icon to filter your worker node logs to retrieve logs based on Status or Created Date.

  6. For specific information on Job Insights, see Reviewing Job Insights.

Services Tab

This tab contains a running list of active pod services being utilized by the worker node.

  1. On the Data Discovery menu, select Setup > Worker nodes. The Worker nodes screen appears.

  2. Select a worker node. The Worker details screen appears.

  3. Navigate to the Services tab.

  4. Use the Search bar to locate specifically named services. Use the Refresh icon to reload the services list.



    Status

    Description

    Running

    The service is currently running as expected.

    Failed

    The service has failed and is facing issues.

    Pending

    The service is currently initializing and is preparing to run.

    Succeeded

    The service has completed.

  5. To access pod descriptions, click the Context Menu for a service and select Describe Pod. The Describe Pod Details modal appears.

  6. Use the pod details to review and troubleshoot pods directly in the application even if the on-premises agent is down.



On-Demand Worker Node Logs

You can retrieve worker node logs on demand to gain insight into currently running pod services without requiring access to infrastructure. This troubleshooting enhancement provides instant review access to how the worker node is operating and to debug any present issues in the deployment.

  1. Hover over a Service row to reveal and click the Context Menu icon.

  2. Click View Live Logs. The Logs modal appears.

  3. Every captured log will appear in this modal with the Event Date timestamp and aMessage key. Click the Service field to navigate between the available services.



  4. Click the Filter icon to search for logs containing specific text and listed during a target window.

    Available Filters:

    Filter

    Description

    Search Text

    Enter specific text to locate in the logs.

    Note:

    Search text is case sensitive. To search for multiple keywords, separate entries with a vertical bar.

    Log Type

    Select between ERROR, INFO, or WARN.

    Relative Date

    Select between 6 hours ago, 24 hours ago, or 3 days ago.

    From Event Date

    Enter the initial event date to start your search.

    To Event Date

    Enter the from event date to end your search.



  5. Click the Apply button to search for your desired log details.

  6. Click the Download button in the modal to obtain a .txt file of the log, in the format: datadiscovery-onprem-agent-<job-string-id>-M_D_YYYY, HH_MM_SS AM/PM.text. Any filters you've applied will be included in the log download.

    You can also click the Context Menu for the worker node row in the Services tab and then select Download Logs.



Index Tab

This tab is a comprehensive view of the total count of classifiers and estimated total of personal data elements that may reside within your data sources.

Note:

This area of the worker details can be used along side the Identity Search function to detect which data sources may contain sensitive PII. For more information, see Performing Identity Graph Searches for Data Discovery.

  1. On the Data Discovery menu, select Setup > Worker nodes. The Worker nodes screen appears.

  2. Select a worker node. The Worker details screen appears.

  3. Navigate to the Index tab. Each of your indexed data sources will be displayed with the following details:



    Field
    Description
    Data Source

    Click the Data Source name to navigate to the Index tab in Data Source Details screen. This will display each classifier and the estimated number of unique values indexed per classifier.

    Number of Classifiers

    The number of detected classifiers, including system and custom.

    Number of Personal Data Elements

    The number of unique values indexed per data source.

    Note:

    Because this count only identifies unique values and discounts duplicates, it may differ than the count presented in the Term instances column during term review, which does include duplicates.

    Last Indexed Date

    Date and time of the last time the data source was indexed.

  4. Click the Refresh icon to reindex the data sources and pull the latest details.

  5. To delete an index, over a data source row to reveal the Context Menu icon.

  6. Click the icon, then select Delete Index. The Delete Index modal appears.

  7. Click the Confirm button. The index will be cleared.

    CAUTION:

    Deleting the index will clear all the estimated values that are detected. This action cannot be undone, but this values can be found again if the data source is rescanned.



Activity Tab

You can view the audit history of a worker node to quickly view the edits and updates made by users in your organization.

  1. On the Data Discovery menu, select Setup > Worker nodes. The Worker nodes screen appears.

  2. Select a worker node from this list screen. The Worker details screen appears.

  3. Navigate to the Activity tab.

  4. The audit history will include the user responsible, the value change for the given field, and a timestamp of when the action occurred.



  5. You can use the log's actions to expand and collapse the view, plus change the ascending or descending view of the timeline.

Data Sources Tab

You can use the Data Sources tab to view a list of the data sources associated with a worker node.

  1. On the Data Discovery menu, select Setup > Worker nodes. The Worker nodes screen appears.

  2. Select a worker node from this list screen. The Worker details screen appears.

  3. Navigate to the Data Sources tab.

  4. The Data Source list will include the data source name, system, managing organization, and status.

Administration Tab

The Script Management feature in the Administration tab empowers users to run common maintenance and troubleshooting scripts directly from the application. This reduces the need for command line interface (CLI) access or coordination with support by providing an effective and easy way to execute critical scripts.

For a full breakdown of this functionality, see Script Management for Worker Nodes.

Note:

Script Management is only available for worker nodes starting from version 202504.1.0.



Configurations Tab

You can edit existing worker node configurations created through guided installation only. This configuration option allows users to revisit the worker node settings and modify for additional considerations or administrative preferences.

  1. On the Data Discovery menu, select Setup > Worker nodes. The Worker nodes screen appears.

  2. Select a worker node from this list screen. The Worker details screen appears.

  3. Navigate to the Configurations tab.

  4. Modify the node's configurations, as necessary, then click the Save button.



    Note:

    Certain storage classes do not support resizing volumes as the Storage section options may not be enabled for editing.

  5. You can now relaunch the worker node, run the curl command, and see your changes take effect.

  6. Optional: given that you have enabled the Auto-Update feature in Global Settings, any saved edits to existing worker node configurations will be automatically launched to the deployed node. You can also one-click update from this screen as well.

    For more information, see Updating Worker Nodes.