Apache Solr

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 to Configure 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:

# Configures Ops Agent to collect telemetry from the app. You must restart the agent for the configuration to take effect.

set -e

# Check if the file exists
if [ ! -f /etc/google-cloud-ops-agent/config.yaml ]; then
  # Create the file if it doesn't exist.
  sudo mkdir -p /etc/google-cloud-ops-agent
  sudo touch /etc/google-cloud-ops-agent/config.yaml
fi

# 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

For these changes to take effect, you must restart the Ops Agent:

Linux

To restart the agent, run the following command on your instance:
```
sudo systemctl restart google-cloud-ops-agent
```
To confirm that the agent restarted, run the following command and verify that the components "Metrics Agent" and "Logging Agent" started:
```
sudo systemctl status "google-cloud-ops-agent*"
```

Windows

Connect to your instance using RDP or a similar tool and login to Windows.
Open a PowerShell terminal with administrator privileges by right-clicking the PowerShell icon and selecting Run as Administrator
To restart the agent, run the following PowerShell command:
```
Restart-Service google-cloud-ops-agent -Force
```
To confirm that the agent restarted, run the following command and verify that the components "Metrics Agent" and "Logging Agent" started:
```
Get-Service google-cloud-ops-agent*
```

Configure logs collection

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

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`		This 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, 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 a receiver for the metrics that Solr produces and then create a pipeline for the new receiver.

This receiver does not support the use of multiple instances in the configuration, for example, to monitor multiple endpoints. All such instances write to the same time series, and Cloud Monitoring has no way to distinguish among them.

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`
`CUMULATIVE`, `INT64` gce_instance	`cache` `core`
`workload.googleapis.com/solr.cache.hit.count`
`CUMULATIVE`, `INT64` gce_instance	`cache` `core`
`workload.googleapis.com/solr.cache.insert.count`
`CUMULATIVE`, `INT64` gce_instance	`cache` `core`
`workload.googleapis.com/solr.cache.lookup.count`
`CUMULATIVE`, `INT64` gce_instance	`cache` `core`
`workload.googleapis.com/solr.cache.size`
`GAUGE`, `INT64` gce_instance	`cache` `core`
`workload.googleapis.com/solr.document.count`
`GAUGE`, `INT64` gce_instance	`core`
`workload.googleapis.com/solr.index.size`
`GAUGE`, `INT64` gce_instance	`core`
`workload.googleapis.com/solr.request.count`
`CUMULATIVE`, `INT64` gce_instance	`core` `handler` `type`
`workload.googleapis.com/solr.request.error.count`
`CUMULATIVE`, `INT64` gce_instance	`core` `handler` `type`
`workload.googleapis.com/solr.request.time.average`
`GAUGE`, `DOUBLE` gce_instance	`core` `handler` `type`
`workload.googleapis.com/solr.request.timeout.count`
`CUMULATIVE`, `INT64` gce_instance	`core` `handler` `type`

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 Solr logs are being sent to Cloud Logging, do the following:

In the Google Cloud console, go to the Logs Explorer page:
Go to Logs Explorer

If you use the search bar to find this page, then select the result whose subheading is Logging.
Enter the following query in the editor, and then click Run query:
```
resource.type="gce_instance"
log_id("solr_system")
```

To verify that Solr metrics are being sent to Cloud Monitoring, do the following:

In the Google Cloud console, go to the Metrics explorer page:
Go to Metrics explorer

If you use the search bar to find this page, then select the result whose subheading is Monitoring.
In the toolbar of the query-builder pane, select the button whose name is either MQL or PromQL.
Verify that MQL is selected in the Language toggle. The language toggle is in the same toolbar that lets you format your query.

Enter the following query in the editor, and then click Run query:

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

View dashboard

To view your Solr metrics, you must have a chart or dashboard configured. The Solr integration includes one or more dashboards for you. Any dashboards are automatically installed after you configure the integration and the Ops Agent has begun collecting metric data.

You can also view static previews of dashboards without installing the integration.

To view an installed dashboard, do the following:

In the Google Cloud console, go to the Dashboards page:
Go to Dashboards

If you use the search bar to find this page, then select the result whose subheading is Monitoring.
Select the Dashboard List tab, and then choose the Integrations category.
Click the name of the dashboard you want to view.

If you have configured an integration but the dashboard has not been installed, then check that the Ops Agent is running. When there is no metric data for a chart in the dashboard, installation of the dashboard fails. After the Ops Agent begins collecting metrics, the dashboard is installed for you.

To view a static preview of the dashboard, do the following:

In the Google Cloud console, go to the Integrations page:
Go to Integrations

If you use the search bar to find this page, then select the result whose subheading is Monitoring.
Click the Compute Engine deployment-platform filter.
Locate the entry for Solr and click View Details.
Select the Dashboards tab to see a static preview. If the dashboard is installed, then you can navigate to it by clicking View dashboard.

For more information about dashboards in Cloud Monitoring, see Dashboards and charts.

For more information about using the Integrations page, see Manage integrations.

Install alerting policies

Alerting policies instruct Cloud Monitoring to notify you when specified conditions occur. The Solr integration includes one or more alerting policies for you to use. You can view and install these alerting policies from the Integrations page in Monitoring.

To view the descriptions of available alerting policies and install them, do the following:

In the Google Cloud console, go to the Integrations page:
Go to Integrations

If you use the search bar to find this page, then select the result whose subheading is Monitoring.
Locate the entry for Solr and click View Details.
Select the Alerts tab. This tab provides descriptions of available alerting policies and provides an interface for installing them.
Install alerting policies. Alerting policies need to know where to send notifications that the alert has been triggered, so they require information from you for installation. To install alerting policies, do the following:
1. From the list of available alerting policies, select those that you want to install.
2. In the Configure notifications section, select one or more notification channels. You have the option to disable the use of notification channels, but if you do, then your alerting policies fire silently. You can check their status in Monitoring, but you receive no notifications.
  
  For more information about notification channels, see Manage notification channels.
3. Click Create Policies.

For more information about alerting policies in Cloud Monitoring, see Introduction to alerting.