Docs » Configure application receivers » Configure application receivers for hosts and servers » SolrCloud

SolrCloud 🔗

Description 🔗

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

The integration monitors Solr instances. You can collect metrics only when the instance is running in SolrCloud mode.

To see the monitor source, view the signalfx-agent project on GitHub.

Installation 🔗

This monitor is available in the SignalFx Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector.

To install this integration:

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

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

Configuration 🔗

The Splunk Distribution of OpenTelemetry Collector allows embedding a Smart Agent monitor configuration in an associated Smart Agent Receiver instance.

Note: Providing a SolrCloud monitor entry in your Smart Agent or Collector configuration is required for its use. Use the appropriate form for your agent type.

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 Smart Agent example configuration for an autogenerated example of a YAML configuration file, with default values where applicable.

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.

See configuration examples for specific use cases that show how the collector can integrate and complement existing environments.

Configuration settings 🔗

The following table shows the configuration options for this monitor:

Option Required Type Description
pythonBinary no string Path to a python binary that should be used to execute the Python code. If not set, a built-in runtime will be used. Can include arguments to the binary as well.
host yes string
port yes integer
cluster no string Cluster name of this solr cluster.
enhancedMetrics no bool EnhancedMetrics boolean to indicate whether stats from /metrics are needed (default: false)
includeMetrics no list of strings IncludeMetrics metric names from the /admin/metrics endpoint to include (valid when EnhancedMetrics is "false")
excludeMetrics no list of strings ExcludeMetrics metric names from the /admin/metrics endpoint to exclude (valid when EnhancedMetrics is "true")

Metrics 🔗

These metrics are available for this integration.