xObserve

  1. 开始使用
  2. 二进制安装包

xObserve 提供了预编译的二进制文件和 UI 静态资源，大家可以从 Github 下载 release 的 zip 包.

对于用户而言，预编译的文件用起来很简单，不过对于开发者而言，还是建议选择构建本地开发环境，一劳永逸。

  1. 为 xObserve 服务器配置监听地址

    在预编译安装包中，提供静态资源的文件服务和提供 API 的服务共享一个端口，因此我们只需要配置一下 xObserve api server 的监听端口即可。默认的地址是 `localhost:10086`

    xObserveRoot/xobserve.yaml
    server:
  ## api server listening address
  ## ip:host
  listening_addr: localhost:10086

  2. 启动 xObserve

    进入预编译文件的根目录，运行以下命令启动 xObserve server:

    xObserveRoot/
    ./xobserveINFO[08-22|13:40:25] xObserve is ready and listening on address=localhost:10086

在浏览器中访问

如果你不修改默认监听的地址，那其实只要 `./xobserve` 就能启动服务，超级简单。现在打开浏览器访问 http://localhost:10086 看看效果吧.

为何不需要 Nginx 或者 Vite dev server 来提供 UI 静态文件的下载?

原因是在 xObserve server 中除了提供 api 服务外，我们同时还内置了静态文件资源服务，最最重要的是它们共享一个端口，因此对于用户来说，是完全无感知的使用。

如果我想将域名指向 UI 和 API server 该怎么做?

从上面的描述可以看出，UI 静态文件服务和 API server 是共享一个 ip 和端口的，这种对于内网的环境来说不是问题，但是如果你的老板想在路上或者家里看看数据怎么办

此时显然需要两个域名：一个域名用于访问 UI 静态资源，一个域名用于访问 API server，此时我们可以这么做：

1. 将域名 A，例如 `https://myxobserve.io` 指向 API server 的地址，同时也是静态资源文件服务的地址

2. 修改 `xobserve.yaml`，将字段 `override_api_server_addr_for_ui` 的值设置为 `https://myxobserve.io`

此时，我们会从 `https://myxobserve.io` 下载静态资源，这些网页文件将访问的 API server 地址也是 `https://myxobserve.io`

假如不设置这个资源，UI 网页文件访问的依然是 API server 的监听地址，但是这个地址明显是一个内网地址，是无法在外网访问的。

这种方法不赖，但是还是不够灵活，更好的方法是将静态资源和 API server 分离部署。

如果我想将 UI 资源分离部署该怎么办？

一个很好的生产环境部署实践是将 UI 静态资源服务跟 API 服务分离部署，虽然对于 xObserve 这样的服务来说这不是必须的，但是如果你有这样的需求，可以看看下一节 从源码部署

下一步做什么

  • xObserve 入门教程

    学习如何使用 xObserve, 在此过程中迅速熟悉 xObserve 的核心概念和特性。

Copyright © 2023 xObserve.io Team.

GitHub