Document toolboxDocument toolbox

Running collectors

Introduction

This is the default view when entering the Cloud Collector application.

10_Running a collector.png

Here you will see a list of the jobs currently running in your domain, categorized by collector name, collector type, container type, and its current status.

20_Running a collector.png

Working with running collectors

Statuses

 

Running

 

 

A job is running when it is actively sending data.

To learn how to pause a job, go to pause a running job.

 

Paused

 

 

This is the status that shows when you have paused a job. To resume a job, go to resume a paused job.

 

Scaled

 

 

This icon will show the scaling values added to this job.

Edit a collector

To edit a collector from the list, simply click its name to open the details.

As well as the details on the left, the Edit window shows various tabs, where you can view and modify the version, raw JSON Parameters, Environmental Variables and State. You will also find tabs specific to Scheduled and Continuous Collectors.

Scheduled collectors

To schedule the instances, you can set them to execute every X minutes in the Scheduled tab of the properties.

Collector runs

In the Collector runs tab of the properties, you can review all the running collector runs in your domain. A collector run is

including:

  • Collector ID and associated Image

  • Status, that is, whether the collector run has succeeded or failed

  • the Creation date

Continuous collectors

To continuously execute the job instances, you can scale the job using Target pods tab in the Properties. The first number shows the number of collectors that are running and cannot be modified. The second number is a counter field to set the number of instances the job has. Adding replicas will add more instances of the collector.

Collector pods

In the Collector pods tab of the properties, you can review all the running collector pods in your domain. A collector pod is the minimum unit needed to execute a collector. We can assign various pods to run at the same time in a collector.

Including:

  • Name and associated Image

  • Status, that is, whether the collector pod has succeeded or failed

  • the number of Restarts

  • the Creation date

and find the query information using the eye icon.

Further actions

Refresh collectors

Collectors are constantly being added and modified in the domain, so to keep up to date with the current collectors and their statuses, use the refresh button at the top of the screen.

Pause a collector

To pause a job from the list, click the ellipse icon in its row and select Pause.

Pausing a scheduled collector

Pausing a continuous collector

Pausing a scheduled collector

Pausing a continuous collector

You will be asked to confirm this action:

 

If your job uses scaling, pausing it will remove the current settings.

See the number of scales in the Target pods field.

Resume a collector

To resume a job from the list, click the ellipse icon in its row and select Resume.

Resuming a scheduled collector

Resuming a continuous collector

Resuming a scheduled collector

Resuming a continuous collector

When resuming a scheduled job, you will be asked to confirm this action:

 

When resuming a continuous job, you will be asked to enter the number of scales:

Delete a collector

To delete a job from the list, click the ellipse icon in its row and select Delete.

You will be asked to confirm this action:

Once deleted, you will not see this collector in the list.

Changing the layout

To change the default layout, select the ellipse menu > Display density and select the desired option:

  • Default: The default view will show all the possible actions in the window.

  • Comfortable: This view will space out the elements to make for a less compact viewing experience.

  • Compact: This view will reduce spacing to enable you to view more elements in one window.