docs: init

TongchengOpenSource · Jan 8, 2024 · b0f6ecd · b0f6ecd
1 parent d2a9273
commit b0f6ecd
Show file tree

Hide file tree

Showing 215 changed files with 649 additions and 393 deletions.
diff --git a/404.html b/404.html
@@ -0,0 +1,17 @@
+<!doctype html>
+<html lang="zh" dir="ltr">
+<head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+<meta name="generator" content="Docusaurus v2.0.0-beta.14">
+<title data-react-helmet="true">Page Not Found | 𝑪𝑲𝒊𝒃𝒂𝒏𝒂</title><meta data-react-helmet="true" property="og:title" content="Page Not Found | 𝑪𝑲𝒊𝒃𝒂𝒏𝒂"><meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" property="og:url" content="http://CKibana.inf.17usoft.com/docs//404.html"><meta data-react-helmet="true" name="docusaurus_locale" content="zh"><meta data-react-helmet="true" name="docusaurus_tag" content="default"><link data-react-helmet="true" rel="shortcut icon" href="/img/logo.svg"><link data-react-helmet="true" rel="canonical" href="http://CKibana.inf.17usoft.com/docs//404.html"><link data-react-helmet="true" rel="alternate" href="http://CKibana.inf.17usoft.com/docs//404.html" hreflang="en"><link data-react-helmet="true" rel="alternate" href="http://CKibana.inf.17usoft.com/docs//zh/404.html" hreflang="zh"><link data-react-helmet="true" rel="alternate" href="http://CKibana.inf.17usoft.com/docs//404.html" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.139f2ae5.css">
+<link rel="preload" href="/assets/js/runtime~main.03a465de.js" as="script">
+<link rel="preload" href="/assets/js/main.468cf45d.js" as="script">
+</head>
+<body>
+<script>!function(){function e(e){document.documentElement.setAttribute("data-theme",e)}var t=function(){var e=null;try{e=localStorage.getItem("theme")}catch(e){}return e}();null!==t?e(t):window.matchMedia("(prefers-color-scheme: dark)").matches?e("dark"):(window.matchMedia("(prefers-color-scheme: light)").matches,e("light"))}()</script><div id="__docusaurus">
+<div><a href="#" class="skipToContent_OuoZ">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" target="_self" href="/"><div class="navbar__logo"><img src="/img/ckibana-new.svg" alt="Site Logo" class="themedImage_TMUO themedImage--light_4Vu1" height="32" width="32"><img src="/img/ckibana-new.svg" alt="Site Logo" class="themedImage_TMUO themedImage--dark_uzRr" height="32" width="32"></div><b class="navbar__title">𝑪𝑲𝒊𝒃𝒂𝒏𝒂</b></a></div><div class="navbar__items navbar__items--right"><div class="navbar__search searchBarContainer_I7kZ"><input placeholder="Search" aria-label="Search" class="navbar__search-input"><div class="loadingRing_Zg7X searchBarLoadingRing_J5Ez"><div></div><div></div><div></div><div></div></div><div class="searchHintContainer_CDc6"><kbd class="searchHint_2RRg">ctrl</kbd><kbd class="searchHint_2RRg">K</kbd></div></div><div class="toggle_iYfV toggle_2i4l toggleDisabled_xj38"><div class="toggleTrack_t-f2" role="button" tabindex="-1"><div class="toggleTrackCheck_mk7D"><span class="toggleIcon_pHJ9">🌜</span></div><div class="toggleTrackX_dm8H"><span class="toggleIcon_pHJ9">🌞</span></div><div class="toggleTrackThumb_W6To"></div></div><input type="checkbox" class="toggleScreenReader_h9qa" aria-label="Switch between dark and light mode"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div class="main-wrapper"><main class="container margin-vert--xl"><div class="row"><div class="col col--6 col--offset-3"><h1 class="hero__title">Page Not Found</h1><p>We could not find what you were looking for.</p><p>Please contact the owner of the site that linked you to the original URL and let them know their link is broken.</p></div></div></main></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items"><li class="footer__item"><a href="https://github.com/TongchengOpenSource/ckibana/issues" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Github Issues<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li><li class="footer__item"><a href="https://ckibana.inf.17usoft.com/docs/" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>CKibana Community Forums<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div><div class="col footer__col"><div class="footer__title">Social</div><ul class="footer__items"><li class="footer__item"><a href="https://github.com/TongchengOpenSource/ckibana" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 TongchengOpenSource</div></div></div></footer></div>
+<script src="/assets/js/runtime~main.03a465de.js"></script>
+<script src="/assets/js/main.468cf45d.js"></script>
+</body>
+</html>
diff --git a/README.md b/README.md
@@ -1,47 +1,3 @@
-# ckibana
-
-## Introduce
-
-ckibana: ClickHouse adapter for Kibana (ClickHouse proxy for kibana)
-
-ckibana是一个为了能够在kibana上直接使用ElasticSearch语法查询ClickHouse的服务。常见使用场景如:nginx日志从ElasticSearch迁移到ClickHouse后,不需要业务调整使用习惯就可以直接使用。
-
-## Features
-
-- 版本支持: 兼容ElasticSearch跟kibana 6.x、7.x、8.x 版本
-- 语法支持: 兼容ElasticSearch常用语法(注: ip_range跟date_range仅可在搜索框中使用querystring语法查询)
-- 采样功能: 对于命中结果超过阈值的查询,支持动态计算采样+还原结果,提高查询性能且保障图表趋势基本跟真实数据趋势一致(限流阈值越大跟真实图表趋势越接近)。
-- 缓存功能: 支持使用ElasticSearch来做结果缓存,来提升重复查询的性能
-- 时间Round功能: 支持round查询时间,比如20s的round(例子: 查询时间秒在0-19s则自动round到0,20s-39s自动round到20s,比如查询时间是从01:50:15到05:52:47,则自动调整为从01:
-  50:00到05:52:40),配合缓存功能使用可以很好的缓解多个用户并发查询相同语句造成ClickHouse的压力
-- 黑名单功能: 支持设置黑名单来防止复杂语句造成ClickHouse压力
-- 查询模板功能: 支持按照去除时间后的语法监控,方便快速定位问题,配合黑名单功能一起使用可以很好的保障ClickHouse
-- 查询熔断: 支持配置最大查询时间范围等高级功能
-
-#### 支持的聚合语法：
-
-| ES语法                  | 说明                     |
-|-----------------------|------------------------|
-| terms                   |                        |
-| sum                     |                        |
-| min                     |                        |
-| max                    |                        |
-| avg                     |                        |
-| percentile_ranks         |                        |
-| percentiles             |                        |
-| filters                 | 目前仅支持第一层聚合             |
-| filter item             |                        |
-| cardinality             |                        |
-
-## TODO
-
-- 分段查询: 支持自动拆分查询时间,可以充分利用缓存,提升查询性能
-
-## Contact
-
-愿意参与构建ckibana或者是需要交流问题可以加入qq群
-![](img/readme01.jpg)
-
-## License
-
-[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) Copyright (C) Apache Software Foundation
+# Static folder
+
+This folder houses static assets: https://docusaurus.io/docs/static-assets
diff --git a/UserCase.md b/UserCase.md
diff --git a/__docusaurus/debug/config/index.html b/__docusaurus/debug/config/index.html
@@ -0,0 +1,17 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+<meta name="generator" content="Docusaurus v2.0.0-beta.14">
+<title data-react-helmet="true">Docusaurus debug panel</title><link rel="stylesheet" href="/assets/css/styles.139f2ae5.css">
+<link rel="preload" href="/assets/js/runtime~main.03a465de.js" as="script">
+<link rel="preload" href="/assets/js/main.468cf45d.js" as="script">
+</head>
+<body>
+<script>!function(){function e(e){document.documentElement.setAttribute("data-theme",e)}var t=function(){var e=null;try{e=localStorage.getItem("theme")}catch(e){}return e}();null!==t?e(t):window.matchMedia("(prefers-color-scheme: dark)").matches?e("dark"):(window.matchMedia("(prefers-color-scheme: light)").matches,e("light"))}()</script><div id="__docusaurus">
+<div><nav class="nav_a6CY"><a class="navlink_h2iO" href="/__docusaurus/debug">Config</a><a class="navlink_h2iO" href="/__docusaurus/debug/metadata">Metadata</a><a class="navlink_h2iO" href="/__docusaurus/debug/registry">Registry</a><a class="navlink_h2iO" href="/__docusaurus/debug/routes">Routes</a><a class="navlink_h2iO" href="/__docusaurus/debug/content">Content</a><a class="navlink_h2iO" href="/__docusaurus/debug/globalData">Global data</a></nav><main class="container_y4id"><h2>Site config</h2></main></div></div>
+<script src="/assets/js/runtime~main.03a465de.js"></script>
+<script src="/assets/js/main.468cf45d.js"></script>
+</body>
+</html>
diff --git a/__docusaurus/debug/content/index.html b/__docusaurus/debug/content/index.html
@@ -0,0 +1,17 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+<meta name="generator" content="Docusaurus v2.0.0-beta.14">
+<title data-react-helmet="true">Docusaurus debug panel</title><link rel="stylesheet" href="/assets/css/styles.139f2ae5.css">
+<link rel="preload" href="/assets/js/runtime~main.03a465de.js" as="script">
+<link rel="preload" href="/assets/js/main.468cf45d.js" as="script">
+</head>
+<body>
+<script>!function(){function e(e){document.documentElement.setAttribute("data-theme",e)}var t=function(){var e=null;try{e=localStorage.getItem("theme")}catch(e){}return e}();null!==t?e(t):window.matchMedia("(prefers-color-scheme: dark)").matches?e("dark"):(window.matchMedia("(prefers-color-scheme: light)").matches,e("light"))}()</script><div id="__docusaurus">
+<div><nav class="nav_a6CY"><a class="navlink_h2iO" href="/__docusaurus/debug">Config</a><a class="navlink_h2iO" href="/__docusaurus/debug/metadata">Metadata</a><a class="navlink_h2iO" href="/__docusaurus/debug/registry">Registry</a><a class="navlink_h2iO" href="/__docusaurus/debug/routes">Routes</a><a aria-current="page" class="navlink_h2iO active" style="background-color:#363739" href="/__docusaurus/debug/content">Content</a><a class="navlink_h2iO" href="/__docusaurus/debug/globalData">Global data</a></nav><main class="container_y4id"><h2>Plugin content</h2><div><section style="margin-bottom:60px"><h3>docusaurus-plugin-content-docs</h3><div><section style="margin-bottom:30px"><code>default</code></section><section style="margin-bottom:30px"><code>en</code></section></div></section><section style="margin-bottom:60px"><h3>docusaurus-plugin-content-pages</h3><div><section style="margin-bottom:30px"><code>default</code></section></div></section></div></main></div></div>
+<script src="/assets/js/runtime~main.03a465de.js"></script>
+<script src="/assets/js/main.468cf45d.js"></script>
+</body>
+</html>
diff --git a/__docusaurus/debug/globalData/index.html b/__docusaurus/debug/globalData/index.html
@@ -0,0 +1,17 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+<meta name="generator" content="Docusaurus v2.0.0-beta.14">
+<title data-react-helmet="true">Docusaurus debug panel</title><link rel="stylesheet" href="/assets/css/styles.139f2ae5.css">
+<link rel="preload" href="/assets/js/runtime~main.03a465de.js" as="script">
+<link rel="preload" href="/assets/js/main.468cf45d.js" as="script">
+</head>
+<body>
+<script>!function(){function e(e){document.documentElement.setAttribute("data-theme",e)}var t=function(){var e=null;try{e=localStorage.getItem("theme")}catch(e){}return e}();null!==t?e(t):window.matchMedia("(prefers-color-scheme: dark)").matches?e("dark"):(window.matchMedia("(prefers-color-scheme: light)").matches,e("light"))}()</script><div id="__docusaurus">
+<div><nav class="nav_a6CY"><a class="navlink_h2iO" href="/__docusaurus/debug">Config</a><a class="navlink_h2iO" href="/__docusaurus/debug/metadata">Metadata</a><a class="navlink_h2iO" href="/__docusaurus/debug/registry">Registry</a><a class="navlink_h2iO" href="/__docusaurus/debug/routes">Routes</a><a class="navlink_h2iO" href="/__docusaurus/debug/content">Content</a><a aria-current="page" class="navlink_h2iO active" style="background-color:#363739" href="/__docusaurus/debug/globalData">Global data</a></nav><main class="container_y4id"><h2>Global data</h2></main></div></div>
+<script src="/assets/js/runtime~main.03a465de.js"></script>
+<script src="/assets/js/main.468cf45d.js"></script>
+</body>
+</html>
diff --git a/__docusaurus/debug/index.html b/__docusaurus/debug/index.html
@@ -0,0 +1,17 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+<meta name="generator" content="Docusaurus v2.0.0-beta.14">
+<title data-react-helmet="true">Docusaurus debug panel</title><link rel="stylesheet" href="/assets/css/styles.139f2ae5.css">
+<link rel="preload" href="/assets/js/runtime~main.03a465de.js" as="script">
+<link rel="preload" href="/assets/js/main.468cf45d.js" as="script">
+</head>
+<body>
+<script>!function(){function e(e){document.documentElement.setAttribute("data-theme",e)}var t=function(){var e=null;try{e=localStorage.getItem("theme")}catch(e){}return e}();null!==t?e(t):window.matchMedia("(prefers-color-scheme: dark)").matches?e("dark"):(window.matchMedia("(prefers-color-scheme: light)").matches,e("light"))}()</script><div id="__docusaurus">
+<div><nav class="nav_a6CY"><a aria-current="page" class="navlink_h2iO active" style="background-color:#363739" href="/__docusaurus/debug">Config</a><a class="navlink_h2iO" href="/__docusaurus/debug/metadata">Metadata</a><a class="navlink_h2iO" href="/__docusaurus/debug/registry">Registry</a><a class="navlink_h2iO" href="/__docusaurus/debug/routes">Routes</a><a class="navlink_h2iO" href="/__docusaurus/debug/content">Content</a><a class="navlink_h2iO" href="/__docusaurus/debug/globalData">Global data</a></nav><main class="container_y4id"><h2>Site config</h2></main></div></div>
+<script src="/assets/js/runtime~main.03a465de.js"></script>
+<script src="/assets/js/main.468cf45d.js"></script>
+</body>
+</html>