Skip to content

Commit

Permalink
up
Browse files Browse the repository at this point in the history
  • Loading branch information
@easychen
easychen committed May 23, 2022
1 parent ff93522 commit 0921867
Show file tree
Hide file tree
Showing 10 changed files with 95 additions and 11 deletions.
48 changes: 45 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Check酱是方糖气球出品的网页内容监测工具，它包含一个Edge/C

![](image/20220521134213.png)

Check酱插件通过后台打开网页的方式进行监测，**完全模拟用户的真实行为**，可以监控需要登录的各种后台网页，并自动延续登录状态。
Check酱的原理是，通过浏览器插件后台打开网页进行监测，从而**完全模拟用户的真实行为**，可以监控绝大部分复杂的动态网页，需要登录的各种后台页面，并（在绝大多数情况下）自动延续登录态。

除了支持网页内容（Dom）的监测，还支持HTTP状态（通过GET监测）、JSON和RSS方式。

Expand Down Expand Up @@ -136,7 +136,31 @@ checkchan://title=Server%E9%85%B1%E5%AE%98%E6%96%B9%E7%BD%91%E7%AB%99%E7%8A%B6%E

复制以上字符后，在Check酱浏览器插件界面通过Ctrl+V粘贴，会自动识别并跳转到「添加监测点」界面。

![](image/20220522113944.png)
![](image/20220522113944.png)

### 监测周期限制

有些任务只需要在特定的时间段执行，为了节省资源，我们添加了「监测周期限制」功能。比如某动画每周五上午十点更新，那么我们可以将「监测周期限制」设置如下：

![](image/20220523213852.png)

这样其他时间段就不再启动监测。对于无法预知事件段的任务，使用默认的「每分钟」即可。

注意在「监测周期限制」之上，还有「监控间隔时间」。

![](image/20220523214048.png)

如果 「监测周期限制」 为每分钟，而「监控间隔时间」为60分钟，那么每分钟都会尝试监测，而一旦监测成功一次，那么下次监测将是60分钟后。

同时，因为执行监测任务本身也耗费时间，所以「监控间隔时间」为1分钟时，往往每隔一分钟（即每两分钟）才会运行一次任务。

### 日志查看和错误定位

为了更清楚的了解定时任务的执行情况，你可以打开「开发者工具」（F12）在 `Console` 标签页中可以看到任务产生的日志。

![](image/20220523211235.png)

错误信息也会在这里以红色高亮的行显示，遇到Bug时提供日志错误截图可以帮助我们更快的定位到问题。


## 自架云端的安装和使用
Expand Down Expand Up @@ -195,7 +219,7 @@ docker run -e API_KEY=* -e TZ=Asia/Chongqing -p 8088:80 -v $PWD:/data -d ccr.ccs

![](image/20220521144137.png)

点击插件右上方菜单中的`自架服务`。
点击插件右上方菜单中的`云端服务`。

在`服务器地址`一栏输入 `http://$BBB:8088`(将$BBB替换为IP B，这里的URL不用加key参数)；在`API_KEY`一栏输入密码C。

Expand All @@ -210,3 +234,21 @@ docker run -e API_KEY=* -e TZ=Asia/Chongqing -p 8088:80 -v $PWD:/data -d ccr.ccs
点击右上角 「云+箭头」的按钮，可以主动同步任务到云端。

![](image/20220521145106.png)

Check酱也会每十分钟自动同步一次。

### 云端错误排查

由于服务器内存通常没大家电脑大，所以很多在本地执行OK的任务同步到云端后会因为「延迟读取」秒数太小中途停止而失败。如果遇到类似情况，请尝试增加「延迟读取」。

![](image/20220523212625.png)

如果这样也不行，往往是因为云端无头浏览器显示网页和本地存在差异导致，我们为这种情况生成了最近一次失败的任务的截图，可以在「云端服务」菜单下看到。

![](image/20220523213104.png)

点击「失败截图」按钮即可看到。注意：需要只用最新的镜像，并传递`ERROR_IMAGE=NORMAL` 环境变量。如果希望截取完整网页的图片，可以传递`ERROR_IMAGE=FULL`。

如果任务失败又没有截图，说明该任务不是因为CSS选择器未命中而失败，尝试增加「延迟读取」可能解决。

这个页面也能看到云端任务日志，这里的日志不包含手动点击「监测」按钮触发的任务。如果没有可以执行的任务（任务是定时触发的），那么日志亦可能为空。
Binary file renamed ckc.20220523205830.zip → ckc.20220523214401.zip
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion ext.html
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<div class='ext-info'><center>插件最后更新于2022-05-23 20:59:00 Build 20220523205830</center></div>
<div class='ext-info'><center>插件最后更新于2022-05-23 21:44:40 Build 20220523214401</center></div>
Binary file added image/20220523211235.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added image/20220523212625.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added image/20220523213104.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added image/20220523213852.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added image/20220523214048.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 26 additions & 5 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@
<title>Check酱官网</title>
</head>
<body>
<div class='ext-info'><center>插件最后更新于2022-05-23 20:59:00 Build 20220523205830</center></div><h1>Check酱</h1>
<div class='ext-info'><center>插件最后更新于2022-05-23 21:44:40 Build 20220523214401</center></div><h1>Check酱</h1>
<p><strong>监测网页内容变化，并发送异动到微信</strong></p>
<blockquote>
<p><g-emoji class="g-emoji" alias="warning" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/26a0.png">⚠️</g-emoji> 此仓库用于文档、插件和镜像下载、以及issue跟踪</p>
</blockquote>
<h2>TLDR版</h2>
<ul>
<li>Chrome/Edge浏览器插件：<a href="ckc.20220523205830.zip">下载</a></li>
<li>Chrome/Edge浏览器插件：<a href="ckc.20220523214401.zip">下载</a></li>
<li>自架版云端 Docker 命令（<code class="notranslate">API Key</code>为<code class="notranslate">YouRAPiK1</code>）:</li>
</ul>
<div class="highlight highlight-source-shell"><pre>docker run -e API_KEY=YouRAPiK1 -e TZ=Asia/Chongqing -e ERROR_IMAGE=NORMAL -p 8088:80 -v <span class="pl-smi">$PWD</span>:/data -d ccr.ccs.tencentyun.com/ftqq/checkchan:latest</pre></div>
Expand All @@ -29,7 +29,7 @@ <h2>什么是「Check酱」</h2>
<p>Check酱是方糖气球出品的网页内容监测工具，它包含一个Edge/Chrome<strong>浏览器插件</strong>和可以自行架设的<strong>云端</strong>。</p>
<p>基于浏览器插件，它通过<strong>可视化选择器</strong>理论上可以监控网页上的任意内容（文本）、除了浏览器通知，还可以配合<a href="https://sct.ftqq.com" rel="nofollow">Server酱</a>将异动推送到微信或手机。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220521134213.png"><img src="image/20220521134213.png" alt="" style="max-width: 100%;"></a></p>
<p>Check酱插件通过后台打开网页的方式进行监测，<strong>完全模拟用户的真实行为</strong>，可以监控需要登录的各种后台网页，并自动延续登录状态。</p>
<p>Check酱的原理是，通过浏览器插件后台打开网页进行监测，从而<strong>完全模拟用户的真实行为</strong>，可以监控绝大部分复杂的动态网页，需要登录的各种后台页面，并（在绝大多数情况下）自动延续登录态。</p>
<p>除了支持网页内容（Dom）的监测，还支持HTTP状态（通过GET监测）、JSON和RSS方式。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220521134438.png"><img src="image/20220521134438.png" alt="" style="max-width: 100%;"></a></p>
<p>配合可以自行架设的<strong>云端</strong>，可以将监测任务同步到服务器，这样当浏览器和电脑关掉以后，监测任务依然可以定时运行。</p>
Expand All @@ -40,7 +40,7 @@ <h3>安装</h3>
<blockquote>
<p>目前Check酱正在内测，尚未上架Edge商店，只能通过手工方式载入</p>
</blockquote>
<p>下载<a href="ckc.20220523205830.zip">插件ZIP包</a>，解压为目录（后文称其为A）。</p>
<p>下载<a href="ckc.20220523214401.zip">插件ZIP包</a>，解压为目录（后文称其为A）。</p>
<p>打开Edge的插件页面，打开「开发者模式」，点击「Load Unpacked」，选择上边解压得到的目录A。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220521140506.png"><img src="image/20220521140506.png" alt="" style="max-width: 100%;"></a></p>
<p>成功载入的话，就可以看到Check酱界面了。如果失败，通常是因为解压时多了一层目录导致的，可以试试重新选择A目录的下一级目录</p>
Expand Down Expand Up @@ -86,6 +86,18 @@ <h3>分享和导入监控点</h3>
</code></pre>
<p>复制以上字符后，在Check酱浏览器插件界面通过Ctrl+V粘贴，会自动识别并跳转到「添加监测点」界面。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220522113944.png"><img src="image/20220522113944.png" alt="" style="max-width: 100%;"></a></p>
<h3>监测周期限制</h3>
<p>有些任务只需要在特定的时间段执行，为了节省资源，我们添加了「监测周期限制」功能。比如某动画每周五上午十点更新，那么我们可以将「监测周期限制」设置如下：</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220523213852.png"><img src="image/20220523213852.png" alt="" style="max-width: 100%;"></a></p>
<p>这样其他时间段就不再启动监测。对于无法预知事件段的任务，使用默认的「每分钟」即可。</p>
<p>注意在「监测周期限制」之上，还有「监控间隔时间」。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220523214048.png"><img src="image/20220523214048.png" alt="" style="max-width: 100%;"></a></p>
<p>如果 「监测周期限制」 为每分钟，而「监控间隔时间」为60分钟，那么每分钟都会尝试监测，而一旦监测成功一次，那么下次监测将是60分钟后。</p>
<p>同时，因为执行监测任务本身也耗费时间，所以「监控间隔时间」为1分钟时，往往每隔一分钟（即每两分钟）才会运行一次任务。</p>
<h3>日志查看和错误定位</h3>
<p>为了更清楚的了解定时任务的执行情况，你可以打开「开发者工具」（F12）在 <code class="notranslate">Console</code> 标签页中可以看到任务产生的日志。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220523211235.png"><img src="image/20220523211235.png" alt="" style="max-width: 100%;"></a></p>
<p>错误信息也会在这里以红色高亮的行显示，遇到Bug时提供日志错误截图可以帮助我们更快的定位到问题。</p>
<h2>自架云端的安装和使用</h2>
<p>配合自行架设的服务器，可以将任务同步到云端执行，即使关掉浏览器和电脑后监测任务也会一直运行。</p>
<h3>安装</h3>
Expand Down Expand Up @@ -121,14 +133,23 @@ <h4>通过 Docker 启动</h4>
<p>请将上述命令中的*替换为对应的数据库信息。</p>
<h3>将浏览器插件对接云端</h3>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220521144137.png"><img src="image/20220521144137.png" alt="" style="max-width: 100%;"></a></p>
<p>点击插件右上方菜单中的<code class="notranslate">自架服务</code>。</p>
<p>点击插件右上方菜单中的<code class="notranslate">云端服务</code>。</p>
<p>在<code>服务器地址</code>一栏输入 <code>http://$BBB:8088</code>(将$BBB替换为IP B，这里的URL不用加key参数)；在<code>API_KEY</code>一栏输入密码C。</p>
<p>点击保存，连接成功后，配置完成。</p>
<h3>同步本地任务到云端</h3>
<p>配置好云端以后回到列表页，每行最右边会多出来一个「电脑」图标，点击后会变成「云」图标，该任务将改为在云端执行。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220521144707.png"><img src="image/20220521144707.png" alt="" style="max-width: 100%;"></a></p>
<p>点击右上角 「云+箭头」的按钮，可以主动同步任务到云端。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220521145106.png"><img src="image/20220521145106.png" alt="" style="max-width: 100%;"></a></p>
<p>Check酱也会每十分钟自动同步一次。</p>
<h3>云端错误排查</h3>
<p>由于服务器内存通常没大家电脑大，所以很多在本地执行OK的任务同步到云端后会因为「延迟读取」秒数太小中途停止而失败。如果遇到类似情况，请尝试增加「延迟读取」。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220523212625.png"><img src="image/20220523212625.png" alt="" style="max-width: 100%;"></a></p>
<p>如果这样也不行，往往是因为云端无头浏览器显示网页和本地存在差异导致，我们为这种情况生成了最近一次失败的任务的截图，可以在「云端服务」菜单下看到。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220523213104.png"><img src="image/20220523213104.png" alt="" style="max-width: 100%;"></a></p>
<p>点击「失败截图」按钮即可看到。注意：需要只用最新的镜像，并传递<code class="notranslate">ERROR_IMAGE=NORMAL</code> 环境变量。如果希望截取完整网页的图片，可以传递<code class="notranslate">ERROR_IMAGE=FULL</code>。</p>
<p>如果任务失败又没有截图，说明该任务不是因为CSS选择器未命中而失败，尝试增加「延迟读取」可能解决。</p>
<p>这个页面也能看到云端任务日志，这里的日志不包含手动点击「监测」按钮触发的任务。如果没有可以执行的任务（任务是定时触发的），那么日志亦可能为空。</p>

</body>
</html>
25 changes: 23 additions & 2 deletions readme.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ <h2>什么是「Check酱」</h2>
<p>Check酱是方糖气球出品的网页内容监测工具，它包含一个Edge/Chrome<strong>浏览器插件</strong>和可以自行架设的<strong>云端</strong>。</p>
<p>基于浏览器插件，它通过<strong>可视化选择器</strong>理论上可以监控网页上的任意内容（文本）、除了浏览器通知，还可以配合<a href="https://sct.ftqq.com" rel="nofollow">Server酱</a>将异动推送到微信或手机。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220521134213.png"><img src="image/20220521134213.png" alt="" style="max-width: 100%;"></a></p>
<p>Check酱插件通过后台打开网页的方式进行监测，<strong>完全模拟用户的真实行为</strong>，可以监控需要登录的各种后台网页，并自动延续登录状态。</p>
<p>Check酱的原理是，通过浏览器插件后台打开网页进行监测，从而<strong>完全模拟用户的真实行为</strong>，可以监控绝大部分复杂的动态网页，需要登录的各种后台页面，并（在绝大多数情况下）自动延续登录态。</p>
<p>除了支持网页内容（Dom）的监测，还支持HTTP状态（通过GET监测）、JSON和RSS方式。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220521134438.png"><img src="image/20220521134438.png" alt="" style="max-width: 100%;"></a></p>
<p>配合可以自行架设的<strong>云端</strong>，可以将监测任务同步到服务器，这样当浏览器和电脑关掉以后，监测任务依然可以定时运行。</p>
Expand Down Expand Up @@ -75,6 +75,18 @@ <h3>分享和导入监控点</h3>
</code></pre>
<p>复制以上字符后，在Check酱浏览器插件界面通过Ctrl+V粘贴，会自动识别并跳转到「添加监测点」界面。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220522113944.png"><img src="image/20220522113944.png" alt="" style="max-width: 100%;"></a></p>
<h3>监测周期限制</h3>
<p>有些任务只需要在特定的时间段执行，为了节省资源，我们添加了「监测周期限制」功能。比如某动画每周五上午十点更新，那么我们可以将「监测周期限制」设置如下：</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220523213852.png"><img src="image/20220523213852.png" alt="" style="max-width: 100%;"></a></p>
<p>这样其他时间段就不再启动监测。对于无法预知事件段的任务，使用默认的「每分钟」即可。</p>
<p>注意在「监测周期限制」之上，还有「监控间隔时间」。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220523214048.png"><img src="image/20220523214048.png" alt="" style="max-width: 100%;"></a></p>
<p>如果 「监测周期限制」 为每分钟，而「监控间隔时间」为60分钟，那么每分钟都会尝试监测，而一旦监测成功一次，那么下次监测将是60分钟后。</p>
<p>同时，因为执行监测任务本身也耗费时间，所以「监控间隔时间」为1分钟时，往往每隔一分钟（即每两分钟）才会运行一次任务。</p>
<h3>日志查看和错误定位</h3>
<p>为了更清楚的了解定时任务的执行情况，你可以打开「开发者工具」（F12）在 <code class="notranslate">Console</code> 标签页中可以看到任务产生的日志。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220523211235.png"><img src="image/20220523211235.png" alt="" style="max-width: 100%;"></a></p>
<p>错误信息也会在这里以红色高亮的行显示，遇到Bug时提供日志错误截图可以帮助我们更快的定位到问题。</p>
<h2>自架云端的安装和使用</h2>
<p>配合自行架设的服务器，可以将任务同步到云端执行，即使关掉浏览器和电脑后监测任务也会一直运行。</p>
<h3>安装</h3>
Expand Down Expand Up @@ -110,11 +122,20 @@ <h4>通过 Docker 启动</h4>
<p>请将上述命令中的*替换为对应的数据库信息。</p>
<h3>将浏览器插件对接云端</h3>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220521144137.png"><img src="image/20220521144137.png" alt="" style="max-width: 100%;"></a></p>
<p>点击插件右上方菜单中的<code class="notranslate">自架服务</code>。</p>
<p>点击插件右上方菜单中的<code class="notranslate">云端服务</code>。</p>
<p>在<code>服务器地址</code>一栏输入 <code>http://$BBB:8088</code>(将$BBB替换为IP B，这里的URL不用加key参数)；在<code>API_KEY</code>一栏输入密码C。</p>
<p>点击保存，连接成功后，配置完成。</p>
<h3>同步本地任务到云端</h3>
<p>配置好云端以后回到列表页，每行最右边会多出来一个「电脑」图标，点击后会变成「云」图标，该任务将改为在云端执行。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220521144707.png"><img src="image/20220521144707.png" alt="" style="max-width: 100%;"></a></p>
<p>点击右上角 「云+箭头」的按钮，可以主动同步任务到云端。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220521145106.png"><img src="image/20220521145106.png" alt="" style="max-width: 100%;"></a></p>
<p>Check酱也会每十分钟自动同步一次。</p>
<h3>云端错误排查</h3>
<p>由于服务器内存通常没大家电脑大，所以很多在本地执行OK的任务同步到云端后会因为「延迟读取」秒数太小中途停止而失败。如果遇到类似情况，请尝试增加「延迟读取」。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220523212625.png"><img src="image/20220523212625.png" alt="" style="max-width: 100%;"></a></p>
<p>如果这样也不行，往往是因为云端无头浏览器显示网页和本地存在差异导致，我们为这种情况生成了最近一次失败的任务的截图，可以在「云端服务」菜单下看到。</p>
<p><a target="_blank" rel="noopener noreferrer" href="image/20220523213104.png"><img src="image/20220523213104.png" alt="" style="max-width: 100%;"></a></p>
<p>点击「失败截图」按钮即可看到。注意：需要只用最新的镜像，并传递<code class="notranslate">ERROR_IMAGE=NORMAL</code> 环境变量。如果希望截取完整网页的图片，可以传递<code class="notranslate">ERROR_IMAGE=FULL</code>。</p>
<p>如果任务失败又没有截图，说明该任务不是因为CSS选择器未命中而失败，尝试增加「延迟读取」可能解决。</p>
<p>这个页面也能看到云端任务日志，这里的日志不包含手动点击「监测」按钮触发的任务。如果没有可以执行的任务（任务是定时触发的），那么日志亦可能为空。</p>

1 comment on commit 0921867

@vercel
Copy link

@vercel vercel bot commented on 0921867 May 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

checkchan-dist – ./

checkchan-dist-git-main-morexmore.vercel.app
checkchan-dist-morexmore.vercel.app
ckc.ftqq.com

Please sign in to comment.