Skip to content

Collectors

Collectors are reusable scripts that produce structured values for an endpoint.

On the endpoint side, Ordyn shows you which collectors apply to the machine, how they are being triggered, and what values they last returned.

How collectors reach an endpoint

Collectors are targeted through jobs:

  • add a Run collector task to a job
  • assign that job to the endpoint scope you want
  • or schedule that job as a normal time automation

Collector event automation also runs through jobs, so job assignments and schedules are the place to control collector delivery.

What the endpoint page shows

The endpoint Collectors tab lists each collector that currently applies to the machine.

For each collector, you can see:

  • the collector name
  • the script behind it
  • the execution context
  • whether it reaches the endpoint through a job, an automation, or both
  • the latest run status
  • the latest collected values

The Applied via column is especially useful when you are trying to understand why a collector exists on a machine. It shows the job or automation name and the scope it came from.

Latest values

Use View latest values when you want to inspect the most recent collector output.

Ordyn shows the latest collection time, the latest run status, and every returned field value.

Endpoint overview

Some collector fields are also shown on the endpoint overview when the collector definition marks them as overview-visible.

Those overview values are meant for quick scanning:

  • values can be copied when the collector field allows copying
  • values can open a configured URL or app link when the collector definition provides one

Collector definitions

The endpoint page shows the result of collector definitions, not the editor where those definitions are authored.

Collector definitions themselves live in the global collectors area and define:

  • the script that runs
  • the execution platform
  • the execution target and context
  • the output fields that become visible on endpoints

Endpoint-targeted collectors execute on the endpoint agent. Runner-targeted collectors execute on an eligible Runner while keeping the endpoint as the collector target.

A Runner collector uses the endpoint's effective Runner pool assignment. It can target agent endpoints, generic network endpoints, SNMP-managed switches and printers, and Telematik card terminals.

Runner collectors can bind values for the selected saved script's parameters. String values support runtime templates and are resolved for each target endpoint, so values such as {{ endpoint.hostname }}, {{ endpoint.fqdn }}, and {{ endpoint.primary_ip_address }} can be passed to device-specific APIs. Secret parameters bind to secret variable definitions; their values are resolved only for execution and redacted from captured output. A required parameter must have a collector binding or a default in the script.

Windows Runner collectors use a Runner-targeted PowerShell script, and Linux Runner collectors use a Runner-targeted Bash or POSIX shell script. The platform selects the Runner operating system; it does not need to match the endpoint's operating system or kind. See Runners for assignment precedence, target affinity, endpoint context, and capacity behavior.

Run status

Collector runs on an endpoint are tracked with a small lifecycle:

  • queued
  • issued
  • succeeded
  • failed

The endpoint page shows the latest run state for each collector so you can tell whether the collector has run recently and whether it returned values successfully.