Docs » Available host and application monitors » Configure application receivers for hosts and servers » SolrCloud

SolrCloud πŸ”—

Description πŸ”—

The Splunk Distribution of OpenTelemetry Collector provides this integration as the SolrCloud monitor type using the Smart Agent receiver.

Use this integration to monitor Solr instances. You can collect metrics only when the instance is running in SolrCloud mode.

This integration is available for Kubernetes, Windows, and Linux.

Benefits πŸ”—

After you configure the integration, you can access these features:

Installation πŸ”—

Follow these steps to deploy this integration:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:

  2. Configure the monitor, as described in the Configuration section.

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration πŸ”—

This monitor type is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector. You can use existing Smart Agent monitors as OpenTelemetry Collector metric receivers with the Smart Agent Receiver.

This monitor type requires a properly configured environment on your system in which you’ve installed a functional Smart Agent release bundle. The Collector provides this bundle in the installation paths for x86_64/amd64.

To activate this monitor type in the Collector, add the following lines to your configuration (YAML) file:

Note

Provide a SolrCloud monitor entry in your Smart Agent or Collector configuration. Use the appropriate form for your agent type.

Splunk Distribution of OpenTelemetry Collector πŸ”—

To activate this monitor in the Splunk Distribution of OpenTelemetry Collector, add the following to your agent configuration:

receivers:
  smartagent/solr:
    type: collectd/solr
    ...  # Additional config

To complete the monitor activation, you must also include the smartagent/solr receiver item in a metrics pipeline. To do this, add the receiver item to the service > pipelines > metrics > receivers section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [smartagent/solr]

Smart Agent πŸ”—

To activate this monitor in the Smart Agent, add the following to your agent configuration:

monitors:  # All monitor config goes under this key
  - type: collectd/solr
    ...  # Additional config

See Install and configure the SignalFx Smart Agent for an autogenerated example of a YAML configuration file, with default values where applicable.

Configuration settings πŸ”—

The following table shows the configuration options for this monitor:

Option

Required

Type

Description

pythonBinary

No

string

Path to the Python binary. If not set, a built-in runtime is used. Can include arguments to the binary.

host

Yes

string

Host or address of the Solr instance. For example, 127.0.0.1.

port

Yes

integer

Port of the Solr instance.

cluster

No

string

Name of the Solr cluster.

enhancedMetrics

No

bool

Whether stats from the /metrics endpoint are needed. The default value isfalse.

includeMetrics

No

list of strings

List of metric names from the /admin/metrics endpoint to include. Valid when EnhancedMetrics is β€œfalse”.

excludeMetrics

No

list of strings

List of metric names from the /admin/metrics endpoint to exclude. Valid when EnhancedMetrics is β€œtrue”.

Metrics πŸ”—

These metrics are available for this integration:

Get help πŸ”—

If you are not able to see your data in Splunk Observability Cloud, try these tips:

To learn about even more support options, see Splunk Customer Success.