Apache Solr

Apache Solr 集成会收集核心指标和缓存指标。核心指标侧重于请求数、文档计数和索引大小。缓存指标则侧重于缓存利用率。该集成还会收集 Solr 日志并将其解析为 JSON 载荷。结果将包含分片、副本、核心、级别和消息字段。

如需详细了解 Solr,请参阅 solr.apache.org/

前提条件

如需收集和注入 Solr 日志和指标,您必须安装 Ops Agent 2.10.0 版或更高版本。

此接收器支持 Apache Solr 7.7 和 8.x 版。

配置 Solr 实例

如需公开 JMX 端点,您必须在启动 JVM 时设置 com.sun.management.jmxremote.port 系统属性。我们还建议您将 com.sun.management.jmxremote.rmi.port 系统属性设置为同一端口。 如需远程公开 JMX 端点,您还必须设置 java.rmi.server.hostname 系统属性。

默认情况下,这些属性在 Solr 部署的 solr-env.sh 文件中设置。

如需使用命令行参数设置系统属性,请在启动 JVM 时在属性名称前加上 -D。 例如,如需将 com.sun.management.jmxremote.port 设置为端口 18983,请在启动 JVM 时指定以下内容:

-Dcom.sun.management.jmxremote.port=18983

为 Solr 配置 Ops Agent

按照配置 Ops Agent 指南,添加从 Solr 实例收集日志和指标所需的元素并重启代理

配置示例

以下命令会创建配置文件,以收集和注入 Solr 的日志和指标,并在 Linux 上重启 Ops Agent。

sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
logging:
  receivers:
    solr_system:
      type: solr_system
  service:
    pipelines:
      solr:
        receivers:
          - solr_system
metrics:
  receivers:
    solr:
      type: solr
  service:
    pipelines:
      solr:
        receivers:
          - solr
EOF
sudo service google-cloud-ops-agent restart

配置日志收集

如需从 Solr 注入日志,您必须为 Solr 生成的日志创建接收器,然后为新的接收器创建流水线。如需为 solr_system 日志配置接收器,请指定以下字段:

字段 默认 说明
type 该值必须为 solr_system
include_paths [/var/solr/logs/solr.log] 要读取的日志文件。
exclude_paths 如果 include_paths 包含 glob 或目录,则该字段为要排除的日志文件。
wildcard_refresh_interval 60s include_paths 中通配符文件路径的刷新间隔。指定为时长,例如 30s2m。该属性在高日志记录吞吐量下可能很有用,因为日志文件的轮替速度快于默认时间间隔。

记录的内容

solr_system 日志的 logName 派生自配置中指定的接收器 ID。LogEntry 中的详细字段如下所示。

字段 类型 说明
timestamp 字符串 (Timestamp) 收到请求的时间。
jsonPayload.collection 字符串 与日志相关的 Solr 集合。
jsonPayload.shard 字符串 与日志相关的 Solr 分片。
jsonPayload.replica 字符串 与日志相关的 Solr 副本。
jsonPayload.core 字符串 与日志相关的 Solr 核心。
jsonPayload.source 字符串 日志的来源。
jsonPayload.thread 字符串 发起日志的线程。
jsonPayload.message 字符串 日志消息。
jsonPayload.exception 字符串 与日志相关的异常,包括详细的堆栈轨迹(如果提供)。
severity 字符串 (LogSeverity) 日志条目级别(已转换)。

配置指标收集

如需从 Solr 收集指标,您必须为 Solr 指标创建接收器,然后为新接收器创建流水线。如需为 Solr 指标配置接收器,请指定以下字段:

字段 默认 说明
type 该值必须为 solr
endpoint localhost:18983 JMX 服务网址或用于构造服务网址的主机和端口。必须采用 host:port 格式。host:port 中的值将用于创建 service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi 的服务网址。
username 将 JMX 配置为需要身份验证时配置的用户名。
password 将 JMX 配置为需要身份验证时配置的密码。
collection_interval 60s time.Duration 值,例如 30s5m

监控的内容

下表提供了 Ops Agent 从 Solr 实例收集的指标列表。

指标类型
种类、类型
受监控的资源
标签
workload.googleapis.com/solr.cache.eviction.count
CUMULATIVEINT64
gce_instance
cache
core
workload.googleapis.com/solr.cache.hit.count
CUMULATIVEINT64
gce_instance
cache
core
workload.googleapis.com/solr.cache.insert.count
CUMULATIVEINT64
gce_instance
cache
core
workload.googleapis.com/solr.cache.lookup.count
CUMULATIVEINT64
gce_instance
cache
core
workload.googleapis.com/solr.cache.size
GAUGEINT64
gce_instance
cache
core
workload.googleapis.com/solr.document.count
GAUGEINT64
gce_instance
core
workload.googleapis.com/solr.index.size
GAUGEINT64
gce_instance
core
workload.googleapis.com/solr.request.count
CUMULATIVEINT64
gce_instance
handler
core
type
workload.googleapis.com/solr.request.error.count
CUMULATIVEINT64
gce_instance
handler
core
type
workload.googleapis.com/solr.request.time.average
GAUGEDOUBLE
gce_instance
handler
core
type
workload.googleapis.com/solr.request.timeout.count
CUMULATIVEINT64
gce_instance
handler
core
type

验证配置

您可以使用日志浏览器和 Metrics Explorer 来验证是否已正确配置 Solr 接收器。Ops Agent 可能需要一两分钟才会开始收集日志和指标。

如需验证是否已注入日志,请转到日志浏览器并运行以下查询来查看 Solr 日志:

resource.type="gce_instance"
logName=("projects/PROJECT_ID/logs/solr_system")


如需验证指标是否已注入,请转到 Metrics Explorer 并在 MQL 标签页中运行以下查询。

fetch gce_instance
| metric 'workload.googleapis.com/solr.request.count'
| align rate(1m)
| every 1m

后续步骤

如需查看如何使用 Ansible 安装 Ops Agent、配置第三方应用和安装示例信息中心的演示,请参阅安装 Ops Agent 以排查第三方应用的问题视频。