Apache Solr

Stay organized with collections Save and categorize content based on your preferences.

The Apache Solr integration collects core and cache metrics. Core metrics focus on requests, document count, and index size. Cache metrics focus on cache utilization. The integration also collects Solr logs and parses them into a JSON payload. The result includes fields for shard, replica, core, level, and message.

For more information about Solr, see the Apache Solr documentation.

Prerequisites

To collect Solr telemetry, you must install the Ops Agent:

  • For metrics, install version 2.10.0 or higher.
  • For logs, install version 2.10.0 or higher.

This integration supports Solr versions 8.x and 7.7.

Configure your Solr instance

To expose a JMX endpoint, you must set the com.sun.management.jmxremote.port system property when starting the JVM. We also recommend setting the com.sun.management.jmxremote.rmi.port system property to the same port. To expose a JMX endpoint remotely, you must also set the java.rmi.server.hostname system property.

By default, these properties are set in a Solr deployment's solr-env.sh file.

To set system properties by using command-line arguments, prepend the property name with -D when starting the JVM. For example, to set com.sun.management.jmxremote.port to port 18983, specify the following when starting the JVM:

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

Configure the Ops Agent for Solr

Following the guide for Configuring the Ops Agent, add the required elements to collect telemetry from Solr instances, and restart the agent.

Example configuration

The following commands create the configuration to collect and ingest telemetry for Solr and restarts the Ops Agent.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    solr:
      type: solr
  service:
    pipelines:
      solr:
        receivers:
          - solr

logging:
  receivers:
    solr_system:
      type: solr_system
  service:
    pipelines:
      solr:
        receivers:
          - solr_system
EOF

sudo service google-cloud-ops-agent restart

Configure logs collection

To ingest logs from Solr, you must create receivers for the logs that Solr produces and then create a pipeline for the new receivers.

To configure a receiver for your solr_system logs, specify the following fields:

Field Default Description
exclude_paths A list of filesystem path patterns to exclude from the set matched by include_paths.
include_paths [/var/solr/logs/solr.log] A list of filesystem paths to read by tailing each file. A wild card (*) can be used in the paths.
record_log_file_path false If set to true, then the path to the specific file from which the log record was obtained appears in the output log entry as the value of the agent.googleapis.com/log_file_path label. When using a wildcard, only the path of the file from which the record was obtained is recorded.
type The value must be solr_system.
wildcard_refresh_interval 60s The interval at which wildcard file paths in include_paths are refreshed. Given as a time duration parsable by time.ParseDuration, for example 30s or 2m. This property might be useful under high logging throughputs where log files are rotated faster than the default interval.

What is logged

The logName is derived from the receiver IDs specified in the configuration. Detailed fields inside the LogEntry are as follows.

The solr_system logs contain the following fields in the LogEntry:

Field Type Description
jsonPayload.collection string Solr collection related to the log
jsonPayload.core string Solr core related to the log
jsonPayload.exception string Exception related to the log, including detailed stacktrace where provided
jsonPayload.level string Log entry level
jsonPayload.message string Log message
jsonPayload.replica string Solr replica related to the log
jsonPayload.shard string Solr shard related to the log
jsonPayload.source string Source of where the log originated
jsonPayload.thread string Thread where the log originated
severity string (LogSeverity) Log entry level (translated).

Configure metrics collection

To ingest metrics from Solr, you must create receivers for the metrics that Solr produces and then create a pipeline for the new receivers.

To configure a receiver for your solr metrics, specify the following fields:

Field Default Description
collection_interval 60s A time duration value, such as 30s or 5m.
endpoint localhost:18983 The JMX Service URL or host and port used to construct the Service URL. Must be in the form of host:port. Values in host:port form will be used to create a Service URL of service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi.
password The configured password if JMX is configured to require authentication.
type This value must be solr.
username The configured username if JMX is configured to require authentication.

What is monitored

The following table provides the list of metrics that the Ops Agent collects from the Solr instance.

Metric type 
Kind, Type
Monitored resources
Labels
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
core
handler
type
workload.googleapis.com/solr.request.error.count
CUMULATIVEINT64
gce_instance
core
handler
type
workload.googleapis.com/solr.request.time.average
GAUGEDOUBLE
gce_instance
core
handler
type
workload.googleapis.com/solr.request.timeout.count
CUMULATIVEINT64
gce_instance
core
handler
type

Sample dashboard

To view your Solr metrics, you must have a chart or dashboard configured. Cloud Monitoring provides a library of sample dashboards for integrations, which contain preconfigured charts. For information about installing these dashboards, see Installing sample dashboards.

Verify the configuration

This section describes how to verify that you correctly configured the Solr receiver. It might take one or two minutes for the Ops Agent to begin collecting telemetry.

To verify that the logs are ingested, go to the Logs Explorer and run the following query to view the Solr logs:

resource.type="gce_instance"
log_id("solr_system")

To verify that the metrics are ingested, go to Metrics Explorer and run the following query in the MQL tab:

fetch gce_instance
| metric 'workload.googleapis.com/solr.cache.size'
| every 1m

What's next

For a walkthrough on how to use Ansible to install the Ops Agent, configure a third-party application, and install a sample dashboard, see the Install the Ops Agent to troubleshoot third-party applications video.

ß