在 Docker 上运行 Metricbeat

编辑

在 Docker 上运行 Metricbeat编辑

Metricbeat 的 Docker 镜像可从 Elastic Docker 注册表获取。基础镜像是 centos:7。

所有已发布 Docker 镜像和标签的列表可在 www.docker.elastic.co 上找到。

这些镜像可根据 Elastic 许可证免费使用。它们包含开源和免费的商业功能，以及对付费商业功能的访问权限。开始 30 天试用以试用所有付费商业功能。有关 Elastic 许可证级别的信息，请参阅订阅页面。

拉取镜像编辑

获取 Metricbeat for Docker 就像对 Elastic Docker 注册表发出 docker pull 命令一样简单。

docker pull docker.elastic.co/beats/metricbeat:8.14.3

或者，您可以下载其他 Docker 镜像，这些镜像只包含 Apache 2.0 许可证下的功能。要下载镜像，请访问 www.docker.elastic.co。

可选：验证镜像编辑

您可以使用 Cosign 应用程序来验证 Metricbeat Docker 镜像签名。

wget https://artifacts.elastic.co/cosign.pub
cosign verify --key cosign.pub docker.elastic.co/beats/metricbeat:8.14.3

cosign 命令会以 JSON 格式打印检查结果和签名有效负载

Verification for docker.elastic.co/beats/metricbeat:8.14.3 --
The following checks were performed on each of these signatures:
  - The cosign claims were validated
  - Existence of the claims in the transparency log was verified offline
  - The signatures were verified against the specified public key

运行 Metricbeat 设置编辑

使用设置命令运行 Metricbeat 将创建索引模式并加载可视化、仪表板和机器学习作业。运行此命令

docker run \
docker.elastic.co/beats/metricbeat:8.14.3 \
setup -E setup.kibana.host=kibana:5601 \
-E output.elasticsearch.hosts=["elasticsearch:9200"]

	替换您的 Kibana 和 Elasticsearch 主机和端口。
	如果您在 Elastic Cloud 中使用托管的 Elasticsearch Service，请使用以下语法将 `-E output.elasticsearch.hosts` 行替换为 Cloud ID 和 Elastic 密码

-E cloud.id=<Cloud ID from Elasticsearch Service> \
-E cloud.auth=elastic:<elastic password>

在 Docker 上配置 Metricbeat编辑

Docker 镜像提供了多种配置 Metricbeat 的方法。传统的方法是通过卷挂载提供配置文件，但也可以创建一个包含您的配置的自定义镜像。

示例配置文件编辑

下载此示例配置文件作为起点

curl -L -O https://raw.githubusercontent.com/elastic/beats/8.14/deploy/docker/metricbeat.docker.yml

卷挂载配置编辑

在 Docker 上配置 Metricbeat 的一种方法是通过卷挂载提供 metricbeat.docker.yml。使用 docker run，可以像这样指定卷挂载。

docker run -d \
  --name=metricbeat \
  --user=root \
  --volume="$(pwd)/metricbeat.docker.yml:/usr/share/metricbeat/metricbeat.yml:ro" \
  --volume="/var/run/docker.sock:/var/run/docker.sock:ro" \
  --volume="/sys/fs/cgroup:/hostfs/sys/fs/cgroup:ro" \
  --volume="/proc:/hostfs/proc:ro" \
  --volume="/:/hostfs:ro" \
  docker.elastic.co/beats/metricbeat:8.14.3 metricbeat -e \
  -E output.elasticsearch.hosts=["elasticsearch:9200"]

	替换您的 Elasticsearch 主机和端口。
	如果您在 Elastic Cloud 中使用托管的 Elasticsearch Service，请使用前面显示的语法将 `-E output.elasticsearch.hosts` 行替换为 Cloud ID 和 Elastic 密码。

自定义您的配置编辑

您之前下载的 metricbeat.docker.yml 文件配置为根据应用于您的容器的 Docker 标签部署 Beats 模块。有关更多详细信息，请参阅基于提示的自动发现。将标签添加到您的应用程序 Docker 容器中，当它们被部署时，Beats 自动发现功能将会识别它们。以下是一个 Apache HTTP Server 容器的示例命令，其中包含用于为 Apache HTTP Server 配置 Filebeat 和 Metricbeat 模块的标签

docker run \
  --label co.elastic.logs/module=apache2 \
  --label co.elastic.logs/fileset.stdout=access \
  --label co.elastic.logs/fileset.stderr=error \
  --label co.elastic.metrics/module=apache \
  --label co.elastic.metrics/metricsets=status \
  --label co.elastic.metrics/hosts='${data.host}:${data.port}' \
  --detach=true \
  --name my-apache-app \
  -p 8080:80 \
  httpd:2.4

自定义镜像配置编辑

可以将您的 Metricbeat 配置嵌入到自定义镜像中。以下是一个实现此目的的 Dockerfile 示例

FROM docker.elastic.co/beats/metricbeat:8.14.3
COPY --chown=root:metricbeat metricbeat.yml /usr/share/metricbeat/metricbeat.yml

监控主机编辑

在容器中执行 Metricbeat 时，如果您想监控主机或其他容器，有一些重要的事情需要注意。让我们以 Docker 作为我们的容器编排工具，逐步讲解一些示例。

此示例重点介绍了使 system 模块在容器内部正常工作所需的更改。这使得 Metricbeat 能够从容器内部监控主机。

docker run \
  --mount type=bind,source=/proc,target=/hostfs/proc,readonly \ 
  --mount type=bind,source=/sys/fs/cgroup,target=/hostfs/sys/fs/cgroup,readonly \ 
  --mount type=bind,source=/,target=/hostfs,readonly \ 
  --mount type=bind,source=/var/run/dbus/system_bus_socket,target=/hostfs/var/run/dbus/system_bus_socket,readonly \ 
  --env DBUS_SYSTEM_BUS_ADDRESS='unix:path=/hostfs/var/run/dbus/system_bus_socket' \ 
  --net=host \ 
  docker.elastic.co/beats/metricbeat:8.14.3 -e -system.hostfs=/hostfs

	Metricbeat 的系统模块主要通过 Linux proc 文件系统收集数据，该文件系统通常位于 `/proc`。由于容器尽可能地与主机隔离，因此容器的 `/proc` 内的数据与主机的 `/proc` 不同。为了解决这个问题，您可以将主机的 `/proc` 文件系统挂载到容器内部，并通过使用 `hostfs=/hostfs` 配置值告诉 Metricbeat 在查找 `/proc` 时查看 `/hostfs` 目录。
	默认情况下，系统进程指标集启用了 cgroup 报告，因此您需要在容器内挂载主机的 cgroup 挂载点。它们需要挂载在 `hostfs` 配置值指定的目录内。
	如果您想通过使用系统文件系统指标集监控主机上的文件系统，则需要在容器内部挂载这些文件系统。它们可以挂载在任何位置。
	系统用户指标集和系统服务指标集都需要访问 dbus。挂载 dbus 套接字，并将 `DBUS_SYSTEM_BUS_ADDRESS` 环境变量设置为挂载的系统套接字路径。
	系统网络指标集使用 `/proc/net/dev` 中的数据，或者在使用 `hostfs=/hostfs` 时使用 `/hostfs/proc/net/dev` 中的数据。使此文件包含主机网络设备的唯一方法是使用 `--net=host` 标志。这是由于 Linux 命名空间造成的；简单地将主机的 `/proc` 绑定挂载到 `/hostfs/proc` 是不够的。

特殊文件系统 /proc 和 /sys 只有在主机系统运行 Linux 时才可用。在 Windows 和 MacOS 上，尝试绑定挂载这些文件系统将会失败。

如果在 Linux 上使用系统套接字指标集，则需要向 Metricbeat 授予更多权限。此指标集从 /proc 读取文件，这些文件是其他用户拥有的内部对象的接口。读取所有这些文件所需的权限（sys_ptrace 和 dac_read_search）在 Docker 上默认是禁用的。要授予这些权限，还需要这些标志

--user root --cap-add sys_ptrace --cap-add dac_read_search

监控另一个容器中的服务编辑

接下来，让我们看一个从 Metricbeat 容器监控容器化服务的示例。

docker run \
  --network=mysqlnet \ 
  -e MYSQL_PASSWORD=secret \ 
  docker.elastic.co/beats/metricbeat:8.14.3

	将 Metricbeat 和 MySQL 容器放置在同一个 Docker 网络上，允许 Metricbeat 访问 MySQL 容器的公开端口，并使主机名 `mysql` 可被 Metricbeat 解析。
	如果您不想将某些值硬编码到您的 Metricbeat 配置中，则可以将它们作为环境变量或命令行标志传递给容器中的 Metricbeat（请参阅命令参考中的 `-E` CLI 标志）。

mysql 模块配置如下所示

metricbeat.modules:
- module: mysql
  metricsets: ["status"]
  hosts: ["tcp(mysql:3306)/"] 
  username: root
  password: ${MYSQL_PASSWORD}

	`mysql` 主机名将解析为 `mysqlnet` Docker 网络上名为 `mysql` 的容器的地址。
	`MYSQL_PASSWORD` 变量将在启动时进行评估。如果未设置该变量，则会导致启动时出错。

« APT 和 YUM 的存储库在 Kubernetes 上运行 Metricbeat »