Skip to main content

Server 使用情况报告

使用 Server 使用情况报告了解用户、应用程序、权限、计划和作业的指标，以便快速评估性能、审计和合规性方面的任何问题。连接至您的 MongoDB 和 Server API，助您轻松从 Alteryx Server 中提取相关数据和分析。选择您的首选输出，包括：Tableau Dashboard、单独的文件、数据库或将宏输出用于下游流程。

您可以从 Alteryx Marketplace 下载 Server 使用情况报告。

要求

Server 使用情况报告与 Designer 版本 2023.2 及更高版本兼容。为您的 Designer 版本使用最新可用的补丁程序。

安装 Server 使用情况报告实用程序及其依赖项

请按照以下步骤安装 Server 使用情况报告及相关依赖项。

安装 YXI

  1. 从 Alteryx Marketplace 下载 Server_Usage_Report.yxi。

  2. 双击 YXI 文件以使用 Designer 安装实用程序。

  3. 按照提示操作：

    • 为我的账户安装：仅您的用户账户可访问该计算机上的实用程序。安装到：%AppData%\Alteryx\。

    • 为所有用户安装：所有用户均可访问该计算机上的实用程序。安装到：%ProgramData%\Alteryx\。

  4. 完成后，打开“开始使用”工作流。在 Designer 中，转至帮助 > 示例工作流 > 企业实用程序 > Server 使用情况报告 > 开始使用。

安装 Tableau 输出连接器

注意

这是可选项。只有当您选择将输出写入 Tableau 时，才需要 Tableau 输出连接器。只要不选择写入 Tableau 的选项，即使没有 Tableau 输出工具，工作流也可正常运行。

  1. 从 Alteryx Marketplace 下载 Tableau 输出连接器。

  2. 双击 YXI 文件以使用 Designer 安装连接器。

  3. 按照提示操作：

    • 为我的账户安装：仅您的用户账户可访问该计算机上的工具。安装到：%AppData%\Alteryx\。

    • 为所有用户安装：所有用户均可访问该计算机上的工具。安装到：%ProgramData%\Alteryx\。

安装适用于 MongoDB 的 Simba 驱动程序

  1. 从 Alteryx 许可证门户下载 Simba 驱动程序。

  2. 向下滚动至产品下载部分的底部，然后选择驱动程序条目右侧的下载。

  3. 从版本列表中选择 MongoDB，然后选择下一步。

  4. 选择 Simba MongoDB 2.3.22.1024 64 位条目右侧的下载。

  5. 双击 MSI 文件即可在您的计算机上安装驱动程序。现在可以通过 ODBC 管理实用程序访问该驱动程序。

为 MongoDB 连接设置 DSN

接下来，为 MongoDB 连接设置 DSN。按照以下步骤操作。

  1. 在计算机上打开 ODBC 数据源管理器（64 位）。

  2. 使用 Simba MongoDB ODBC 驱动程序（版本 2.03.22.1024）创建新的数据源。

  3. 请填写以下字段：

    • 数据源名称：可随意命名，但必须填写，即使仅为临时使用 ODBC 连接。

    • Server：Server 名称。

    • 端口：Server 端口（嵌入式 MongoDB 为 27018）。

    • 数据库：AlteryxService（或 AlteryxGallery，取决于您要更新的数据库）。

    • 机制：SCRAM-SHA-256

    • 身份验证源：与上方输入“d”中的数据库名称相匹配。

    • 用户名：DB 用户名，通常为 user。

    • 密码：DB 密码。检查 Alteryx 系统设置以获取嵌入式 MongoDB 密码。

  4. 选择测试... 以确保连接成功。

  5. 选择高级选项...。

  6. 将二进制列大小的值更新为 2147483647。

  7. 在元数据部分的“机制”下拉菜单中，选择本地文件。

  8. 选择浏览... 并选择位于 MongoDB 版本特定架构文件夹中的相应架构文件：

    • 对于 2023.2 及以下版本：

      • 架构文件：MongoDB_Schema_23.2.json

      • 单用户（非管理员）安装位置：%appdata%\Alteryx\Samples\data\Enterprise Utilities\Server Usage Report\supporting_macros\SimbaMongoDB_SchemaFiles\MongoDB_Schema_23.2.json

      • 管理员安装位置：%ProgramData%\Alteryx\Samples\data\Enterprise Utilities\Server Usage Report\supporting_macros\SimbaMongoDB_SchemaFiles\MongoDB_Schema_23.2.json

    • 对于 2024.1 及更高版本：

      • 架构文件：MongoDB_Schema_24.1Plus.json

      • 单用户（非管理员）安装位置：%appdata%\Alteryx\Samples\data\Enterprise Utilities\Server Usage Report\supporting_macros\SimbaMongoDB_SchemaFiles\MongoDB_Schema_24.1Plus.json

      • 管理员安装位置：%ProgramData%\Alteryx\Samples\data\Enterprise Utilities\Server Usage Report\supporting_macros\SimbaMongoDB_SchemaFiles\MongoDB_Schema_24.1Plus.json

  9. 选择打开，然后点击确定，最后再次点击确定。

  10. 对 AlteryxService 数据库重复上述步骤。

为 MongoDB 创建 DCM 连接

下一步是在数据连接管理器 (DCM) 中为 MongoDB 创建连接。

  1. 打开 DCM。在 Designer 中，转到文件 > 管理连接。

  2. 在数据源选项卡上，选择 + 新建，然后选择 MongoDB 磁贴。

  3. 从技术下拉列表中，选择 MongoDB ODBC。

    • 数据源名称：从上方的为 MongoDB 连接设置 DSN 部分输入 Mongo AlteryxService 数据源名称。

    • ODBC DSN：选择先前创建的 MongoDB AlteryxService ODBC DSN。

  4. 选择保存，然后选择连接凭证。

  5. 请填写以下字段：

    • 身份验证方法：MongoDB 用户名和密码

    • 凭证：创建新凭证

    • 凭证名称：可自定义名称（例如 MongoDB_AlteryxService_Local）。

    • 加密保管库：DCM

    • 用户名：user

    • 密码：您的密码。

    • 身份验证机制：SCRAM-SHA-256

    • 身份验证源：AlteryxService

    • 允许 SDK 连接：请保持未选中

  6. 选择测试连接。如果成功，请选择创建并链接。

  7. 对 AlteryxGallery 数据库重复执行这些步骤。

创建到 Server API 的 DCM 连接

  1. 打开 DCM。在 Designer 中，转到文件 > 管理连接。

  2. 在数据源选项卡上，选择 + 新建，然后选择下载磁贴。

    • 数据源名称：自定义名称（例如 Server API）。

    • 基 URL：输入 Server API 的基 URL。以 /webapi/ 结尾。

      示例：https://CompanyServerName/webapi/

  3. 选择保存。

  4. 选择连接凭证。

  5. 从身份验证方法下拉列表中，选择用户名和密码。

  6. 从凭证下拉列表中，选择创建新凭证。

    • 凭证名称：自定义名称（例如 Server API Keys）。

    • 加密保管库：选择 DCM。

    • 用户名：输入在 Gallery 个人资料中找到的 API 访问密钥。

    • 密码：输入在 Gallery 个人资料中找到的 API 访问私密密钥。

  7. 选择创建并链接。

（可选）创建 DCM 连接缓存和输出数据库

  1. 打开 DCM。在 Designer 中，转到文件 > 管理连接。

  2. 选择 + 新建并选择 MongoDB 磁贴。

  3. 从技术下拉列表中，选择所需的数据库并完成连接设置。

（可选）在输出数据库中创建必要的表

运行以下应用程序以在输出数据库中创建必要的表。根据偏好，此步骤是可选的。如果未使用缓存数据库，或者数据未输出到数据库表中，此步骤也是可选的。如果使用了其中任何一个，请运行相应的应用程序。

  • 若使用数据库缓存从 Gallery 下载的工作流包，运行“创建缓存数据库表”（应用程序）。

  • 若使用数据库将最终数据输出到表中，运行“创建输出数据库表”（应用程序）。

运行 Alteryx Server 使用情况报告

按照以下步骤运行 Server 使用情况报告：

  1. 输入前述步骤中创建的凭证：

    • Alteryx Gallery：DCM 与 AlteryxGallery 数据库的连接。

    • Alteryx Service：DCM 与 AlteryxService 数据库的连接。

    • API 凭证：指向 Server API 凭证的 DCM 连接。

    • 按日期筛选作业和结果：将 AS_Queue（作业）和 AS_Results（结果消息）表查询限制为仅拉取至指定日期。

    • 使用缓存工作流数据库（可选）：缓存从 API 调用下载的应用程序包。若 Designer 中包含大量工作流，请使用此选项，因为每次运行时的下载可能会耗费很长时间。

    • 输出到 Tableau Hyper 文件：定义要输出 Tableau Hyper File 的位置。若为首次运行测试 Tableau 工作簿，请保留默认值。

    • 输出到数据库表（可选）：使用 DCM 连接将数据输出到自有数据库的独立表中。

    • 输出到单独文件（可选）：

      • （可选）选择一个位置（文件夹）以保存单独的文件。留空 = .\Output 文件夹。

      • （可选）输入前缀。留空 = 无前缀。

      • 选择文件类型（CSV 或 YXDB）。

  2. 运行工作流。

  3. 导航到提供的文件夹以打开 Tableau 工作簿并查看数据。若将 Hyper 文件输出到了其他位置，请在 Tableau 中重新连接数据源以查看数据。

故障排除

可参阅本节了解常见问题及故障排除步骤。

检查权限

首先，请务必确保在 Alteryx Server 界面中设置了正确的权限以下载工作流：

  • 在 Server 中，转到管理面板 > 设置 > 资产：确保未选中禁用直接下载。

  • 用户必须勾选每个工作流设置中的其他人可下载此工作流复选框。默认情况下会选中此复选框，因此除非他们明确清除此复选框，否则工作流包应具有正确的权限。

  • 运行 Server 使用情况报告的用户必须打开 API 访问权限才能获取 API 令牌。

其他故障排除说明

可参阅下文了解常见错误及建议的解决方案。

500 未找到响应

可参阅此社区文章。

Alteryx Server Usage Report (8)：PullServiceDetails (1483)：工具 #147：内部错误：尝试读取超出了 BLOB 结尾。

检查 ODBC DSN 高级设置。二进制列大小应为 2147483647。

Alteryx Server 使用情况报告 (8)：未能从 Alteryx Server 提取工作流详细信息：HTTP/1.1 500 内部服务器错误

检查工作流是否损坏。确认其能否在 Server 上运行。

Alteryx Server 使用情况报告 (8)：未能从 Alteryx Server 提取工作流详细信息：HTTP/1.1 403 已禁止

确认该工作流可以下载，且全局设置允许下载工作流。然后，查看 Server 的管理 > 设置中的“禁用直接下载”设置。

HTTP/1.1 404 或 HTTP/1.1 401 或“RetrieveServerOAuthToken：测试‘DownloadSucceeded’失败”

确认 DCM 连接的基 URL 是否为“http://localhost/webapi/”（注意 /webapi 后缀和结尾的“/”，请勿在此处使用 /Gallery/）。

确认 DCM 连接的访问密钥（用户名）和访问私密密钥（密码）正确。

确认 AlteryxService 正在运行，且能够访问 Gallery 或 Swagger (API) 文档。否则，请尝试在“服务”中重新启动 AlteryxService。

本节内容如下: