从源代码运行

编辑

运行连接器的基本方法是克隆存储库并在本地运行代码。如果您熟悉 Python 并希望快速迭代,这是一个不错的选择。

在 Kibana 中进行初始设置

编辑

按照 Kibana UI 中的 连接器 工作流程选择 连接器 摄取方法。

接下来,完成以下步骤

  1. 通过选择 数据源 来选择您要使用的第三方服务。
  2. 创建并命名一个新的 Elasticsearch 索引
  3. 生成一个新的 API 密钥 并将其保存在安全的地方。
  4. 命名您的连接器并提供可选的描述
  5. 转换 受管理的连接器为自管理连接器(仅当连接器本身也可用时才适用)。此操作不可逆。
  6. 从屏幕上显示的示例中复制配置块。您将在后面的步骤中使用它

    # ...
    connectors:
      - connector_id: <CONNECTOR-ID>
        api_key: <API-KEY> # Scoped API key for this connector (optional). If not specified, the top-level `elasticsearch.api_key` value is used.
        service_type: gmail # example
克隆存储库并编辑 config.yml
编辑

创建索引并输入数据源的访问详细信息后,就可以部署连接器服务了。

首先,您需要克隆 elastic/connectors 存储库。

请按照以下步骤操作

  • 使用以下命令在本地克隆或 Fork connectors 存储库:git clone https://github.com/elastic/connectors
  • 运行 make config 以生成您的初始 config.yml 文件
  • 在您选择的编辑器中打开 config.yml 配置文件。
  • 替换 host(您的 Elasticsearch 端点)、api_keyconnector_idservice_type 的值。

    展开 以查看 config.yml 文件的示例

    使用您之前复制的值替换 api_keyconnector_idservice_type 的值。

    elasticsearch:
      api_key: <key1> # Used to write data to .elastic-connectors and .elastic-connectors-sync-jobs
                    # Any connectors without a specific `api_key` value will default to using this key
    connectors:
      - connector_id: 1234
        api_key: <key2> # Used to write data to the `search-*` index associated with connector 1234
                        # You may have multiple connectors in your config file!
      - connector_id: 5678
        api_key: <key3> # Used to write data to the `search-*` index associated with connector 5678
      - connector_id: abcd # No explicit api key specified, so this connector will use <key1>

    连接器的 API 密钥

    您可以在 config.yml 文件中配置多个连接器。

    Kibana UI 使您可以创建作用域限定为特定索引/连接器的 API 密钥。如果您没有为特定连接器创建 API 密钥,则会使用顶级 elasticsearch.api_keyelasticsearch.username:elasticsearch.password 值。

    如果这些顶级 Elasticsearch 凭据没有足够的权限写入各个连接器索引,则需要创建这些额外的、作用域限定的 API 密钥。

    请使用上面的示例作为指导。

运行连接器服务
编辑

您需要 Python 版本 3.103.11 才能从源代码运行连接器服务。

配置连接器代码后,就可以运行连接器服务了。

在您的终端或 IDE 中

  1. cd 进入您的 connectors 克隆/Fork 的根目录。
  2. 运行以下命令以编译和运行连接器服务

    make install
    make run

连接器服务现在应该正在运行。UI 将通知您连接器已成功连接到您的 Elasticsearch 实例。

提醒一下,我们这里是在本地工作。在生产环境中,您需要将连接器服务部署到您自己的基础设施中。