Apache Solr

Apache Solr is a popular, open source enterprise search platform from the Apache Lucene project. Powerful full-text search, hit highlighting, faceted search, dynamic clustering, database integration, rich document handling (For example, Word and PDF), and geospatial search are some of the features of Apache Solr. Solr is highly scalable, providing distributed search and index replication, and it powers the search and navigation features of many of the world largest internet sites.

Solr is written in Java and runs as a standalone full-text search server within a servlet container such as Jetty.

Prerequisites

1. Ensure that following variable is initialized:

export ENABLE_REMOTE_JMX_OPTS=true

2. In the bin folder, add the following lines and start Solr:

REMOTE_JMX_OPTS=('-Dcom.sun.management.jmxremote' \
    '-Dcom.sun.management.jmxremote.local.only=false' \
    '-Dcom.sun.management.jmxremote.ssl=false' \
    '-Dcom.sun.management.jmxremote.authenticate=false' \
    "-Dcom.sun.management.jmxremote.port=$RMI_PORT" \
    "-Dcom.sun.management.jmxremote.rmi.port=$RMI_PORT")

3. For Virtual Machines, install the Linux Agent.

Configuring the credentials

Configure the credentials in the directory /opt/opsramp/agent/conf/app.d/creds.yaml

solr:
- name: solr
  user: <username>
  pwd: <Password>
  encoding-type: plain
  labels:
    key1: val1
    key2: val2

Configuring the application

Virtual machine

Configure the application in the directory /opt/opsramp/agent/conf/app/discovery/auto-detection.yaml

- name: solr
  instance-checks:
    process-check:
      - solr
    port-check:
      - 8983
    uri-check:
      - "/solr"
  mon-type: "jmx"
  misc:
    jmx-port: "7199"

Docker environment

Configure the application in the directory /opt/opsramp/agent/conf/app/discovery/auto-container-detection.yaml

- name: solr
  container-checks:
    image-check:
      - solr
    port-check:
      - 8983
  mon-type: "jmx"
  misc:
    jmx-port: "7199"

Kubernetes environment

Configure the application in config.yaml

- name: solr
  container-checks:
    image-check:
      - solr
    port-check:
      - 8983
  mon-type: "jmx"
  misc:
    jmx-port: "7199"

• Adjust the jmx-port according to the jmx port used.
• jmx-port is required to enable remote JMX.

Validate

Go to Resources under the Infrastructure tab to check if your resources are onboarded and the metrics are collected.

Supported metrics