Skip to content

README_en.md

Latest commit

 

History

History
113 lines (94 loc) · 5.98 KB

README_en.md

File metadata and controls

113 lines (94 loc) · 5.98 KB

Monitor: Data File Monitoring & Logger

Introduction

This tool adopts a model that separates the program (Monitor) from the data (Data). It was initially designed to bypass GitHub Action's pricing strategy while also meeting the confidentiality requirements for monitoring content and data storage.

Monitor

Monitor is public, so Action executions are not billed.

Several parameters need to be configured in Monitor's Action Secrets to obtain read and write permissions for the data repository. For details, please refer to the Actions Parameter Description.

Data Repository

The data repository must be created separately. When using it, you need to configure your own data repository. It is recommended to name it monitor-data, which can be set to either private or public.

Simply create a monitoring configuration file config.json in the root directory. For the format, please refer to ./config.json and the Full Parameter Description. Data files will be saved in the /data directory.

Timing Explanation

GitHub Action's schedule can be used:

schedule:
    - cron: '*/1 * * * *'

However, its polling interval is not guaranteed. Sometimes it may even trigger only once an hour. Therefore, if high timing accuracy is required, avoid using the schedule. Instead, use other timers to trigger the Action via the workflow_dispatch method.

For example, Linux's cron:

*/1 * * * * root curl 'https://api.github.com/repos/[YOUR_ORG]/[YOUR_REPO]/actions/workflows/detect.yml/dispatches' -H 'authorization: Bearer [GITHUB_PAT]' -d '{"ref":"master"}'

Configuration Examples

Periodically poll data files. Save a copy only when the file content changes.

{
	"id": "simple_get",
	"url": "https://dummyjson.com/test"
}

Send a notification when the file content meets specific conditions (supports Synology Chat and pushplus).

{
	"id": "livescore",
	"url": "https://match.uefa.com/v5/livescore?matchId=2036177",
	"format": true,
	"filters": [
		"hash",
		"minute"
	],
	"condition": "length",
	"notify": true,
	"notifyType": "synology,pushplus",
	"notifyCondition": "length > 0"
}

Complete Parameter Description

Configuration Instruction Default Required
id Unique identifier for the task Yes
url URL of the data file to poll Yes
options Fetch options No
every Execution interval in minutes (default: every execution) 1 No
random Whether to add random delay (in seconds) to execution time False No
randomMin Whether to execute at random minutes (requires perDay) No
perDay Total number of random executions per day (requires randomMin) No
enable Whether to enable the task True No
record Whether to save the data True No
filters Properties to ignore during file comparison No
condition Additional conditions for file comparison No
format Whether to format the saved data False No
notify Whether to enable notifications False No
notifyType Notification type, supports synology, pushplus, multiple types separated by commas synology No
notifyCondition Additional conditions for notifications No
errorCondition Error conditions that trigger logging and notifications No

Actions Parameter Description

Repository Secrets Instruction Required
DATA_REPO Data repository Yes
DATA_REPO_PAT PAT to access the data repository Yes
NOTIFY_SERVER Synology Chat server address No
NOTIFY_TOKEN Synology Chat webhook token No
PUSHPLUS_NOTIFY_TOKEN pushplus push token No
PUSHPLUS_NOTIFY_SERVER pushplus server address (optional, defaults to official address) No

Notification Configuration

Configuration Method

Notification types are configured in config.json through the notifyType field, supporting the following values:

  • synology - Use Synology Chat notifications
  • pushplus - Use pushplus push notifications
  • synology,pushplus - Use both notification methods simultaneously

Synology Chat Notifications

  • Set notifyType: "synology" in config.json (or leave empty, defaults to synology)
  • Set environment variable NOTIFY_SERVER to your Synology Chat server address
  • Set environment variable NOTIFY_TOKEN to your Synology Chat webhook token

pushplus Push Notifications

  • Set notifyType: "pushplus" in config.json
  • Set environment variable PUSHPLUS_NOTIFY_TOKEN to your pushplus token
  • Optionally set environment variable PUSHPLUS_NOTIFY_SERVER to customize server address

Multiple Notification Types

  • Set notifyType: "synology,pushplus" in config.json
  • Configure environment variables for both notification methods as described above

How to Get pushplus Token

  1. Visit pushplus.plus to register an account
  2. After logging in, get your token from "Personal Center"
  3. Set the token as the PUSHPLUS_NOTIFY_TOKEN environment variable