Actor picture

Monitoring Runner

apify/monitoring-runner

The monitoring runner is a part of the Apify Monitoring Suite (apify/monitoring). See its readme for more information and how to use this.

No credit card required

Author's avatarApify
  • Modified
  • Users91
  • Runs1,078,991

Monitoring suite name

projectName

Optional

string

Name of your monitoring suite. It will be used in notifications and to identify related resources in the Apify dashboard.

Type of target

targetType

Required

string

Only one type of target can be monitored by a single monitoring suite. If you want to watch more types, create more monitoring suites.

Options:

"ACTOR", "TASK", "NAMED_DATASET"

Target name patterns

targetPatternList

Optional

array

Regular expressions that will be matched against selected actors / tasks or datasets under your Apify account. All matching targets will then be monitored by this monitoring suite. This is typically also the fastest way to select a single target. Just type its full name. Datasets are going to be automatically group by these patterns when dashboard statistics is counted for dataset target type.

Target IDs

targetList

Optional

array

If for whatever reason the Target name pattern option does not suit you, targets can also be specified by providing their IDs, as found in your Apify dashboard.

Max items to be checked

limit

Optional

integer

Last items to be checked. If 100 is passed, only last hundred runs/datasets will be checked.

Save history

saveHistory

Optional

boolean

All monitoring runs results are saved in named dataset

Resource stats collector

resourceStatsCollector

Optional

boolean

Works with Subject type 'Actor', 'Task' and 'Named dateaset', Gets information about the runs TODO: LINK TO PA

Duplication checker

duplicationChecker

Optional

boolean

Checks for duplicates based on defined unique fields. Based on 'https://apify.com/lukaskrivka/duplications-checker'

Schema validator checker

schemaValidatorChecker

Optional

boolean

Validates dataset items based on the Type check library

Run status validator

runStatusChecker

Optional

boolean

Validates run status

Checkers

checkers

Optional

array

Ids of checker actors or tasks that needs

Checkers input

checkersInput

Optional

object

Pass input to checkers

Dashboard

dashboard

Optional

boolean

Works with Subject type 'Actor', 'Task' 'Named dataset'. Starts dashboard actor. LINK TO PA

Email

emailReporter

Optional

boolean

Sends report to mail inbox. LINK TO PA for input

Slack

slackReporter

Optional

boolean

Sends report to custom slack channel. LINK TO PA for input

Reporters

reporters

Optional

array

Id of reporter actors or tasks

Checkers input

reportersInput

Optional

object

Pass input to checkers

The frequency of task

frequency

Optional

string

If passed the resources will be filtered by the frequency of the task. For example if you pass MONTHLY only resources modified last month will be collected.