Apache Solr

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

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 documentation Apache Solr.

Prerequisites

Pour collecter les données de télémétrie Solr, vous devez installer l'agent Ops :

  • Pour les métriques, installez la version 2.10.0 ou ultérieure.
  • Pour les journaux, installez la version 2.10.0 ou ultérieure.

Cette intégration est compatible avec les versions 8.x et 7.7 de 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 de vos instances Solr et redémarrez l'agent.

Exemple de configuration

Les commandes suivantes créent la configuration de collecte et d'ingestion de la télémétrie pour Solr et redémarre l'agent Ops.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# 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

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
exclude_paths Liste des formats de chemin d'accès au système de fichiers à exclure de l'ensemble correspondant à include_paths.
include_paths [/var/solr/logs/solr.log] Liste des chemins d'accès du système de fichiers à lire en affichant chaque fichier. Un caractère générique (*) peut être utilisé dans les chemins d'accès.
record_log_file_path false Si cette valeur est définie sur true, le chemin d'accès au fichier spécifique à partir duquel l'enregistrement de journal a été obtenu apparaît dans l'entrée de journal de sortie en tant que valeur du libellé agent.googleapis.com/log_file_path. Lorsque vous utilisez un caractère générique, seul le chemin du fichier à partir duquel l'enregistrement a été obtenu est enregistré.
type La valeur doit être égale à solr_system.
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. Donné en fonction de la durée d'analyse par time.ParseDuration, 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 champ logName 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.

Les journaux solr_system contiennent les champs suivants dans LogEntry :

Champ Type Description
jsonPayload.collection chaîne Collection Solr associée au journal
jsonPayload.core chaîne Cœur Solr associé au journal
jsonPayload.exception chaîne Exception liée au journal, y compris la trace détaillée de la pile, le cas échéant.
jsonPayload.level chaîne Niveau de l'entrée de journal
jsonPayload.message chaîne Message du journal
jsonPayload.replica chaîne Instance dupliquée Solr associée au journal
jsonPayload.shard chaîne Segment Solr associé au journal
jsonPayload.source chaîne Source d'où provient le journal
jsonPayload.thread chaîne Thread d'où provient le journal
severity chaîne (LogSeverity) Niveau d'entrée de journal (traduit).

Configurer la collecte de métriques

Pour ingérer des métriques à partir de Solr, vous devez créer des récepteurs pour les métriques produites par Solr, puis créer un pipeline pour les nouveaux récepteurs.

Pour configurer un récepteur pour vos métriques solr, spécifiez les champs suivants :

Champ Par défaut Description
collection_interval 60s Une valeur time duration, telle que 30s ou 5m.
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.
password Le mot de passe configuré si JMX est configuré pour exiger une authentification.
type Cette valeur doit être solr.
username Le nom d'utilisateur configuré si JMX est configuré pour exiger une authentification.

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
core
handler
type
workload.googleapis.com/solr.request.error.count
CUMULATIVEINT64
gce_instance
core
handler
type
workload.googleapis.com/solr.request.time.average
GAUGEDOUBLE
gce_instance
core
handler
type
workload.googleapis.com/solr.request.timeout.count
CUMULATIVEINT64
gce_instance
core
handler
type

Exemple de tableau de bord

Pour afficher vos métriques Solr, vous devez configurer un graphique ou un tableau de bord. Cloud Monitoring fournit une bibliothèque d'exemples de tableaux de bord pour les intégrations, contenant des graphiques préconfigurés. Pour en savoir plus sur l'installation de ces tableaux de bord, consultez la page Installer des exemples de tableaux de bord.

Vérifier la configuration

Cette section explique comment vérifier que vous avez bien configuré le récepteur Solr. La collecte de la télémétrie 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"
log_id("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.cache.size'
| 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).

ß