Configurer l'intégration de Prometheus OpenMetrics

Sauf indication contraire, les options de configuration de votre intégration Prometheus OpenMetrics avec New Relic s'appliquent aux environnements Docker et Kubernetes. Au minimum, les valeurs de configuration suivantes sont required:

Nom Cluster

Recommandation : configurez votre clé de licence New Relic en tant que variable d’environnement nommée LICENSE_KEY. Cela fournit un environnement plus sécurisé, car New Relic peut charger votre variable d'environnement à partir d'un secret d'authentification TLS mutuel.

Configurer nri-prometheus-latest.yaml

Le fichier manifeste nri-prometheus-latest.yaml inclut la carte nri-prometheus-cfg montrant un exemple de configuration. Utilisez le fichier manifeste pour configurer les paramètres suivants.

Voici un exemple de fichier de configuration que vous pouvez enregistrer et modifier pour l'adapter à vos besoins. Pour plus d'informations, consultez la documentation sur l'authentification TLS mutuelle et la traduction de PromQL en NRQL.

# The name of your cluster. It's important to match other New Relic products to relate the data.
cluster_name: "<YOUR_CLUSTER_NAME>"

# When standalone is set to false nri-prometheus requires an infrastructure agent to work and send data. Defaults to true
# standalone: true

# How often the integration should run. Defaults to 30s.
# scrape_duration: "30s"

# The HTTP client timeout when fetching data from targets. Defaults to 5s.
# scrape_timeout: "5s"

# How old must the entries used for calculating the counters delta be
# before the telemetry emitter expires them. Defaults to 5m.
# telemetry_emitter_delta_expiration_age: "5m"

# How often must the telemetry emitter check for expired delta entries.
# Defaults to 5m.
# telemetry_emitter_delta_expiration_check_interval: "5m"

# Wether the integration should run in verbose mode or not. Defaults to false.
verbose: false

# Whether the integration should run in audit mode or not. Defaults to false.
# Audit mode logs the uncompressed data sent to New Relic. Use this to log all data sent.
# It does not include verbose mode. This can lead to a high log volume, use with care.
audit: false

# Wether the integration should skip TLS verification or not. Defaults to false.
insecure_skip_verify: false

# The label used to identify scrapable targets. Defaults to "prometheus.io/scrape".
scrape_enabled_label: "prometheus.io/scrape"

# scrape_services Allows to enable scraping the service and not the endpoints behind.
# When endpoints are scraped this is no longer needed
scrape_services: true

# scrape_endpoints Allows to enable scraping directly endpoints instead of services as prometheus service natively does.
# Please notice that depending on the number of endpoints behind a service the load can increase considerably
scrape_endpoints: false

# Whether k8s nodes need to be labelled to be scraped or not. Defaults to true.
require_scrape_enabled_label_for_nodes: true

# Number of worker threads used for scraping targets.
# For large clusters with many (>400) targets, slowly increase until scrape
# time falls between the desired `scrape_duration`.
# Increasing this value too much will result in huge memory consumption if too
# many metrics are being scraped.
# Default: 4
# worker_threads: 4

# Maximum number of metrics to keep in memory until a report is triggered.
# Changing this value is not recommended unless instructed by the New Relic support team.
# max_stored_metrics: 10000

# Minimum amount of time to wait between reports. Cannot be lowered than the default, 200ms.
# Changing this value is not recommended unless instructed by the New Relic support team.
# min_emitter_harvest_period: 200ms

# targets:
#   - description: Secure etcd example
#     urls: ["https://192.168.3.1:2379", "https://192.168.3.2:2379", "https://192.168.3.3:2379"]
#     tls_config:
#       ca_file_path: "/etc/etcd/etcd-client-ca.crt"
#       cert_file_path: "/etc/etcd/etcd-client.crt"
#       key_file_path: "/etc/etcd/etcd-client.key"

# Proxy to be used by the emitters when submitting metrics. It should be
# in the format [scheme]://[domain]:[port].
# The emitter is the component in charge of sending the scraped metrics.
# This proxy won't be used when scraping metrics from the targets.
# By default it's empty, meaning that no proxy will be used.
# emitter_proxy: "http://localhost:8888"

# Certificate to add to the root CA that the emitter will use when
# verifying server certificates.
# If left empty, TLS uses the host's root CA set.
# emitter_ca_file: "/path/to/cert/server.pem"

# Set to true in order to stop autodiscovery in the k8s cluster. It can be useful when running the Pod with a service account
# having limited privileges. Defaults to false.
# disable_autodiscovery: false

# Whether the emitter should skip TLS verification when submitting data.
# Defaults to false.
# emitter_insecure_skip_verify: false

# Histogram support is based on New Relic's guidelines for higher
# level metrics abstractions https://github.com/newrelic/newrelic-exporter-specs/blob/master/Guidelines.md.
# To better support visualization of this data, percentiles are calculated
# based on the histogram metrics and sent to New Relic.
# By default, the following percentiles are calculated: 50, 95 and 99.
#
# percentiles:
#   - 50
#   - 95
#   - 99

# transformations:
#   - description: "General processing rules"
#     rename_attributes:
#       - metric_prefix: ""
#         attributes:
#           container_name: "containerName"
#           pod_name: "podName"
#           namespace: "namespaceName"
#           node: "nodeName"
#           container: "containerName"
#           pod: "podName"
#           deployment: "deploymentName"
#     ignore_metrics:
#       # Ignore all the metrics except the ones listed below.
#       # This is a list that complements the data retrieved by the New
#       # Relic Kubernetes Integration, that's why Pods and containers are
#       # not included, because they are already collected by the
#       # Kubernetes Integration.
#       - except:
#         - kube_hpa_
#         - kube_daemonset_
#         - kube_statefulset_
#         - kube_endpoint_
#         - kube_service_
#         - kube_limitrange
#         - kube_node_
#         - kube_poddisruptionbudget_
#         - kube_resourcequota
#         - nr_stats
#     copy_attributes:
#       # Copy all the labels from the time series with metric name
#       # `kube_hpa_labels` into every time series with a metric name that
#       # starts with `kube_hpa_` only if they share the same `namespace`
#       # and `hpa` labels.
#       - from_metric: "kube_hpa_labels"
#         to_metrics: "kube_hpa_"
#         match_by:
#           - namespace
#           - hpa
#       - from_metric: "kube_daemonset_labels"
#         to_metrics: "kube_daemonset_"
#         match_by:
#           - namespace
#           - daemonset
#       - from_metric: "kube_statefulset_labels"
#         to_metrics: "kube_statefulset_"
#         match_by:
#           - namespace
#           - statefulset
#       - from_metric: "kube_endpoint_labels"
#         to_metrics: "kube_endpoint_"
#         match_by:
#           - namespace
#           - endpoint
#       - from_metric: "kube_service_labels"
#         to_metrics: "kube_service_"
#         match_by:
#           - namespace
#           - service
#       - from_metric: "kube_node_labels"
#         to_metrics: "kube_node_"
#         match_by:
#           - namespace
#           - node
# integration definition files required to map metrics to entities
# definition_files_path: /etc/newrelic-infra/definition-files

Voici quelques noms et définitions clés pour votre fichier de configuration Prometheus OpenMetrics.

Nom de la clé	Description
`cluster_name` Required.	Le nom du cluster. Cette valeur sera incluse comme attribut `clusterName` pour toutes les métriques.
`verbose`	Booléen stringifié. `true` (par défaut) : enregistrer les informations de débogage. `false`: Enregistrer uniquement les messages d'erreur.
`targets`	configuration du point de terminaison statique à gratter par l'intégration. Il contient une liste d'objets. Pour plus d'informations sur cette structure, consultez la documentation sur la configuration cible.
`scrape_enabled_label` Kubernetes	Chaîne. L'intégration vérifiera si le pod et le service Kubernetes sont annotés ou ont une étiquette avec cette valeur pour décider s'ils doivent être récupérés. Cela est particulièrement utile lorsque vous souhaitez limiter la quantité de données en ignorant les métriques ou en incluant des métriques spécifiques envoyées à New Relic. Étant donné que par défaut nous utilisons la même étiquette que Prometheus utilise pour découvrir les cibles qui peuvent être récupérées, la plupart des exportateurs que vous installez définissent automatiquement cette étiquette. Pour garder un contrôle précis sur la cible que vous souhaitez que l'intégration récupère, vous pouvez définir cette option sur une autre valeur (telle que `newrelic/scrape`), puis ajouter l'annotation ou l'étiquette `newrelic/scrape: "true"` à vos objets Kubernetes . Si les deux sont définis, les annotations ont la priorité sur les étiquettes. Défaut: `"prometheus.io/scrape"`
`scrape_duration`	À quelle fréquence le grattoir doit-il fonctionner ? Pour réduire l'utilisation de la mémoire, augmentez cette valeur. Pour augmenter l'utilisation de la mémoire, diminuez cette valeur. L'impact sur l'utilisation de la mémoire est dû à la répartition de la récupération de la cible sur l'intervalle de récupération pour éviter d'interroger (et de mettre en mémoire tampon) toutes les données à la fois. La valeur par défaut est `30s`. Les valeurs valides incluent `1s`, `15s`, `30s`, `1m`, `5m`, etc.
`scrape_timeout`	Le délai d'expiration du client HTTP lors de la récupération des données à partir du point de terminaison. Par défaut : `5s`. Les valeurs valides incluent `1s`, `15s`, `30s`, `1m`, `5m`, etc.
`worker_threads`	Nombre de threads de travail utilisés pour le scraping de la cible. Peut être augmenté dans les environnements avec un nombre élevé de cibles ou des cibles avec une latence élevée, mais peut augmenter la consommation de mémoire. Par défaut : `4`. Il n'est pas recommandé d'en utiliser plus de 10.
`require_scrape_enabled_label_for_nodes` Kubernetes	Si les nœuds Kubernetes ont besoin ou non d'étiquettes à récupérer. Par défaut : `true`.
`percentiles`	La prise en charge de l'histogramme est basée sur les directives de New Relic pour les abstractions de métriques de niveau supérieur. Pour mieux prendre en charge la visualisation de ces données, les centiles sont calculés sur la base des métriques de l'histogramme et envoyés à New Relic. Les valeurs valides incluent `50`, `95` et `99`.
`emitter_proxy`	Proxy utilisé par l'intégration lors de la soumission des métriques : `[scheme]://[domain]:[port]` Ce proxy ne sera pas utilisé lors de la récupération des métriques de la cible. Par défaut, ce champ est vide et aucun proxy ne sera utilisé.
`emitter_ca_file`	Certificat à ajouter à l'autorité de certification racine que l'émetteur utilisera lors de la vérification des certificats du serveur. Si ce champ est laissé vide, TLS utilise l'ensemble d'autorités de certification racine de l'hôte.
`emitter_insecure_skip_verify`	Si l'émetteur doit ignorer la vérification TLS lors de la soumission des données. Par défaut : `false`.
`disable_autodiscovery`	Définissez sur vrai afin de désactiver la découverte automatique dans le cluster k8s. Cela peut être utile lors de l’exécution du pod avec un compte de service disposant de privilèges limités. Par défaut : `false`.

Configurer les objets dans la clé cible

Si vous souhaitez que la clé cible dans le fichier de configuration contienne un ou plusieurs objets, utilisez la structure suivante dans la liste YAML :

Nom de la clé	Description
`description`	Une description des URL dans cette cible.
`urls`	Une liste de chaînes contenant les URL à extraire.
`tls_config`	configuration d'authentification utilisée pour envoyer requests. Il prend en charge TLS et Mutual TLS. Pour plus d'informations, consultez la documentation sur l'authentification TLS mutuelle.

L'intégration Prometheus OpenMetrics de New Relic découvre automatiquement quelle cible gratter. Pour spécifier le port et le chemin du point de terminaison à utiliser lors de la construction de la cible, vous pouvez utiliser les annotations ou l'étiquette prometheus.io/port et prometheus.io/path dans votre pod et vos services Kubernetes . Les annotations ont priorité sur les étiquettes.

Si prometheus.io/port n'est pas présent, l'intégration tentera de récupérer chaque port ou ContainerPort défini pour le service.
Si prometheus.io/path n'est pas présent, l'intégration sera par défaut /metrics.
Si un service ne s'exécute pas sur le chemin par défaut /my-metrics-path , ajoutez une étiquette au pod prometheus.io/path=my-metrics-path. Si le chemin d’accès au point de terminaison des métriques est plus complexe et ne peut pas être une valeur d’étiquette valide (par exemple, foo/bar), utilisez plutôt des annotations.

Dans cet exemple, vous avez un déploiement dans votre cluster, et le pod expose les métriques Prometheus sur le port 8080 et dans le chemin my-metrics.

Dans les métadonnées PodSpec du manifeste de déploiement, définissez les étiquettes prometheus.io/port: "8080" et prometheus.io/path: "my-metrics". Lorsque l'intégration tente de récupérer les métriques de votre pod, elle enverra une requête à http://<pod-ip>:8080/my-metrics.

apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-deployment
spec:
  replicas: 2
  selector:
    matchLabels:
      app: my-app
  template:
    metadata:
      labels:
        app: my-app
        prometheus.io/scrape: "true"
        prometheus.io/port: "8080"
        prometheus.io/path: "my-metrics"

Comportement de grattage des services et des points de terminaison

Par défaut, les services sont récupérés directement au lieu du point de terminaison sous-jacent puisque scrape_services est défini sur true et scrape_endpoints sur false.

Afin de modifier ce comportement, définissez scrape_endpoints sur true en configurant Prometheus OpenMetrics integrations pour récupérer le point de terminaison sous-jacent, comme le fait nativement le serveur Prometheus , au lieu de récupérer directement les services.

Veuillez noter qu'en fonction du nombre de points de terminaison derrière les services du cluster , la charge et les données ingérées peuvent augmenter considérablement, monitorer et, si nécessaire, augmenter les besoins en ressources.

De plus, même s'il est possible de définir à la fois scrape_services et scrape_endpoints sur vrai pour assurer la rétrocompatibilité, cela conduirait à des données en double.

Recharger la configuration

L'intégration Prometheus OpenMetrics does not recharge automatiquement la configuration lorsque vous apportez des modifications au fichier de configuration.

Docker

Pour recharger la configuration, redémarrez le conteneur exécutant l'intégration :

docker restart nri-prometheus

Kubernetes

Pour recharger la configuration, redémarrez l'intégration. Recommandation : réduisez le déploiement à zéro réplique, puis réduisez-le à une seule réplique :

kubectl scale deployment nri-prometheus --replicas=0
kubectl scale deployment nri-prometheus --replicas=1

Docker : exécuter le fichier de configuration précédent

Docker: Pour exécuter l’intégration avec le fichier de configuration précédent :

Copiez le contenu et enregistrez-le dans un fichier config.yaml .

Depuis le même répertoire, exécutez la commande :

docker run -d --restart unless-stopped \
    --name nri-prometheus \
    -e CLUSTER_NAME="YOUR_CLUSTER_NAME" \
    -e LICENSE_KEY="YOUR_LICENSE_KEY" \
    -v "$(pwd)/config.yaml:/config.yaml" \
    newrelic/nri-prometheus:latest --configfile=/config.yaml

Cette traduction automatique est fournie pour votre commodité.

Configurer l'intégration de Prometheus OpenMetrics

Configurer nri-prometheus-latest.yaml

Exemple de fichier de configuration

Noms clés et définitions

Configurer les objets dans la clé cible

Comportement de grattage des services et des points de terminaison

Recharger la configuration

Docker : exécuter le fichier de configuration précédent

Cette traduction automatique est fournie pour votre commodité.

Configurer l'intégration de Prometheus OpenMetrics

Configurer nri-prometheus-latest.yaml .css-21sua1{background:none;border:none;width:0;padding:0;}

Noms clés et définitions

Configurer les objets dans la clé cible

Comportement de grattage des services et des points de terminaison

Recharger la configuration

Docker : exécuter le fichier de configuration précédent

Configurer nri-prometheus-latest.yaml