Skip to main content

​
Overview

The Collectors page provides a central location to manage, monitor, and troubleshoot collectors in your system. Use this interface to track collector status, versions, and associated pipelines.

​
Collectors

The table on the Collectors page displays the following columns:
  1. Name
    The name of the collector.
  2. Status
    The current status of the collector:
    • Awaiting Deployment – The collector was created in the UI but has not been deployed yet (installation not completed).
    • Installed (Idle) – The collector is installed without any deployed pipelines.
    • Running (Active) – The collector is actively running with at least one deployed pipeline.
    • Degraded – Collector pods are running, but one or more pods are not working properly.
    • Error – The collector has encountered an issue; pipelines are not running.
    • Disconnected – The remote operator cannot communicate with the collector.
  3. Version
    Shows the version of the collector. If the version is unavailable, displays N/A.
  4. Pipelines
    Lists pipelines associated with a collector. If no pipelines are associated, displays N/A.
  5. Last Deployed
    Displays the date the collector was most recently deployed in MM/DD/YYYY format. If unavailable, displays N/A.
  6. Delete Collector
    The trashcan image button can be used to delete a collector.
A collector with no pipelines deployed to it will display a status of Installed (Idle) and will not display any version number.

​
Manage an Existing Collector

  1. Log in to the Sawmills dashboard.
  2. Navigate to Collector Management.
  3. Click a collector name to open its management page.
The collector page consists of three main areas:
  1. Pipelines
  2. Installation
  3. Rotate API Key

​
Pipelines

The Pipelines section lists pipelines attached to this collector:
  1. Name
    The name of the pipeline with a link to the pipeline’s management page.
  2. Last Deployed
    Displays the date the pipeline was deployed to this collector.
  3. Detach Button to detach the pipeline from this collector. This button is only enabled if the collector is running and responsive.

​
Installation

The Installation section provides a Helm command to install or upgrade this collector to the latest version. For example, if you have a collector named my-collector, the UI shows a command like: 
helm upgrade --install sawmills-remote-operator \
oci://public.ecr.aws/s7a5m1b4/sawmills-remote-operator-chart \
--version 0.173.0 \
--namespace sawmills \
--set apiKeyExistingSecret=sawmills-secret \
--set operatorAddress=https://controller.ue1.prod.plat.sm-svc.com \
--set collectorName="my-collector"

​
Rotate API Key

To rotate the API key used by this collector:
  1. Click Generate New Key.
  2. Update the API key secret using the kubectl patch command shown in the UI:
kubectl patch secret sawmills-secret \
-n sawmills -p='{"stringData":{"api-key": "****************"}}'
Note: Even though the API key is masked it will still be copied to your clipboard properly.