Apache Solr

L'intégration Apache Solr collecte les métriques de base et de cache. Les métriques de base sont axées sur les requêtes, le nombre de documents et la taille de l'index. Les métriques de cache se concentrent sur l'utilisation du cache. L'intégration collecte également les journaux Solr et les analyse dans une charge utile JSON. Le résultat inclut des champs de segment, d'instance dupliquée, de cœur, de niveau et de message.

Pour en savoir plus sur Solr, consultez la page solr.apache.org/.

Prérequis

Pour collecter et ingérer des journaux et des métriques Solr, vous devez installer l'agent Ops version 2.10.0 ou ultérieure.

Ce récepteur est compatible avec les versions 7.7 et 8.x d'Apache Solr.

Configurer votre instance Solr

Pour exposer un point de terminaison JMX, vous devez définir la propriété système com.sun.management.jmxremote.port lors du démarrage de la JVM. Nous vous recommandons également de définir la propriété système com.sun.management.jmxremote.rmi.port sur le même port. Pour exposer un point de terminaison JMX à distance, vous devez également définir la propriété système java.rmi.server.hostname.

Par défaut, ces propriétés sont définies dans le fichier solr-env.sh d'un déploiement Solr.

Pour définir les propriétés système à l'aide d'arguments de ligne de commande, ajoutez le préfixe -D au nom de la propriété lors du démarrage de la JVM. Par exemple, pour définir com.sun.management.jmxremote.port sur le port 18983, spécifiez les éléments suivants lors du démarrage de la JVM :

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

Configurer l'agent Ops pour Solr

En suivant le guide de configuration de l'agent Ops, ajoutez les éléments requis pour collecter les journaux et les métriques de vos instances Solr, puis redémarrez l'agent.

Exemple de configuration

La commande suivante crée le fichier de configuration permettant de collecter et d'ingérer des journaux et des métriques de Solr, et de redémarrer l'agent Ops sous Linux.

sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
logging:
  receivers:
    solr_system:
      type: solr_system
  service:
    pipelines:
      solr:
        receivers:
          - solr_system
metrics:
  receivers:
    solr:
      type: solr
  service:
    pipelines:
      solr:
        receivers:
          - solr
EOF
sudo service google-cloud-ops-agent restart

Configurer la collecte de journaux

Pour ingérer des journaux à partir de Solr, vous devez créer des récepteurs pour les journaux produits par Solr, puis créer un pipeline pour les nouveaux récepteurs. Pour configurer un récepteur pour vos journaux solr_system, spécifiez les champs suivants :

Champ Par défaut Description
type La valeur doit être égale à solr_system.
include_paths [/var/solr/logs/solr.log] Fichiers journaux à lire
exclude_paths Fichiers journaux à exclure, si include_paths contient un fichier glob ou un répertoire
wildcard_refresh_interval 60s Intervalle d'actualisation pour les chemins d'accès de fichiers utilisant des caractères génériques dans include_paths. Renseigné sous la forme d'une durée, par exemple, 30s ou 2m. Cette propriété peut s'avérer utile lorsque le débit de journalisation est élevé et que les fichiers journaux sont alternés plus rapidement que l'intervalle par défaut.

Contenu consigné

Le logName des journaux solr_system est dérivé des ID de récepteur spécifiés dans la configuration. Les champs détaillés dans l'entrée de journal (LogEntry) sont les suivants.

Champ Type Description
timestamp chaîne (Timestamp) Heure de réception de la requête.
jsonPayload.collection chaîne Collection Solr associée au journal.
jsonPayload.shard chaîne Segment Solr associé au journal.
jsonPayload.replica chaîne Instance dupliquée Solr associée au journal.
jsonPayload.core chaîne Cœur Solr lié au journal.
jsonPayload.source chaîne Source d'où provient le journal.
jsonPayload.thread chaîne Thread d'où provient le journal.
jsonPayload.message chaîne Message de journal.
jsonPayload.exception chaîne Exception liée au journal, y compris la trace de la pile détaillée lorsqu'elle est fournie.
severity chaîne (LogSeverity) Niveau d'entrée de journal (traduit).

Configurer la collecte de métriques

Pour collecter des métriques à partir de Solr, vous devez créer un récepteur pour les métriques Solr, puis créer un pipeline pour le nouveau récepteur. Pour configurer un récepteur pour vos métriques Solr, spécifiez les champs suivants :

Champ Par défaut Description
type La valeur doit être égale à solr.
endpoint localhost:18983 L'URL du service JMX, ou l'hôte et le port utilisés pour créer l'URL du service. Doit être au format host:port. Les valeurs du formulaire host:port seront utilisées pour créer une URL de service de service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi.
username Le nom d'utilisateur configuré si JMX est configuré pour exiger une authentification.
password Le mot de passe configuré si JMX est configuré pour exiger une authentification.
collection_interval 60s Une valeur time.Duration, telle que 30s ou 5m.

Métriques surveillées

Le tableau suivant fournit la liste des métriques que l'agent Ops collecte à partir de l'instance Solr.

Type de métrique
Genre, type
Ressources surveillées
Libellés
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
handler
core
type
workload.googleapis.com/solr.request.error.count
CUMULATIVEINT64
gce_instance
handler
core
type
workload.googleapis.com/solr.request.time.average
GAUGEDOUBLE
gce_instance
handler
core
type
workload.googleapis.com/solr.request.timeout.count
CUMULATIVEINT64
gce_instance
handler
core
type

Vérifier la configuration

Vous pouvez utiliser l'explorateur de journaux et l'explorateur de métriques pour vérifier que vous avez correctement configuré le récepteur Solr. La collecte des journaux et des métriques par l'agent Ops peut prendre une ou deux minutes.

Pour vérifier que les journaux sont ingérés, accédez à l'explorateur de journaux et exécutez la requête suivante pour afficher les journaux Solr :

resource.type="gce_instance"
logName=("projects/PROJECT_ID/logs/solr_system")


Pour vérifier que les métriques sont ingérées, accédez à l'explorateur de métriques et exécutez la requête suivante dans l'onglet MQL.

fetch gce_instance
| metric 'workload.googleapis.com/solr.request.count'
| align rate(1m)
| every 1m

Étape suivante

Pour accéder à un tutoriel pas à pas expliquant comment utiliser Ansible pour installer l'agent Ops, configurer une application tierce et installer un exemple de tableau de bord, consultez la vidéo Install the Ops Agent to troubleshoot third-party applications (Installer l'agent Ops pour résoudre les problèmes liés à des applications tierces).