community.general.elastic 回调 – 在 Elastic APM 中为每个 Ansible 任务创建分布式追踪

注意

此回调插件是 community.general 集合 (版本 10.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.general。您需要其他要求才能使用此回调插件，有关详细信息，请参阅要求。

要在剧本中使用它，请指定： community.general.elastic。

community.general 3.8.0 中的新增功能

回调插件 

此插件是**通知回调**。它将剧本运行的信息发送到其他应用程序、服务或系统。有关回调插件的更多信息，请参阅回调插件。

概要 

此回调在 Elastic APM 中为每个 Ansible 任务创建分布式追踪。
您可以使用环境变量配置插件。
请参阅 https://elastic.ac.cn/guide/en/apm/agent/python/current/configuration.html。

要求 

以下要求是在执行此回调的本地控制器节点上需要的。

elastic-apm（Python 库）

参数 

参数	注释
apm_api_key 字符串	使用 APM API 密钥配置环境变量：`ELASTIC_APM_API_KEY`
apm_secret_token 字符串	使用 APM 服务器令牌配置环境变量：`ELASTIC_APM_SECRET_TOKEN`
apm_server_url 字符串	使用 APM 服务器及其环境变量。配置环境变量：`ELASTIC_APM_SERVER_URL`
apm_service_name 字符串	服务名称资源属性。默认值： `"ansible"` 配置环境变量：`ELASTIC_APM_SERVICE_NAME`
apm_verify_server_cert 布尔值	如果为 HTTPS 连接，则验证 SSL 证书。选项 `false` `true` ← (默认) 配置环境变量：`ELASTIC_APM_VERIFY_SERVER_CERT`
hide_task_arguments 布尔值	隐藏任务的参数。选项 `false` ← (默认) `true` 配置环境变量：`ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS`
traceparent 字符串	W3C 追踪上下文标头 traceparent。配置环境变量：`TRACEPARENT`

示例 

examples: |
  Enable the plugin in ansible.cfg:
    [defaults]
    callbacks_enabled = community.general.elastic

  Set the environment variable:
    export ELASTIC_APM_SERVER_URL=<your APM server URL)>
    export ELASTIC_APM_SERVICE_NAME=your_service_name
    export ELASTIC_APM_API_KEY=your_APM_API_KEY

作者

Victor Martinez (@v1v)

提示

每个条目类型的配置项具有从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。