You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by gi...@apache.org on 2022/02/07 03:11:20 UTC
[dolphinscheduler-website] branch asf-site updated: Automated deployment: 9da435518991adce39d4cc7f3755c18e13d92f78
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 5275ed5 Automated deployment: 9da435518991adce39d4cc7f3755c18e13d92f78
5275ed5 is described below
commit 5275ed5909288a4da5c6fe171945f73f19ec1557
Author: github-actions[bot] <gi...@users.noreply.github.com>
AuthorDate: Mon Feb 7 03:11:13 2022 +0000
Automated deployment: 9da435518991adce39d4cc7f3755c18e13d92f78
---
en-us/docs/dev/user_doc/guide/alert/telegram.html | 96 ++++++++++++++++++++++
en-us/docs/dev/user_doc/guide/alert/telegram.json | 6 ++
img/alert/telegram-plugin.png | Bin 0 -> 74412 bytes
python/_modules/pydolphinscheduler/constants.html | 6 +-
python/api.html | 15 ++++
python/genindex.html | 6 ++
python/objects.inv | Bin 5080 -> 5108 bytes
python/searchindex.js | 2 +-
zh-cn/docs/dev/user_doc/guide/alert/telegram.html | 88 ++++++++++++++++++++
zh-cn/docs/dev/user_doc/guide/alert/telegram.json | 6 ++
10 files changed, 223 insertions(+), 2 deletions(-)
diff --git a/en-us/docs/dev/user_doc/guide/alert/telegram.html b/en-us/docs/dev/user_doc/guide/alert/telegram.html
new file mode 100644
index 0000000..10464ea
--- /dev/null
+++ b/en-us/docs/dev/user_doc/guide/alert/telegram.html
@@ -0,0 +1,96 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="UTF-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
+ <meta name="keywords" content="telegram">
+ <meta name="description" content="telegram">
+ <title>telegram</title>
+ <link rel="shortcut icon" href="/img/favicon.ico">
+ <link rel="stylesheet" href="/build/vendor.23870e5.css">
+</head>
+<body>
+ <div id="root"><div class="md2html docs-page" data-reactroot=""><header class="header-container header-container-dark"><div class="header-body"><span class="mobile-menu-btn mobile-menu-btn-dark"></span><a href="/en-us/index.html"><img class="logo" src="/img/hlogo_white.svg"/></a><div class="search search-dark"><span class="icon-search"></span></div><span class="language-switch language-switch-dark">中</span><div class="header-menu"><div><ul class="ant-menu whiteClass ant-menu-light ant- [...]
+<p>If you need <code>Telegram</code> to alert, please create an alarm instance in warning instance manage dashboard. and choose the <code>Telegram</code> plugin</p>
+<p>The configuration example of <code>Telegram</code> is as follows:</p>
+<p><img src="/img/alert/telegram-plugin.png" alt="telegram-plugin"></p>
+<p>params config:</p>
+<ul>
+<li>WebHook:
+<blockquote>
+<p>Telegram open api</p>
+</blockquote>
+</li>
+<li>botToken
+<blockquote>
+<p>The robot's access token you were given</p>
+</blockquote>
+</li>
+<li>chatId
+<blockquote>
+<p>Sub Telegram Channel</p>
+</blockquote>
+</li>
+<li>parseMode
+<blockquote>
+<p>Mode for parsing entities in the message text.(txt、markdown、markdownV2、html)</p>
+</blockquote>
+</li>
+<li>EnableProxy
+<blockquote>
+<p>Enable Proxy Sever.</p>
+</blockquote>
+</li>
+<li>Proxy
+<blockquote>
+<p>the proxy address of Proxy-Server</p>
+</blockquote>
+</li>
+<li>Port
+<blockquote>
+<p>the proxy port of Proxy-Server</p>
+</blockquote>
+</li>
+<li>User
+<blockquote>
+<p>Authentication(Username) for Proxy-Server</p>
+</blockquote>
+</li>
+<li>Password
+<blockquote>
+<p>Authentication(Password) for Proxy-Server</p>
+</blockquote>
+</li>
+</ul>
+<p>P.S.:</p>
+<ul>
+<li><a href="https://core.telegram.org/bots">Telegram Application Bot Guide</a></li>
+<li><a href="https://core.telegram.org/bots/api">Telegram Bots Api</a></li>
+<li><a href="https://core.telegram.org/bots/api#sendmessage">Telegram SendMessage Api</a></li>
+</ul>
+</div></section><footer class="footer-container"><div class="footer-body"><div><h3>About us</h3><h4>Do you need feedback? Please contact us through the following ways.</h4></div><div class="contact-container"><ul><li><a href="/en-us/community/development/subscribe.html"><img class="img-base" src="/img/emailgray.png"/><img class="img-change" src="/img/emailblue.png"/><p>Email List</p></a></li><li><a href="https://twitter.com/dolphinschedule"><img class="img-base" src="/img/twittergray.png [...]
+ <script src="//cdn.jsdelivr.net/npm/react@15.6.2/dist/react-with-addons.min.js"></script>
+ <script src="//cdn.jsdelivr.net/npm/react-dom@15.6.2/dist/react-dom.min.js"></script>
+ <script>window.rootPath = '';</script>
+ <script src="/build/vendor.efd6bf4.js"></script>
+ <script src="/build/docs.md.ecb3c36.js"></script>
+ <script>
+ var _hmt = _hmt || [];
+ (function() {
+ var hm = document.createElement("script");
+ hm.src = "https://hm.baidu.com/hm.js?4e7b4b400dd31fa015018a435c64d06f";
+ var s = document.getElementsByTagName("script")[0];
+ s.parentNode.insertBefore(hm, s);
+ })();
+ </script>
+ <!-- Global site tag (gtag.js) - Google Analytics -->
+ <script async src="https://www.googletagmanager.com/gtag/js?id=G-899J8PYKJZ"></script>
+ <script>
+ window.dataLayer = window.dataLayer || [];
+ function gtag(){dataLayer.push(arguments);}
+ gtag('js', new Date());
+
+ gtag('config', 'G-899J8PYKJZ');
+ </script>
+</body>
+</html>
\ No newline at end of file
diff --git a/en-us/docs/dev/user_doc/guide/alert/telegram.json b/en-us/docs/dev/user_doc/guide/alert/telegram.json
new file mode 100644
index 0000000..14b48dc
--- /dev/null
+++ b/en-us/docs/dev/user_doc/guide/alert/telegram.json
@@ -0,0 +1,6 @@
+{
+ "filename": "telegram.md",
+ "__html": "<h1>Telegram</h1>\n<p>If you need <code>Telegram</code> to alert, please create an alarm instance in warning instance manage dashboard. and choose the <code>Telegram</code> plugin</p>\n<p>The configuration example of <code>Telegram</code> is as follows:</p>\n<p><img src=\"/img/alert/telegram-plugin.png\" alt=\"telegram-plugin\"></p>\n<p>params config:</p>\n<ul>\n<li>WebHook:\n<blockquote>\n<p>Telegram open api</p>\n</blockquote>\n</li>\n<li>botToken\n<blockquote>\n<p>The rob [...]
+ "link": "/dist/en-us/docs/dev/user_doc/guide/alert/telegram.html",
+ "meta": {}
+}
\ No newline at end of file
diff --git a/img/alert/telegram-plugin.png b/img/alert/telegram-plugin.png
new file mode 100644
index 0000000..6e2429c
Binary files /dev/null and b/img/alert/telegram-plugin.png differ
diff --git a/python/_modules/pydolphinscheduler/constants.html b/python/_modules/pydolphinscheduler/constants.html
index ad3014e..6d53384 100644
--- a/python/_modules/pydolphinscheduler/constants.html
+++ b/python/_modules/pydolphinscheduler/constants.html
@@ -166,7 +166,11 @@
<span class="n">RESULT_STATUS_KEYWORD</span> <span class="o">=</span> <span class="s2">"status"</span>
<span class="n">RESULT_STATUS_SUCCESS</span> <span class="o">=</span> <span class="s2">"SUCCESS"</span>
- <span class="n">RESULT_DATA</span> <span class="o">=</span> <span class="s2">"data"</span></div>
+ <span class="n">RESULT_DATA</span> <span class="o">=</span> <span class="s2">"data"</span>
+
+ <span class="n">SERVER_ADDRESS</span> <span class="o">=</span> <span class="s2">"127.0.0.1"</span>
+ <span class="n">SERVER_PORT</span> <span class="o">=</span> <span class="mi">25333</span>
+ <span class="n">AUTO_CONVERT</span> <span class="o">=</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="Delimiter"><a class="viewcode-back" href="../../api.html#pydolphinscheduler.constants.Delimiter">[docs]</a><span class="k">class</span> <span class="nc">Delimiter</span><span class="p">(</span><span class="nb">str</span><span class="p">):</span>
diff --git a/python/api.html b/python/api.html
index 6aa8289..55b140a 100644
--- a/python/api.html
+++ b/python/api.html
@@ -2258,6 +2258,11 @@ attribute <cite>_task_custom_attr</cite> due to avoid attribute cover.</p>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
<p>Constants and default value for java gateway.</p>
<dl class="py attribute">
+<dt class="sig sig-object py" id="pydolphinscheduler.constants.JavaGatewayDefault.AUTO_CONVERT">
+<span class="sig-name descname"><span class="pre">AUTO_CONVERT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#pydolphinscheduler.constants.JavaGatewayDefault.AUTO_CONVERT" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
<dt class="sig sig-object py" id="pydolphinscheduler.constants.JavaGatewayDefault.RESULT_DATA">
<span class="sig-name descname"><span class="pre">RESULT_DATA</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'data'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.JavaGatewayDefault.RESULT_DATA" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
@@ -2282,6 +2287,16 @@ attribute <cite>_task_custom_attr</cite> due to avoid attribute cover.</p>
<span class="sig-name descname"><span class="pre">RESULT_STATUS_SUCCESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SUCCESS'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.JavaGatewayDefault.RESULT_STATUS_SUCCESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="pydolphinscheduler.constants.JavaGatewayDefault.SERVER_ADDRESS">
+<span class="sig-name descname"><span class="pre">SERVER_ADDRESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'127.0.0.1'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.JavaGatewayDefault.SERVER_ADDRESS" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="pydolphinscheduler.constants.JavaGatewayDefault.SERVER_PORT">
+<span class="sig-name descname"><span class="pre">SERVER_PORT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">25333</span></em><a class="headerlink" href="#pydolphinscheduler.constants.JavaGatewayDefault.SERVER_PORT" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
</dd></dl>
<dl class="py class">
diff --git a/python/genindex.html b/python/genindex.html
index 960903a..40806e1 100644
--- a/python/genindex.html
+++ b/python/genindex.html
@@ -523,6 +523,8 @@
<li><a href="tasks/dependent.html#pydolphinscheduler.tasks.dependent.And">(class in pydolphinscheduler.tasks.dependent)</a>
</li>
</ul></li>
+ <li><a href="api.html#pydolphinscheduler.constants.JavaGatewayDefault.AUTO_CONVERT">AUTO_CONVERT (pydolphinscheduler.constants.JavaGatewayDefault attribute)</a>
+</li>
</ul></td>
</tr></table>
@@ -1424,6 +1426,10 @@
</li>
<li><a href="tasks/sql.html#pydolphinscheduler.tasks.sql.SqlType.SELECT">SELECT (pydolphinscheduler.tasks.sql.SqlType attribute)</a>
</li>
+ <li><a href="api.html#pydolphinscheduler.constants.JavaGatewayDefault.SERVER_ADDRESS">SERVER_ADDRESS (pydolphinscheduler.constants.JavaGatewayDefault attribute)</a>
+</li>
+ <li><a href="api.html#pydolphinscheduler.constants.JavaGatewayDefault.SERVER_PORT">SERVER_PORT (pydolphinscheduler.constants.JavaGatewayDefault attribute)</a>
+</li>
<li><a href="tasks/condition.html#pydolphinscheduler.tasks.condition.ConditionOperator.set_define_attr">set_define_attr() (pydolphinscheduler.tasks.condition.ConditionOperator method)</a>
<ul>
diff --git a/python/objects.inv b/python/objects.inv
index 40c6a36..e8e4ab0 100644
Binary files a/python/objects.inv and b/python/objects.inv differ
diff --git a/python/searchindex.js b/python/searchindex.js
index 088b11f..c6cf3ea 100644
--- a/python/searchindex.js
+++ b/python/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["api","concept","index","start","tasks/condition","tasks/datax","tasks/dependent","tasks/flink","tasks/http","tasks/index","tasks/map_reduce","tasks/procedure","tasks/python","tasks/shell","tasks/spark","tasks/sql","tasks/sub_process","tasks/switch","tutorial"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.dom [...]
\ No newline at end of file
+Search.setIndex({docnames:["api","concept","index","start","tasks/condition","tasks/datax","tasks/dependent","tasks/flink","tasks/http","tasks/index","tasks/map_reduce","tasks/procedure","tasks/python","tasks/shell","tasks/spark","tasks/sql","tasks/sub_process","tasks/switch","tutorial"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.dom [...]
\ No newline at end of file
diff --git a/zh-cn/docs/dev/user_doc/guide/alert/telegram.html b/zh-cn/docs/dev/user_doc/guide/alert/telegram.html
new file mode 100644
index 0000000..e5e6bba
--- /dev/null
+++ b/zh-cn/docs/dev/user_doc/guide/alert/telegram.html
@@ -0,0 +1,88 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="UTF-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
+ <meta name="keywords" content="telegram">
+ <meta name="description" content="telegram">
+ <title>telegram</title>
+ <link rel="shortcut icon" href="/img/favicon.ico">
+ <link rel="stylesheet" href="/build/vendor.23870e5.css">
+</head>
+<body>
+ <div id="root"><div class="md2html docs-page" data-reactroot=""><header class="header-container header-container-dark"><div class="header-body"><span class="mobile-menu-btn mobile-menu-btn-dark"></span><a href="/zh-cn/index.html"><img class="logo" src="/img/hlogo_white.svg"/></a><div class="search search-dark"><span class="icon-search"></span></div><span class="language-switch language-switch-dark">En</span><div class="header-menu"><div><ul class="ant-menu whiteClass ant-menu-light ant [...]
+<p>如果您需要使用<code>Telegram</code>进行告警，请在告警实例管理模块创建告警实例，选择<code>Telegram</code>插件。</p>
+<p><code>Telegram</code>的配置样例如下:</p>
+<p><img src="/img/alert/telegram-plugin.png" alt="telegram-plugin"></p>
+<p>参数配置:</p>
+<ul>
+<li>WebHook:
+<blockquote>
+<p>使用 Telegram 的机器人，发送消息的WebHook。</p>
+</blockquote>
+</li>
+<li>botToken
+<blockquote>
+<p>创建 Telegram 的机器人，获取的访问令牌。</p>
+</blockquote>
+</li>
+<li>chatId
+<blockquote>
+<p>订阅的 Telegram 频道</p>
+</blockquote>
+</li>
+<li>parseMode
+<blockquote>
+<p>消息解析类型, 支持: txt、markdown、markdownV2、html</p>
+</blockquote>
+</li>
+<li>EnableProxy
+<blockquote>
+<p>开启代理</p>
+</blockquote>
+</li>
+<li>Proxy
+<blockquote>
+<p>代理地址</p>
+</blockquote>
+</li>
+<li>User
+<blockquote>
+<p>代理鉴权用户</p>
+</blockquote>
+</li>
+<li>Password
+<blockquote>
+<p>代理鉴权密码</p>
+</blockquote>
+</li>
+</ul>
+<p><a href="https://core.telegram.org/bots">Telegram 如何申请机器人，如何创建频道</a>
+<a href="https://core.telegram.org/bots/api">Telegram 机器人开发文档</a>
+<a href="https://core.telegram.org/bots/api#sendmessage">Telegram SendMessage 接口文档</a></p>
+</div></section><footer class="footer-container"><div class="footer-body"><div><h3>联系我们</h3><h4>有问题需要反馈？请通过以下方式联系我们。</h4></div><div class="contact-container"><ul><li><a href="/zh-cn/community/development/subscribe.html"><img class="img-base" src="/img/emailgray.png"/><img class="img-change" src="/img/emailblue.png"/><p>邮件列表</p></a></li><li><a href="https://twitter.com/dolphinschedule"><img class="img-base" src="/img/twittergray.png"/><img class="img-change" src="/img/twitterblue.png"/><p [...]
+ <script src="//cdn.jsdelivr.net/npm/react@15.6.2/dist/react-with-addons.min.js"></script>
+ <script src="//cdn.jsdelivr.net/npm/react-dom@15.6.2/dist/react-dom.min.js"></script>
+ <script>window.rootPath = '';</script>
+ <script src="/build/vendor.efd6bf4.js"></script>
+ <script src="/build/docs.md.ecb3c36.js"></script>
+ <script>
+ var _hmt = _hmt || [];
+ (function() {
+ var hm = document.createElement("script");
+ hm.src = "https://hm.baidu.com/hm.js?4e7b4b400dd31fa015018a435c64d06f";
+ var s = document.getElementsByTagName("script")[0];
+ s.parentNode.insertBefore(hm, s);
+ })();
+ </script>
+ <!-- Global site tag (gtag.js) - Google Analytics -->
+ <script async src="https://www.googletagmanager.com/gtag/js?id=G-899J8PYKJZ"></script>
+ <script>
+ window.dataLayer = window.dataLayer || [];
+ function gtag(){dataLayer.push(arguments);}
+ gtag('js', new Date());
+
+ gtag('config', 'G-899J8PYKJZ');
+ </script>
+</body>
+</html>
\ No newline at end of file
diff --git a/zh-cn/docs/dev/user_doc/guide/alert/telegram.json b/zh-cn/docs/dev/user_doc/guide/alert/telegram.json
new file mode 100644
index 0000000..9f7fafd
--- /dev/null
+++ b/zh-cn/docs/dev/user_doc/guide/alert/telegram.json
@@ -0,0 +1,6 @@
+{
+ "filename": "telegram.md",
+ "__html": "<h1>Telegram</h1>\n<p>如果您需要使用<code>Telegram</code>进行告警，请在告警实例管理模块创建告警实例，选择<code>Telegram</code>插件。</p>\n<p><code>Telegram</code>的配置样例如下:</p>\n<p><img src=\"/img/alert/telegram-plugin.png\" alt=\"telegram-plugin\"></p>\n<p>参数配置:</p>\n<ul>\n<li>WebHook:\n<blockquote>\n<p>使用 Telegram 的机器人，发送消息的WebHook。</p>\n</blockquote>\n</li>\n<li>botToken\n<blockquote>\n<p>创建 Telegram 的机器人，获取的访问令牌。</p>\n</blockquote>\n</li>\n<li>chatId\n<blockquote>\n<p>订阅的 Telegram 频道</p>\n</blockquote>\n</ [...]
+ "link": "/dist/zh-cn/docs/dev/user_doc/guide/alert/telegram.html",
+ "meta": {}
+}
\ No newline at end of file