Link Search Menu Expand Document Documentation Menu
文档

在报告 CLI 中使用环境变量

您可以使用环境变量而不是在命令行中显式提供值。报告 CLI 从项目内当前目录的环境变量中读取。

要在 Linux 中设置环境变量，请使用以下命令

export NAME=VALUE

每行应使用 NAME=VALUE 格式。以井号 (#) 开头的每一行都被视为注释。引号 (“) 不会进行任何特殊处理。

命令行参数中的值优先级高于环境文件。例如，如果您在 .env 文件中将文件名添加为 test，并添加 --filename report 命令选项，则生成的报告名称将为 report。

示例：使用环境变量请求 PNG 报告

以下命令请求一个采用 PNG 格式并使用基本身份验证的报告

opensearch-reporting-cli --url https://:5601/app/dashboards#/view/7adfa750-4c81-11e8-b3d7-01146121b73d --format png --auth basic --credentials admin:<custom-admin-password>

成功后，报告将下载到当前目录。

使用 Amazon SES 请求带有报告附件的电子邮件

要使用 Amazon SES 作为电子邮件传输机制，需要满足以下先决条件

{
  "Statement": [
    {
      "Effect": "Allow",
      "Action": "ses:SendRawEmail",
      "Resource": "*"
    }
  ]
}

以下命令请求一封带有报告附件的电子邮件

opensearch-reporting-cli --url https://:5601/app/dashboards#/view/7adfa750-4c81-11e8-b3d7-01146121b73d --transport ses --from <sender_email_id> --to <recipient_email_id>

以下命令对所有其他选项使用默认值。您也可以在 .env 文件中设置 OPENSEARCH_FROM、OPENSEARCH_TO 和 OPENSEARCH_TRANSPORT，然后使用以下命令

opensearch-reporting-cli --url https://:5601/app/dashboards#/view/7adfa750-4c81-11e8-b3d7-01146121b73d

要修改电子邮件正文，您可以编辑 index.hbs 文件。

示例：使用 SMTP 将报告发送到电子邮件地址

要使用 SMTP 传输将报告发送到电子邮件地址，您需要在 .env 文件中设置选项 OPENSEARCH_SMTP_HOST、OPENSEARCH_SMTP_PORT、OPENSEARCH_SMTP_USER、OPENSEARCH_SMTP_PASSWORD 和 OPENSEARCH_SMTP_SECURE。

在 .env 文件中设置传输选项后，您可以使用以下命令发送电子邮件

opensearch-reporting-cli --url https://:5601/app/dashboards#/view/7adfa750-4c81-11e8-b3d7-01146121b73d --transport smtp --from <sender_email_id> --to <recipient_email_id>

您可以选择使用 .env 文件或命令行参数值设置选项，并可以任意组合。请确保指定所有必需的值，以避免错误。

要修改电子邮件正文，您可以编辑 index.hbs 文件。

限制

以下限制适用于报告 CLI 中环境变量的使用

  • 支持的平台包括 Windows x86、Windows x64、Mac Intel、Mac ARM、Linux x86 和 Linux x64。

    对于任何其他平台，用户可以利用 CHROMIUM_PATH 环境变量来使用自定义 Chromium。

  • 如果 URL 包含感叹号 (!)，则需要暂时禁用历史扩展。根据您使用的 shell，您可以使用以下命令之一禁用历史扩展

    • 对于 bash，请使用 set +H。
    • 对于 zsh，请使用 setopt nobanghist。

    或者，您可以使用以下格式将 URL 值添加为环境变量：URL="<url-with-!>"。

  • 所有命令选项只接受小写字母。

故障排除

要解决 MessageRejected: Email address is not verified（邮件被拒：电子邮件地址未验证）错误，请参阅 AWS 知识中心中的 为什么我会收到来自 Amazon SES 的 400 “邮件被拒”错误，消息为 “Email address is not verified”（电子邮件地址未验证）？。

剩余 350 字符

有问题？。

想做贡献？或。