> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-fix-nav-issues.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 内嵌于 ClickHouse

> 在 ClickHouse 服务器中使用内嵌式 ClickStack - ClickHouse 可观测性栈

export const Image = ({img, alt, size}) => {
  return <Frame>
      <img src={img} alt={alt} />
    </Frame>;
};

ClickStack 直接集成在 ClickHouse 服务器二进制文件中。这意味着你无需部署任何额外组件，即可从你的 ClickHouse 实例访问 ClickStack UI (HyperDX) 。这种部署方式类似于公开演示 [play-clickstack.clickhouse.com](https://play-clickstack.clickhouse.com)，但它运行的是你自己的 ClickHouse 实例和数据。

<div id="suitable-for">
  ### 适用场景
</div>

* 以最少配置试用 ClickStack
* 使用可观测性 UI 探索自己的 ClickHouse 数据
* 演示和评估

<div id="limitations">
  ### 局限性
</div>

此嵌入式版本**不适用于生产环境**。与[可用于生产环境的 OSS 部署](/zh/clickstack/deployment/oss)相比，以下功能不可用：

* [告警](/zh/clickstack/features/alerts)
* [仪表盘](/zh/clickstack/features/dashboards/overview)和[搜索](/zh/clickstack/features/search)持久化——仪表盘和保存的搜索不会在不同会话间保留
* 可自定义的查询设置
* [事件模式](/zh/clickstack/features/event-patterns)

<div id="deployment-steps">
  ## 部署步骤
</div>

<Tabs>
  <Tab title="Docker">
    <Steps>
      <Step>
        ### 启动 ClickHouse

        拉取并运行 ClickHouse 服务器镜像，并设置密码：

        ```shell theme={null}
        docker run --rm -it -p 8123:8123 -e CLICKHOUSE_PASSWORD=password clickhouse/clickhouse-server:head-alpine
        ```

        <Tip>
          **无密码运行**

          如果你希望在不使用密码的情况下运行，则必须显式启用默认访问管理：

          ```shell theme={null}
          docker run --rm -it -p 8123:8123 -e CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT=1 clickhouse/clickhouse-server:head-alpine
          ```
        </Tip>
      </Step>

      <Step>
        ### 打开 ClickStack UI

        在浏览器中打开 [http://localhost:8123](http://localhost:8123)，然后点击 **ClickStack**。

        输入用户名 `default` 和密码 `password`，连接到本地实例。

        <Image img="https://mintcdn.com/private-7c7dfe99-fix-nav-issues/zXCQbzXFHfeD9FBK/images/clickstack/deployment/embedded/authenticate.png?fit=max&auto=format&n=zXCQbzXFHfeD9FBK&q=85&s=4ea48f0f53a6768b6405df3c024187be" alt="身份验证" size="lg" width="3818" height="1938" data-path="images/clickstack/deployment/embedded/authenticate.png" />
      </Step>

      <Step>
        ### 创建数据源

        如果你已有 OpenTelemetry 表，ClickStack 会检测到它们并自动创建数据源。

        在全新安装中，系统会提示你创建数据源。请在 **Table** 字段中填写相应的表名 (例如 `otel_logs`) ，然后点击 **Save New Source**。

        <Image img="https://mintcdn.com/private-7c7dfe99-fix-nav-issues/zXCQbzXFHfeD9FBK/images/clickstack/deployment/embedded/inferred-source.png?fit=max&auto=format&n=zXCQbzXFHfeD9FBK&q=85&s=3a07cff85bf9b3ec48ca6f6cdca2598a" alt="创建数据源" size="lg" width="3820" height="1938" data-path="images/clickstack/deployment/embedded/inferred-source.png" />

        如果你还没有数据，请参阅 [摄取数据](/zh/clickstack/ingesting-data) 了解可用选项。
      </Step>
    </Steps>
  </Tab>

  <Tab title="Binary">
    <Steps>
      <Step>
        ### 启动 ClickHouse

        下载并启动 ClickHouse：

        ```shell theme={null}
        curl https://clickhouse.com/ | sh
        ```

        <Accordion title="可选：启用系统日志表">
          如果你想查看 ClickHouse 自身的内部日志和指标，请在启动服务器之前，先在当前工作目录中创建一个配置片段：

          ```shell theme={null}
          mkdir -p config.d && cat > config.d/query_logs.xml << 'EOF'
          <clickhouse>
              <query_log>
                  <database>system</database>
                  <table>query_log</table>
              </query_log>
              <query_thread_log>
                  <database>system</database>
                  <table>query_thread_log</table>
              </query_thread_log>
              <query_views_log>
                  <database>system</database>
                  <table>query_views_log</table>
              </query_views_log>
              <metric_log>
                  <database>system</database>
                  <table>metric_log</table>
              </metric_log>
              <asynchronous_metric_log>
                  <database>system</database>
                  <table>asynchronous_metric_log</table>
              </asynchronous_metric_log>
          </clickhouse>
          EOF
          ```

          启用后，在打开 ClickStack 后，你可以创建一个指向 `system.query_log` 的 **日志数据源**：

          | 设置                   | 值                                                                                                                                       |
          | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
          | **Name**             | `Query Logs`                                                                                                                            |
          | **Database**         | `system`                                                                                                                                |
          | **Table**            | `query_log`                                                                                                                             |
          | **Timestamp Column** | `event_time`                                                                                                                            |
          | **Default Select**   | `event_time, query_kind, query, databases, tables, initial_user, projections, memory_usage, written_rows, read_rows, query_duration_ms` |
        </Accordion>

        启动服务器：

        ```shell theme={null}
        ./clickhouse server
        ```
      </Step>

      <Step>
        ### 打开 ClickStack UI

        在浏览器中打开 [http://localhost:8123](http://localhost:8123)，然后点击 **ClickStack**。系统会自动创建到本地实例的连接。
      </Step>

      <Step>
        ### 创建数据源

        如果你已有 OpenTelemetry 表，ClickStack 会检测到它们并自动创建数据源。

        如果你还没有数据，请参阅 [摄取数据](/zh/clickstack/ingesting-data) 了解可用选项。

        <Image img="https://mintcdn.com/private-7c7dfe99-fix-nav-issues/zXCQbzXFHfeD9FBK/images/clickstack/deployment/embedded/inferred-source.png?fit=max&auto=format&n=zXCQbzXFHfeD9FBK&q=85&s=3a07cff85bf9b3ec48ca6f6cdca2598a" alt="创建数据源" size="lg" width="3820" height="1938" data-path="images/clickstack/deployment/embedded/inferred-source.png" />
      </Step>
    </Steps>
  </Tab>
</Tabs>

<div id="next-steps">
  ## 后续步骤
</div>

如果你已准备好结束评估并进入下一阶段，可以考虑以下适用于生产环境的部署方式：

* [All-in-One](/zh/clickstack/deployment/all-in-one) — 单容器方案，包含所有组件，并支持持久化和身份验证
* [Docker Compose](/zh/clickstack/deployment/docker-compose) — 各组件独立部署，便于进行更精细的控制
* [Helm](/zh/clickstack/deployment/helm) — 推荐用于生产环境的 Kubernetes 部署
* [托管 ClickStack](/zh/clickstack/getting-started/managed) — 在 ClickHouse Cloud 上完全托管