Configuration de Grafana open source ou Grafana Enterprise pour une utilisation avec Amazon Managed Service for Prometheus

Amazon Managed Service for Prometheus prend en charge l’utilisation de Grafana version 7.3.5 et versions ultérieures pour l’interrogation des métriques dans un espace de travail. Les versions 7.3.5 et ultérieures incluent la prise en charge de l' AWS authentification Signature Version 4 (SigV4).

Pour obtenir des instructions sur la configuration de Grafana en mode autonome à l’aide du fichier tar.gz ou du fichier zip, voir la section Install Grafana dans la documentation de Grafana. Si vous installez une nouvelle instance de Grafana autonome, vous serez invité à saisir votre nom d’utilisateur et votre mot de passe. L’argument par défaut est admin/admin. Vous serez invité à modifier le mot de passe après votre première connexion. Pour plus d’informations, consultez la section Getting started with Grafana dans la documentation Grafana.

Pour savoir quelle est votre version de Grafana, entrez la commande suivante.

grafana_install_directory/bin/grafana-server -v

Pour configurer Grafana afin qu'il fonctionne avec Amazon Managed Service for Prometheus, vous devez être connecté à un compte disposant de la AmazonPrometheusQueryAccesspolitique ou des autorisations,, et. aps:QueryMetrics aps:GetMetricMetadata aps:GetSeries aps:GetLabels Pour plus d’informations, consultez Autorisations et politiques IAM.

Configuration d’ AWS SigV4

Amazon Managed Service for Prometheus fonctionne AWS Identity and Access Management avec (IAM) pour sécuriser tous les appels aux API Prometheus avec des informations d'identification IAM. Par défaut, la source de données Prometheus dans Grafana suppose que Prometheus ne nécessite aucune authentification. Pour permettre à Grafana de tirer parti des fonctionnalités d’authentification et d’autorisation d’Amazon Managed Service for Prometheus, vous devez activer la prise en charge de l’authentification SigV4 dans la source de données Grafana. Suivez les étapes indiquées sur cette page lorsque vous utilisez un serveur open source Grafana autogéré ou un serveur d’entreprise Grafana. Si vous utilisez Amazon Managed Grafana, l’authentification SigV4 est entièrement automatisée. Pour plus d’informations sur Amazon Managed Grafana, consultez la section What is Amazon Managed Grafana?.

Pour activer SigV4 sur Grafana, démarrez Grafana avec les variables d’environnement AWS_SDK_LOAD_CONFIG et GF_AUTH_SIGV4_AUTH_ENABLED définies sur true. La variable d’environnement GF_AUTH_SIGV4_AUTH_ENABLED remplace la configuration par défaut de Grafana pour activer le support SigV4. Pour de plus amples informations, veuillez consulter Configuration dans la documentation Grafana.

Linux

Pour activer SigV4 sur un serveur Grafana autonome sous Linux, entrez les commandes suivantes.

export AWS_SDK_LOAD_CONFIG=true

export GF_AUTH_SIGV4_AUTH_ENABLED=true

cd grafana_install_directory

./bin/grafana-server

Windows

Pour activer SigV4 sur un serveur Grafana autonome sous Windows à l’aide de l’invite de commande Windows, entrez les commandes suivantes.

set AWS_SDK_LOAD_CONFIG=true

set GF_AUTH_SIGV4_AUTH_ENABLED=true

cd grafana_install_directory

.\bin\grafana-server.exe

Ajout de la source de données Prometheus dans Grafana

Les étapes suivantes expliquent comment configurer la source de données Prometheus dans Grafana pour interroger vos métriques Amazon Managed Service for Prometheus.

Pour ajouter la source de données Prometheus dans votre serveur Grafana

1. Ouvrez la console Grafana.

2. Sous Configurations, sélectionnez Sources de données.

3. Choisissez Add data source.

4. Choisissez Prometheus.

5. Pour l’URL HTTP, spécifiez le point de terminaison - l’URL de requête affiché sur la page de détails de l’espace de travail de la console Amazon Managed Service for Prometheus.

6. Dans l’URL HTTP que vous venez de spécifier, supprimez la chaîne /api/v1/query ajoutée à l’URL, car la source de données Prometheus l’ajoutera automatiquement.

   L’URL correcte doit ressembler à https://aps-workspaces.us-west-2.amazonaws.com/workspaces/ws-1234a5b6-78cd-901e-2fgh-3i45j6k178l9.

7. Sous Auth, sélectionnez le bouton SigV4 Auth pour l’activer.

8. Vous pouvez configurer l’autorisation SigV4 en spécifiant vos informations d’identification à long terme directement dans Grafana ou en utilisant une chaîne de fournisseurs par défaut. La spécification de vos informations d’identification à long terme vous permet de démarrer plus rapidement, et les étapes suivantes fournissent ces instructions en premier. Une fois que vous serez familiarisé avec l’utilisation de Grafana avec Amazon Managed Service for Prometheus, nous vous recommandons d’utiliser une chaîne de fournisseurs par défaut, qui offre plus de flexibilité et de sécurité. Pour plus d’informations sur la configuration de votre chaîne de fournisseurs par défaut, consultez la section Spécification des informations d’identification.

   • Pour utiliser directement vos informations d’identification à long terme, procédez comme suit :

     1. Sous SigV4 Auth Details, choisissez Access & secret key pour le Fournisseur d’authentification.

     2. Pour Access Key ID, entrez votre ID de clé d’accès AWS .

     3. Pour Secret Access Key, entrez votre clé d’accès secrète AWS .

     4. Laissez les champs Assume Role ARN et External ID vides.

     5. Pour Default Region, choisissez la région de votre espace de travail Amazon Managed Service for Prometheus. Cette région doit correspondre à la région contenue dans l’URL répertoriée à l’étape 5.

     6. Choisissez Enregistrer et tester.

        Vous devez voir le message suivant : Data source is working.

        La capture d’écran suivante montre le paramètre détaillé d’authentification de la clé d’accès et de la clé secrète SigV4.

        

   • Pour utiliser une chaîne de fournisseurs par défaut à la place (recommandée pour un environnement de production), procédez comme suit :

     1. Sous SigV4 Auth Details, choisissez AWS SDK Default pour le Fournisseur d’authentification.

     2. Laissez les champs Assume Role ARN et External ID vides.

     3. Pour Default Region, choisissez la région de votre espace de travail Amazon Managed Service for Prometheus. Cette région doit correspondre à la région contenue dans l’URL répertoriée à l’étape 5.

     4. Choisissez Enregistrer et tester.

        Vous devez voir le message suivant : Data source is working.

        La capture d’écran suivante montre le paramètre détaillé d’authentification SigV4 par défaut du SDK.

        

9. Testez une requête ProMQL sur la nouvelle source de données :

   1. Choisissez Explore.

   2. Exécutez un exemple de requête ProMQL tel que :

      prometheus_tsdb_head_series

Dépannage si Enregistrer et tester ne fonctionne pas

Dans la procédure précédente, si un message d’erreur s’affiche lorsque vous sélectionnez Enregistrer et tester, vérifiez les points suivants.

HTTP Error Not Found

Assurez-vous que l’ID de l’espace de travail indiqué dans l’URL est correct.

HTTP Error Forbidden

Cette erreur signifie que les informations d’identification ne sont pas valides. Vérifiez les éléments suivants :

• Vérifiez que la région spécifiée dans Default Region est correcte.

• Vérifiez que vos informations d’identification ne contiennent pas de fautes de frappe.

• Assurez-vous que les informations d'identification que vous utilisez sont conformes à la AmazonPrometheusQueryAccesspolitique. Pour plus d’informations, consultez Autorisations et politiques IAM.

• Assurez-vous que les informations d’identification que vous utilisez ont accès à cet espace de travail Amazon Managed Service for Prometheus.

HTTP Error Bad Gateway

Consultez le journal du serveur Grafana pour résoudre cette erreur. Pour plus d’informations, consultez la section Dépannage dans la documentation Grafana.

Si vous le voyezError http: proxy error: NoCredentialProviders: no valid providers in chain, la chaîne de fournisseurs d'informations d'identification par défaut n'a pas pu trouver d'informations d' AWS identification valide à utiliser. Assurez-vous d’avoir configuré vos informations d’identification conformément aux instructions de la section Spécification des informations d’identification. Si vous souhaitez utiliser une configuration partagée, assurez-vous que l’environnement AWS_SDK_LOAD_CONFIG est défini sur true.